Skip to content

Payment schedule simulation

We offer the possibility for the merchant to simulate the payment schedule that the client would pay.

Security

This endpoint has open CORS policy.
You can integrate it in your frontend directly.

Endpoint

POST /api/users/me/merchants/<merchant_uid>/simulate_payment_schedule

Parameters

ParameterDescriptionRequired
amount_centsamount_cents of the purchasetrue
createddate when the purchase would be created (format : "yyyy-mm-dd")true

Request example

json
{
    "amount_cents": 200,
    "created": "2021-12-17"
}

Response example

Status 200

json
{
    "INSTALLMENT": [
        {
            "amount_cents": 68,
            "fees": 2,
            "payment_date": "2021-12-17"
        },
        {
            "amount_cents": 66,
            "fees": 0,
            "payment_date": "2022-01-17"
        },
        {
            "amount_cents": 66,
            "fees": 0,
            "payment_date": "2022-02-17"
        }
    ]
}