API Reference

Debito recurrente variable

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

Pago recurrente variable es un método de transacción donde una empresa (PYME) inicia la extracción de fondos desde la cuenta de un cliente (persona natural).

Un pago recurrente variable es una transacción automática que también se realiza en intervalos regulares, pero el monto del pago puede variar en cada periodo. Este tipo de pago es común en servicios cuyo costo depende del uso o consumo, como las facturas de servicios públicos o planes de telefonía móvil con tarifas basadas en el uso.

Objeto Json

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

Detalles claves

  • Cuenta de origen: Tarjeta de débito de una persona natural de cualquier banco.
  • Cuenta destino: Cuenta centralizada en Coopcentral (PYME).

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 en Coopcentral (PYME), que es el destino de los fondos en el método C2B (P2M) - Pull.
  • 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 está realizando el pago desde su tarjeta de débito, la cual se relaciona con la “Cuenta de origen” en ambos métodos de colección.
  • 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 PYME.
  • expirationDate:

    • Descripción:Fecha de expiración del pago.
    • Ejemplo: 2024-08-31
    • Relación con el Método de Colección: No se especifica una fecha de expiración, lo que significa que el pago puede procesarse en cualquier momento antes de que se configure una fecha de expiración específica.
  • 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:

{
    "error": 0,
    "message": "Registro guardado con éxito.",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.bnNhY3Rpb25JRHMiOlsiNTciXSwiZmxvdyI6IkRVIiwicGF5bWVu...."
}


Generación del acuerdo

El token recibido en la respuesta se utiliza para generar el acuerdo. Aquí tienes el proceso paso a paso.

Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!