API Reference

Recibir Dinero cash-out

El endpoint para realizar retiros (cash-out) permite a los clientes retirar fondos de sus cuentas. A continuación se presenta la estructura detallada del cuerpo de la solicitud (payload) y la explicación de cada parámetro.

Objeto json

{
    "payment": {
        "operation": "CASH_OUT", 
        "currency": "COP",
        "description": "paytop",
        "amount": 50000
    },
    "sender": {
        "fullName": "Juan Luis Perez",
        "typeDocument": "CC",
        "document": "4551512315",
        "credentials": {
            "cardName": "John Doe",
            "accountNumber": "1234567812345678",
            "expirationDate": "12/25",
            "cvv": "123",
            "address": "123 Main St, City, Country"
        }
    },
    "recipient": {
        "fullName": "Juan Luis Perez",
        "typeDocument": "CC",
        "document": "4551512315",
        "credentials": {
            "cardName": "Jane Smith",
            "accountNumber": "8765432187654321",
            "expirationDate": "11/26",
            "address": "456 Elm St, City, Country"
        }
    }
}

PARÁMETRODESCRIPCIÓN
payment.operationTipo de operación. Debe ser 'CASH_IN' o 'CASH_OUT'.
payment.currencyMoneda de la transacción. Puede ser 'USD' o 'COP'.
payment.descriptionDescripción de la transacción. En este ejemplo, es 'paytop'.
payment.amountMonto del retiro. En este ejemplo, es 50000.
sender.fullNameNombre completo del remitente. Ejemplo: 'Juan Luis Perez'.
sender.typeDocumentTipo de documento del remitente. Ejemplo: 'CC'.
sender.documentNúmero de documento del remitente. Ejemplo: '4551512315'.
sender.credentials.cardNameNombre del titular de la tarjeta de quien envía los fondos. Ejemplo: 'John Doe'.
sender.credentials.accountNumberNúmero de la tarjeta de quien envía los fondos. Ejemplo: '1234567812345678'.
sender.credentials.expirationDateFecha de expiración de la tarjeta en formato 'MM/YY'. Ejemplo: '12/25'.
sender.credentials.cvvCódigo de seguridad de la tarjeta. Ejemplo: '123'.
sender.credentials.addressDirección del titular de la tarjeta. Ejemplo: '123 Main St, City, Country'.
recipient.fullNameNombre completo del destinatario. Ejemplo: 'Juan Luis Perez'.
recipient.typeDocumentTipo de documento del destinatario. Ejemplo: 'CC'.
recipient.documentNúmero de documento del destinatario. Ejemplo: '4551512315'.
recipient.credentials.cardNameNombre del titular de la tarjeta de quien recibe los fondos. Ejemplo: 'Jane Smith'.
recipient.credentials.accountNumberNúmero de la tarjeta de quien recibe los fondos. Ejemplo: '8765432187654321'.
recipient.credentials.expirationDateFecha de expiración de la tarjeta en formato 'MM/YY'. Ejemplo: '11/26'.
recipient.credentials.addressDirección del titular de la tarjeta. Ejemplo: '456 Elm St, City, Country'.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!