API Reference

Crear un cobro a un tercero

Enviar dinero desde una Tarjeta de Débito a una Cuenta Centralizada.

Este proceso permite registrar un cobro en la plataforma para que un tercero realice un pago. Para ello, es necesario especificar la cuenta de la compañía donde se acreditarán los fondos, el tercero que realizará el pago, el monto y una referencia (opcional).

Objeto Json

{
    //"reference": "{{$randomBsBuzz}}", // Opcional
    "companyBankUUID": "ae4a42c4-b02f-4eb4-903b-d75de170ab4f",
    "thirdUUID": "6ac60aa6-d061-42d9-9f99-1f41c032cc5d",
    "value": 100
}

Detalles Clave

  • Cuenta destino: Cuenta centralizada (registrada previamente).

Este método es útil para empresas que necesitan recolectar pagos de sus clientes de manera eficiente y segura, permitiendo que la empresa controle el proceso de pago.

Detalles

  • companyBankUUID:

    • Descripción: Identificador único del banco de la empresa.
    • Ejemplo: "41b79450-f9f0-49cf-a082-7ee0ed23c0f5"
    • Relación con el Método de Colección: Este campo se utiliza para identificar la cuenta centralizada, que es el destino de los fondos en el método.
  • thirdUUID:

    • Descripción: Identificador único del cliente existente.
    • Ejemplo: "dd8d7102-88d1-464f-9f8c-a9d313603ff4"
    • Relación con el Método de Colección: Este campo identifica al cliente (persona natural) que estará realizando el pago desde su tarjeta de débito, la cual se relaciona con la “Cuenta de origen”.
  • value: Valor del pago.

    • Ejemplo: 45000
    • Relación con el Método de Colección: Este campo representa la cantidad de dinero que se va a transferir desde la cuenta del cliente a la cuenta de la empresa.
  • reference:

    • Descripción:Identificador de factura.
    • Ejemplo: 3Relación con el Método de Colección: Es opcional, asocia un cobro a una factura de la empresa, si no se envía se generará uno automáticamente.

Respuesta del Registro de Pago

La respuesta del endpoint /external-payment/register-payment es:

{
    "message": "Registro guardado con éxito.",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb21wYW55SWQiOiIxNSIsInRoaXJkSWQiOiI5OSIsImNvbXBhbnlCYW5rSWQiOiIzMSIsInJlZmVyZW5jZSI6IjU4NDc5MTYxMDUxMDQ0ODQiLCJ0b3RhbCI6NjAwMCwidHJhbnNhY3Rpb25VVUlEIjoiOTAwOTRkZjYtNTk0ZC00OGUwLTk4OTQtNjYwNDJkODJmYThmIiwidHJhbnNhY3Rpb25QYXltZW50VVVJRCI6IjkwMDk0ZGY2LTU5NGQtNDhlMC05ODk0LTY2MDQyZDgyZmE4ZiIsInRyYW5zYWN0aW9uVHlwZSI6IlJFQ1VSUklOR19QQVlNRU5UIiwiaWF0IjoxNzM5NDY2ODYzLCJleHAiOjE3Mzk3MjYwNjN9.1g7OBNHRjSpb8BhC5D5dKZx22NiWdkuU2h5--4Sq0nU",
    "reference": "5847916105104484",
    "id": "90094df6-594d-48e0-9894-66042d82fa8f"
}
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!