API Reference

Generar key token

Este endpoint se utiliza para generar token temporal para enviar una nueva transacción y procesarla mediante el SDK

Ejemplo para enrolamiento de tarjeta

{
    "type": "ENROLLMENT_PAYOUT_DIRECT",
    "beneficiary": {
        "name": "Juan",
        "lastName": "Perez",
        "typeDocumentId": 1,
        "document": "1142000001",
        "email": "[email protected]"
    },
    "webhook": "https://webhook-url....",
    "reference": "abc123"
}
PARÁMETRODESCRIPCIÓN
typeTipo de operación
nameNombre del tercero.
lastNameApellido del tercero.
typeDocumentIdIdentificador del tipo de documento (por ejemplo, 1, 2).
documentNúmero del documento de identificación.
emailDirección de correo electrónico del tercero.
webhookURL de confirmación de enrolamiento de tarjeta
referenceIdentificador de transferencia por parte de la compañía, este campo es opcional

Ejemplo para pago directo

{
    "amount": 100,
    "type": "PAYOUT_DIRECT",
    "beneficiary": {
        "name": "Ernesto",
        "lastName": "Diaz",
        "typeDocumentId": 1,
        "document": "1082749257",
        "email": "[email protected]"
    },
  "reference" : "123abc"
}

Parámetros de la solicitud:

PARÁMETRODESCRIPCIÓN
amountValor de la transferencia, es obligatorio cuándo no requiere de facturas.
typeTipo de operación
nameNombre del tercero.
lastNameApellido del tercero.
typeDocumentIdIdentificador del tipo de documento (por ejemplo, 1, 2).
documentNúmero del documento de identificación.
emailDirección de correo electrónico del tercero.
referenceIdentificador de transferencia por parte de la compañía, este campo es opcional


Campos de respuesta

CampoDescripción
keyToken temporal, el cual se inserta en el SDK.
messageMensaje descriptivo del resultado de la operación.
referenceReferencia de la transacción
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!