Retrieve settlement data

GET

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

This API endpoint is for the Creditor to download debt collection settlements from Cash-In Collection.
Settlements payload contains payment information related to receivables settled by the Debt Collection.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

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

Query Params

Responses

🟢200

application/json

Settlement(s) found

Body

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.cash-in.com/v2/getsettlements?settlementNumber' \
--header 'X-Api-Key: <api-key>'

Response Example

200 - Example 1

[
    {
        "SettlementNumber": 0,
        "SettlementDate": "2019-08-24",
        "SettlementPaymentDate": "2019-08-24T14:15:22.123Z",
        "SettlementPaymentIBAN": "string",
        "SettlementPaymentBIC": "string",
        "SettlementPaymentRef": "string",
        "SettlementCurrency": "string",
        "SettlementTotalAmount": 0,
        "SettlementRows": [
            {
                "SettlementAccountNo": "string",
                "SettlementCaseId": 0,
                "SettlementTransactionType": "string",
                "SettlementInvoiceNbr": "string",
                "SettlementInvoiceRef": "string",
                "SettlementCustomerRef": "string",
                "SettlementPaymentDate": "2019-08-24T14:15:22.123Z",
                "SettlementPaymentCurrency": "string",
                "SettlementTransactionAmount": 0
            }
        ]
    }
]

Retrieve list of settlements

Retrieve list of direct settlements