En esta sección brinda las herramientas esenciales para que los merchant realicen solicitudes de cobro vía API y administren los cargos programados de sus suscripciones. Al interactuar con esta interfaz, podrás personalizar la fecha de procesamiento y especificar los detalles de los cargos a ejecutar.

<aside> ⚠️ Advertencia Importante:

Ten en cuenta que la fecha de ingreso de los datos para el cargo debe ser programada con al menos un 1 y 7 días naturales de anticipación respecto a la fecha de ejecución del cargo, dónde la fecha programada deberá ser un día hábil.

Ejemplo: Si queremos programar un cargo para el día 15 de Marzo, deberíamos de ingresar el cargo entre la fecha del 08 - 14 Marzo.

</aside>

POST

Deberás realizar una solicitud al siguiente endpoint:

{API_PLATFORM_URL}/v1/direct-debit/generate/charges

Headers

En el Header, es necesario declarar la información que obtuviste durante el proceso de Inicio de Sesión.

{
    "Authorization": "eyJraWQiOiJNc2ZqVEZYSDdPV1d1emp3U3daaGlaZWZyNW9rVlVPeWpocVwvMzNNU2J6az0iLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjOGJiZDRhMi0xYjgwLTRmOWYtOWM2My1h..."
}

Body

Dentro de la sección de body de la respuesta, encontrarás información detallada sobre la operación de domiciliación. La interfaz proporciona datos esenciales, como la fecha de procesamiento y los cargos programados.

A continuación, se muestra un ejemplo estructurado:

Body interface:
{
		"merchant_code"?: mx_comercio // ---> este dato es opcional 
    "process_date": string, // --> format 2024-03-07 
    "scheduled_charges": array[] [
        {
            "subscriptionId": strint,
            "amount": number
        }
    ]
}

Example: 
{
    "process_date": "2024-03-05", // --> si la fecha no tiene este formato dará error
    "scheduled_charges": [
        {
		        "merchantOrderId": "etpay0001"
            "subscriptionId": "lAWLK1YN9W[...]fyg5mr90FbW5akUnv",
            "amount": "2.87" //---> error por typo de dato "string"
        },
        {
		        "merchantOrderId": "etpay0002"
            "subscriptionId": "", //---> error por falta de información
            "amount": 5
        },
        {
            "subscriptionId": "0mFeVDxXY[...]1ahEWuwDgg0X4x3JZHTiFg2XwE" // ---> error por falta de información
        },
        {
		        "merchantOrderId": "etpay0003"
            "subscriptionId": "btYfKQD[...]fYsED4eytqcUSyw9GinWTQP1z",
            "amount": 1.20
        },
        {
		        "merchantOrderId": "etpay0004"
            "subscriptionId": "7LI5pDfB0X[...]NvFNrpZIoojU6TZ3WW8NuLf", 
            "amount": 5
        },
        {
		        "merchantOrderId": "etpay0001" // ---> error por valor repetido
            "subscriptionId": "7LI5pDfB0X[...]NvFNrpZIoojU6TZ3WW8NuLf", // ---> error por valor repetido
            "amount": 5
        },
    ]
}

Este formato te ofrece una visión clara de la fecha de procesamiento y los detalles de los cargos programados, permitiéndote comprender fácilmente los resultados de la operación de domiciliación.

Respuestas