Integration of the Pledg payment solution

Payment schedule simulation ​

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

Two different endpoints can be used, either by back-end servers or directly by front-end applications.

Endpoint for back-end applications (servers) ​

POST /api/merchants/<merchant_uid>/simulate_payment_schedule

Authentication and Security

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

⚠️ Never call this endpoint directly from your front-end application, as doing so will expose your private credentials.

If your front-end application needs access to this endpoint, see the front-end section below.

Endpoint for front-end applications (browsers) ​

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

Authentication and Security

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

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