Operation Descriptor Generator API (v1.0)

Download OpenAPI specification:Download

License: Khipu Operation Descriptor API

Create payment operation descriptor

This method creates a new operation Id and a operation descriptor for a new transfer

SecurityApi-Key
Request
Request Body schema: application/json
required
bank
required
string <= 255 characters

The id of the origin bank for this operation.

Example: "dSXgfesd"
required
object

required parameters for this operation

subject
string

A description of the transfer operation

Example: "Some transfer example"
amount
number

The amount of the transfer

Example: 1000
currency_code
string

The currency code in the ISO 4217.

Example: "CLP"
payer_email
string

E-mail address of the person doing the transfer

Example: "someone@example.com"
payer_name
string

The name of the person doing the transfer

Example: "Jane Doe"
target_account_bank
string

The name of the target bank as seen in the origin bank

Example: "Awesome Bank"
target_account_alias
string

An alias to use for the new account in case it is the first transfer

Example: "My friend"
target_account_name
string

The real name of the destinatary

Example: "John Doe"
target_account_number
string

The target bank account indentifier

Example: 123459876
target_account_personal_identifier
string

The identifier of the target account

Example: "12.345.678-9"
Responses
200

Successful operation. Returns a JSON object with a new operation id and the encrypted descriptor.

Response Schema: application/json
required
object
id
string

Unique subscription identifier.

Example: "13a0f1aa-5e47-4894-aa8b-282dd19593ec"
description
string

The encrypted descriptor to send encoded in Base64

Example: "eyJtIjoicVlvQU92VllMWm5NVDg2UEovNjNJcGFtRnFQUUNDY lNDcHZBZ283OFNlM01VWVBJZU1sZk05a0NzSWVwRkJPcnZlbG FwSCtaS3pCRmd3YTBybkVKamtaV3gxYm1iTjd2ZzhhNGtuV1N FV3BwclhtVHBkcXRQRXlsVHlhSGtsdTdYTkRtVHZadzlGZlox NFgvRDI3dDFvVkFaVWdKN2JqcXdOQXdsYUM0ZmZSL2xmQzJiR C9kVElJcGtJc0NTVGxDS1YyTThsbDNYV1dUZFFwdXlzN0xiNU FvNVRvVW54NlB0V0Zzd2hxQkVEVmdUWXRhclFqdFBNbUFvRzQ 1akdKdUk2cmhDU25taG9weEVFM0YwOVgzY0hHSDZzSzVsMl=="
400

Bad Request

401

Unauthorized - Invalid or missing credentials

404

Not found - Resource not available

500

Remote service error :(

post/v1/descriptor/payment
Request samples
application/json
{
  • "bank": "dSXgfesd",
  • "params": { }
}
Response samples
application/json
{
  • "operation": {
    • "id": "13a0f1aa-5e47-4894-aa8b-282dd19593ec",
    • "description": "eyJtIjoicVlvQU92VllMWm5NVDg2UEovNjNJcGFtRnFQUUNDY lNDcHZBZ283OFNlM01VWVBJZU1sZk05a0NzSWVwRkJPcnZlbG FwSCtaS3pCRmd3YTBybkVKamtaV3gxYm1iTjd2ZzhhNGtuV1N FV3BwclhtVHBkcXRQRXlsVHlhSGtsdTdYTkRtVHZadzlGZlox NFgvRDI3dDFvVkFaVWdKN2JqcXdOQXdsYUM0ZmZSL2xmQzJiR C9kVElJcGtJc0NTVGxDS1YyTThsbDNYV1dUZFFwdXlzN0xiNU FvNVRvVW54NlB0V0Zzd2hxQkVEVmdUWXRhclFqdFBNbUFvRzQ 1akdKdUk2cmhDU25taG9weEVFM0YwOVgzY0hHSDZzSzVsMl=="
    }
}