API Reference

Generar key token

Este endpoint permite generar un token de acceso para activar y ejecutar el SDK web de Milio. El SDK web debe ser inyectado previamente en el cliente. Dependiendo de la configuración, el token generado puede ser utilizado para múltiples propósitos.

La clave generada proporciona acceso al SDK web para realizar diversas operaciones de pago o interactuar con los servicios de Milio según la configuración establecida.

Casos

1. Registrar tarjeta a tercero

{
    "type": "CARD_REGISTRATION",
    "webhook": "https://webhook-test.com/2c06f6088efb0aa72ef3ac72a174507a",
    "thirdUUID": "cd7.."
}
PARÁMETRODESCRIPCIÓN
typeTipo de operación
webhookURL de confirmación de enrolamiento de tarjeta
thirdUUIDId del tercero

2. One-time disbursement - Pagos Directos Locales y Cross-Border

  1. Casos de uso SDK OTD .
  2. Guía de integración.
{
    "type": "ENROLLMENT_PAYOUT_DIRECT",
    "reference": "{{$guid}}", // Your id or identification for transaction
    "senderUUID": "{{third-xborder}}",
    "senderCardUUID": "{{thirdBankUUID}}",
    "recipient": {
        "name": "Andres",
        "lastName": "Navarro",
        "document": "10...",
        "email": "[email protected]",
        "dateOfBirth":"1995-12-10",
        "indicativeContact": "+57",
        "phoneContact": "...",        
        "addressData":{
            "street":"calle 35 cr3aw #34-64",
            "city":"Pasto",
            "region":"CO-NAR",
            "postal_code":"520002",
            "country":"CO"
        }        
    },
    "fullData": false,
    "webhook": "https://webhook-test.com/5f1a3ef2b2090773083e90128919cd6a"
}

CampoDescripción
typeTipo de operación.
referenceIdentificador único de la transacción.
senderUUIDUUID del remitente (identificador único).
senderCardUUIDUUID de la tarjeta del sender.
recipient.nameNombre del destinatario del pago.
recipient.lastNameApellido del destinatario.
recipient.documentNúmero de documento de identificación del destinatario.
recipient.emailCorreo electrónico del destinatario.
recipient.dateOfBirthFecha de nacimiento del destinatario (formato YYYY-MM-DD).
recipient.indicativeContactIndicativo telefónico del destinatario.
recipient.phoneContactNúmero de teléfono del destinatario.
recipient.addressData.streetCalle del destinatario.
recipient.addressData.cityCiudad del destinatario.
recipient.addressData.regionRegión o estado del destinatario.
recipient.addressData.postal_codeCódigo postal del destinatario.
recipient.addressData.countryPaís del destinatario.
fullDataIndica si se deben proporcionar todos los datos de la tarjeta del destinatario (true/false).
saveIndica si se desea guardar el beneficiario (recipient).
webhookURL del webhook donde se recibirán notificaciones de la transacción.

3. One-time disbursement - Pagos Directos Locales y Cross-Border (Flipped)

  1. Casos de uso SDK OTD .
  2. Guía de integración.

Beneficiario no registrado

{
   "type":"ENROLLMENT_PAYOUT_DIRECT_FLIPPED",
   "reference":"...",
   "webhook":"https://...",
   "fullData":false,
   "save":true,
   "externalId":"..",
   "recipient":{
      "name":"Andres",
      "lastName":"navarro",
      "document":"...",
      "email":"...",
      "dateOfBirth":"1995-12-10",
      "indicativeContact":"+57",
      "phoneContact":"..",
      "addressData":{
         "street":"calle 35 cr3aw #34-64",
         "city":"Monteria",
         "region":"CO-COR",
         "postal_code":"23001",
         "country":"CO"
      }
   }
}

Beneficiario registrado con nueva tarjeta

{
   "type":"ENROLLMENT_PAYOUT_DIRECT_FLIPPED",
   "reference":"...",
   "webhook":"https://...",
   "fullData":false,
   "recipientUUID":"..."
}

Beneficiario registrado con tarjeta tokenizada

{
   "type":"ENROLLMENT_PAYOUT_DIRECT_FLIPPED",
   "reference":"...",
   "webhook":"https://...",
   "fullData":false,
   "recipientUUID":"...",
   "recipientCardUUID":"..."
}
CampoDescripción
typeTipo de operación.
referenceIdentificador único de la transacción.
recipientUUIDUUID del beneficiario (identificador único).
recipientCardUUIDUUID de la tarjeta del beneficiario.
externalIdIdentificador único de la compañía para relacionarlo con el remitente
recipient.nameNombre del destinatario del pago.
recipient.lastNameApellido del destinatario.
recipient.documentNúmero de documento de identificación del destinatario.
recipient.emailCorreo electrónico del destinatario.
recipient.dateOfBirthFecha de nacimiento del destinatario (formato YYYY-MM-DD).
recipient.indicativeContactIndicativo telefónico del destinatario.
recipient.phoneContactNúmero de teléfono del destinatario.
recipient.addressData.streetCalle del destinatario.
recipient.addressData.cityCiudad del destinatario.
recipient.addressData.regionRegión o estado del destinatario.
recipient.addressData.postal_codeCódigo postal del destinatario.
recipient.addressData.countryPaís del destinatario.
fullDataIndica si se deben proporcionar todos los datos de la tarjeta del destinatario (true/false).
webhookURL del webhook donde se recibirán notificaciones de la transacción.

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
thirdUUIDCuando se save = true se entrega el uuid del beneficiario. (Opcional)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!