API Reference

Debito recurrente

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

Un pago recurrente es una transacción automática que se realiza en intervalos regulares y por un monto fijo. Este tipo de pago es común en suscripciones y servicios donde el costo no cambia con el tiempo. Los pagos recurrentes son útiles para servicios que requieren una tarifa constante, como membresías de gimnasios, alquileres, o suscripciones a servicios digitales.

Objeto Json

{
    "companyBankUuid": "41b79450-f9f0-49cf-a082-7ee0ed23c0f5",
    "third": {       
        "uuid": "dd8d7102-88d1-464f-9f8c-a9d313603ff4"
    },
    "payment": {
        "value": 45000,
        "expirationDate": null,
        "paymentMethodId": 3
    }
}

Detalles Clave

  • 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.
  • third:

    • Descripción: Información sobre el cliente (tercero) involucrado en la transacción.
    • Campos:
      • uuid: 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.
  • payment:

    • Descripción: Información sobre el pago que se está registrando.
    • Campos:
      • 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.
      • paymentMethodId:
        • Descripción:Método de pago utilizado.
        • Ejemplo: 3
        • Relación con el Método de Colección: Este campo indica el método de pago utilizado. El valor 3 podría corresponder a un método específico.

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
Authorization
OAuth2
Click Try It! to start a request and see the response here!