Retrieve received payments

GET

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

This API endpoint returns a list of incoming payment transactions to the creditor outstanding invoices in Cash-In Payment Control. This is however not the FINAL status of the payment, but a list of transactions that have been received to the payment control from debtors.

Request

Authorization

API Key

Add parameter in header

X-Api-Key

Example:

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

Query Params

Responses

🟢200

application/json

Body

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Example 1

[
    {
        "CaseId": 0,
        "InvoiceNumber": "string",
        "InvoicePaymentReference": "string",
        "OriginalPaymentReference": "string",
        "DateSaved": "2019-08-24T14:15:22.123Z",
        "DatePosted": "2019-08-24T14:15:22.123Z",
        "PaymentDate": "2019-08-24T14:15:22.123Z",
        "PaymentAmount": 0,
        "PaymentCurrency": "string"
    }
]

Retrieve delivery statistics

Submit update to Finvoice Account