Pagos Instantáneos
/
API descriptor
/
Create payment operation descriptor

Operation Descriptor Generator API (v1.0)

The Operation Descriptor Generator API (v1.0) from Khipu allows merchants to create a unique operation identifier along with an encrypted descriptor for initiating new bank transfer operations. Using a single endpoint (POST /v1/descriptor/payment), you submit the origin bank ID and detailed transaction parameters—like transfer amount, currency, payer information, and recipient account details. On a successful call, the API returns a JSON object containing an operation.id (a UUID) and an operation.description field: a Base64‑encoded encrypted descriptor designed for use in secure bank transfer flows. Authentication is handled via the x-api-key header.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

Khipu Operation Descriptor API

Languages
Servers
Production

https://api.khipu.com/

Create payment operation descriptor

Request

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

Security
Api-Key
Bodyapplication/jsonrequired
bankstring<= 255 charactersrequired

The id of the origin bank for this operation.

Example: "dSXgfesd"
paramsobjectrequired

required parameters for this operation

subjectstring

A description of the transfer operation

Example: "Some transfer example"
amountnumber

The amount of the transfer

Example: 1000
currency_codestring

The currency code in the ISO 4217.

Example: "CLP"
payer_emailstring

E-mail address of the person doing the transfer

Example: "someone@example.com"
payer_namestring

The name of the person doing the transfer

Example: "Jane Doe"
target_account_bankstring

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

Example: "Awesome Bank"
target_account_aliasstring

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

Example: "My friend"
target_account_namestring

The real name of the destinatary

Example: "John Doe"
target_account_numberstring

The target bank account identifier

Example: 123459876
target_account_personal_identifierstring

The identifier of the target account

Example: "12.345.678-9"
curl -i -X POST \
  https://api.khipu.com/v1/descriptor/payment \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "bank": "dSXgfesd",
    "params": {}
  }'

Responses

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

Bodyapplication/json
operationobjectrequired
idstring

Unique subscription identifier.

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

The encrypted descriptor to send encoded in Base64

Example: "eyJtIjoicVlvQU92VllMWm5NVDg2UEovNjNJcGFtRnFQUUNDY lNDcHZBZ283OFNlM01VWVBJZU1sZk05a0NzSWVwRkJPcnZlbG FwSCtaS3pCRmd3YTBybkVKamtaV3gxYm1iTjd2ZzhhNGtuV1N FV3BwclhtVHBkcXRQRXlsVHlhSGtsdTdYTkRtVHZadzlGZlox NFgvRDI3dDFvVkFaVWdKN2JqcXdOQXdsYUM0ZmZSL2xmQzJiR C9kVElJcGtJc0NTVGxDS1YyTThsbDNYV1dUZFFwdXlzN0xiNU FvNVRvVW54NlB0V0Zzd2hxQkVEVmdUWXRhclFqdFBNbUFvRzQ 1akdKdUk2cmhDU25taG9weEVFM0YwOVgzY0hHSDZzSzVsMl=="
Response
application/json
{
  "operation": {
    "id": "13a0f1aa-5e47-4894-aa8b-282dd19593ec",
    "description": "eyJtIjoicVlvQU92VllMWm5NVDg2UEovNjNJcGFtRnFQUUNDY lNDcHZBZ283OFNlM01VWVBJZU1sZk05a0NzSWVwRkJPcnZlbG FwSCtaS3pCRmd3YTBybkVKamtaV3gxYm1iTjd2ZzhhNGtuV1N FV3BwclhtVHBkcXRQRXlsVHlhSGtsdTdYTkRtVHZadzlGZlox NFgvRDI3dDFvVkFaVWdKN2JqcXdOQXdsYUM0ZmZSL2xmQzJiR C9kVElJcGtJc0NTVGxDS1YyTThsbDNYV1dUZFFwdXlzN0xiNU FvNVRvVW54NlB0V0Zzd2hxQkVEVmdUWXRhclFqdFBNbUFvRzQ 1akdKdUk2cmhDU25taG9weEVFM0YwOVgzY0hHSDZzSzVsMl=="
  }
}