post https://payment-backend-sandbox.milio.com.co/external-payment/register-monthly-payment
El endpoint /external-payment/register-monthly-payment se utiliza para registrar un pago mensual asociado a un acuerdo existente. Este proceso es crucial para manejar pagos recurrentes y variables, donde cada pago está vinculado a un acuerdo predefinido.
Objeto Json
{
"agreementId": "91727595-0ea7-4ada-8bcf-69259da74042",
"billingDate": "2024-07-31T00:00:00.000Z",
"cutoffDate": "2024-07-31T00:00:00.000Z",
"invoiceNumber": "0000001",
"amount": 300000,
"billingItems": [
"Concepto 1",
"Concepto 2",
"Concepto 3",
"Concepto 4",
"Concepto 5"
]
}
Explicación
agreementId:
-
- Descripción: Identificador único del acuerdo de pago al que este pago mensual está asociado.
- Tipo:
string - Ejemplo:
"91727595-0ea7-4ada-8bcf-69259da74042"
-
billingDate:
- Descripción: Fecha de facturación del pago mensual.
- Tipo:
string(formato ISO 8601) - Ejemplo:
"2024-07-31T00:00:00.000Z" - Uso: Esta fecha indica cuándo se emite la factura para el pago mensual.
-
cutoffDate:
- Descripción: Fecha de corte del pago mensual.
- Tipo:
string(formato ISO 8601) - Ejemplo:
"2024-07-31T00:00:00.000Z" - Uso: La fecha de corte se utiliza para definir el final del período de facturación del pago.
-
invoiceNumber:
- Descripción: Número de la factura asociada al pago mensual.
- Tipo:
string - Ejemplo:
"123" - Uso: Un identificador único para la factura correspondiente al pago mensual, utilizado para rastrear y referenciar el pago.
-
amount:
- Descripción: Monto del pago mensual.
- Tipo:
number - Ejemplo:
300000 - Uso: Este campo representa la cantidad total que se debe pagar en el ciclo de facturación mensual.
-
-
billingItems:
- Descripción: Acuerdos de cobro o pago
- *Tipo:**
array string - Ejemplo:
["...", "..."] - Uso: En este campo van los conceptos de pago acordados en el registro del contrato, si estos cambian se requiere validación del tercero.
Respuesta Esperada
La respuesta del endpoint generalmente confirmará que el pago mensual ha sido registrado correctamente.
Pago recurrente
{
"message": "Solicitud de cobro creada exitosamente"
}
Pago recurrente variable
{
"message": "Solicitud de cobro creada exitosamente, pendiente por confirmar por parte del tercero"
}