It is possible to retrieve schedules that are:
Linked to an eligibility request
Linked to an order
To retrieve the schedule for an eligibility request, you must use the service EligibilityInstallmentPlan
You will have to send requestId, returned by the service Eligibility, as parameter.
To retrieve the schedule for an order, you must use the service Gets payment schedule
You will have to send orderRef, returned by the service paymentSession, as parameter.
Exemple Schedule for an order
GET https://paymentgateway.integration-cb4x.fr/v1/1277394/merchants/38/sites/7017
Headers
Content-type : application/json
authToken : the token retrieved via the call to the authentication service
Body
Empty
Response
{
"orderTag": null,
"schedules": [
{
"amount": 14129,
"date": "2022-05-13T00:00:00",
"rank": 1,
"currency": "eur",
"state": "cashed",
"capturedAmount": 14129,
"remainingAmount": 0,
"cancelledAmount": 0,
"refundedAmount": 0
},
{
"amount": 14128,
"date": "2022-06-12T00:00:00",
"rank": 2,
"currency": "eur",
"state": "init",
"capturedAmount": 0,
"remainingAmount": 14128,
"cancelledAmount": 0,
"refundedAmount": 0
},
{
"amount": 14128,
"date": "2022-07-12T00:00:00",
"rank": 3,
"currency": "eur",
"state": "init",
"capturedAmount": 0,
"remainingAmount": 14128,
"cancelledAmount": 0,
"refundedAmount": 0
},
{
"amount": 14128,
"date": "2022-08-11T00:00:00",
"rank": 4,
"currency": "eur",
"state": "init",
"capturedAmount": 0,
"remainingAmount": 14128,
"cancelledAmount": 0,
"refundedAmount": 0
}
],
"additionalData": {
"RawOrderAmount": "55248",
"ScoringToken": "2f0228f8-9f0f-4a2c-ba7e-081b01f3a0eb"
},
"asyncOperationId": 0,
"orderRef": "1277394",
"responseCode": "success",
"actionType": null,
"responseMessage": "Request was successfully processed"
}
Schedules states
| State | Description |
|---|---|
| init | installment to be collected |
| payed | installment collected, waiting for the bank report |
| cashed | installment collected |
| cancelled | installment cancelled |
| discarded | litigation with this installment |