Upcoming Payments

POST /api/v2/fetch_upcoming_payments

Provides the customer's upcoming payments, outstanding balance, and total item value.

The upcoming payments object


AttributeData typeRequiredDescription
id_numberstringtrueIdentification number of the customer

Curl Request

curl -i -X POST 'https://core-v2-multi-country.herokuapp.com/api/v2/fetch_upcoming_payments' \
-H 'Authorization: Bearer <access_token>' \
-H 'Content-Type: application/json' \
-d '{"id_number":"12345678"}'

JSON Request Object

"id_number": "12345678"

JSON Response

"request_id": "c92b88ee-9311-40db-a1cf-c3ed414e45de",
"apiVersion": "2.0",
"status": 200,
"data": {
"total_item_value": "52501.00",
"outstanding_balance": "25711.00",
"total_minimum_payments": "1880.00",
"payment_due_date": "2022-05-20T00:00:00.000+03:00"
  • total_item_value - defines the total value for all items collected by the client.
  • outstanding_balance - defines the total item value amount that has been disbursed to the client
  • total_minimum_payments - the minimum amount that is scheduled to be paid by the customer in a month
  • payment_due_date - the due date of the minimum payment amount