Retrieve list of direct settlements

GET

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

This API Service is for the Creditor to download direct settlement numbers from Cash-In Collection.
Settlement List payload contains direct settlement numbers. You can also limit the response to latest number of settlements.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

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

Query Params

Responses

🟢200

application/json

Direct Settlements found

Body

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.cash-in.com/v2/directsettlements?fetchLimit=undefined' \
--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 settlement data

Retrieve direct settlement data