Retrieve list of settlements

GET

https://api.cash-in.com/v2/getsettlementslist

Get a list of settlements. List contains all settlement numbers.
By default, returns the latest 50 settlements ordered by settlement number (descending).
Supports pagination and sorting options.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

X-Api-Key: ********************

Query Params

Responses

🟢200

application/json

Settlements found

Body

🟠400

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cash-in.com/v2/getsettlementslist?FetchLimit=50&Page=1&SortOrder=desc' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

[
    {
        "SettlementNumber": 0,
        "SettlementDate": "2019-08-24T14:15:22.123Z",
        "ApiFetchDate": "2019-08-24T14:15:22.123Z"
    }
]

Retrieve debtor summary

Retrieve settlement data