Payment schedule simulation

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

API Endpoint

POST /api/merchants/<merchant_uid>/simulate_payment_schedule

Authentication

For security reasons, an access token is mandatory to use this endpoint (Authentication).

Never use this endpoint within your frontend application directly. Use the Front-end Endpoint instead.

Front-end Endpoint

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

Security

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

Parameters

Parameter	Description	Required
amount_cents	amount_cents of the purchase	true
created	date when the purchase would be created (format : "yyyy-mm-dd")	true

Request example

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

Response example

Status 200

{
    "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"
        }
    ]
}