Schedule simulation

You can simulate a schedule, for example to show it to the customer on a product description page.
To simulate a schedule, use the EstimatedSchedule service.

Example in the integration environment

POST https://paymentgateway.integration-cb4x.fr/v1/estimated-schedule/merchants/38/sites/7017

Headers
Content-type : application/json
authToken : the token retrieved via the call to the authentication service

Body

{
  "amount": 5800,
  "orderDate": "2022-02-02T12:06:32.000000+02:00",
  "paymentOptionRef": "63",
  "includePaymentFees": true,
  "FeesAmount": 0
}

includePaymentFees must be always true
FeesAmount must be always 0
amount is in cents

Response

{
    "paymentOptionRef": "63",
    "orderDate": "2022-03-08T11:06:32+01:00",
    "amount": 5939,
    "code": 0,
    "message": "Request successfully processed",
    "schedules": [
        {
            "amount": 1487,
            "date": "2022-03-08T11:06:32+01:00",
            "rank": 1
        },
        {
            "amount": 1484,
            "date": "2022-04-07T11:06:32+02:00",
            "rank": 2
        },
        {
            "amount": 1484,
            "date": "2022-05-07T11:06:32+02:00",
            "rank": 3
        },
        {
            "amount": 1484,
            "date": "2022-06-06T11:06:32+02:00",
            "rank": 4
        }
    ],
    "feesAmount": null
}