Skip to content
Pagos Instantáneos
/
API descriptor

API de Generación de Descriptores de Operaciones (v1.0)

La API Generadora de Descriptores de Operación (versión 1.0) de Khipu permite a los comercios crear un identificador único de operación junto con un descriptor cifrado para iniciar transferencias bancarias. A través de un único endpoint (POST /v1/descriptor/payment), se envía el ID del banco de origen y los detalles de la transacción, como monto, moneda, datos del pagador y cuenta de destino. Si la solicitud es exitosa, la API devuelve un objeto JSON con un operation.id (UUID) y un operation.description, que es un descriptor cifrado en Base64, diseñado para ser utilizado en flujos seguros de transferencia bancaria. La autenticación se realiza mediante la cabecera x-api-key.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License

API de Descriptor de operaciones de Khipu

Languages
Servers
Production

https://api.khipu.com/

Crea un descriptor de operación para una nueva transferencia

Request

Éste método crea un nuevo identificador de operación y un descriptor de operación para una nueva transferencia.

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

El ID del banco origen para esta operación.

Example: "dSXgfesd"
paramsobjectrequired

Parametros necesarios para crear un nuevo descriptor de operación.

subjectstring

Una descripción de la operación de transferencia.

Example: "Ejemplo de transferencia"
amountnumber

Monto de la transferencia.

Example: 1000
currency_codestring

El código de moneda en el formato ISO 4217.

Example: "CLP"
payer_emailstring

El correo electrónico del pagador.

Example: "someone@example.com"
payer_namestring

El nombre del pagador.

Example: "Jane Doe"
target_account_bankstring

El nombre del banco del destinatario de la transferencia.

Example: "Awesome Bank"
target_account_aliasstring

Un alias para la nueva cuenta en caso de que sea la primera transferencia.

Example: "My friend"
target_account_namestring

El nombre del titular de la cuenta del destinatario.

Example: "John Doe"
target_account_numberstring

En número de cuenta del destinatario.

Example: 123459876
target_account_personal_identifierstring

El identificador personal del destinatario, como un RUT o DNI.

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

Operación exitosa. Retorna un objeto JSON con un nuevo identificador de operación y el descriptor encriptado.

Bodyapplication/json
operationobjectrequired
idstring

Identificador único de la operación.

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

El descriptor cifrado a enviar codificado en 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=="
  }
}