Retrieve Payments

Retrieve received payments from the agency. Please keep in mind that payload contains the allocated received payments prior debt collection settlement processing, so the allocations are subject to changes - therefore it's recommended to use the "Retrieve Settlements" endpoint for the absolute truth. Use the fromDate - toDate interval for the payload filtering.

Returns payments received from the agency for the selected period. Amounts reflect allocated payments before final debt-collection settlement; allocations may change as processing completes. For final, settled figures, use Retrieve settlements. Filter the result with the fromDate–toDate query interval.

Responses

🟢200

application/json

Bodyapplication/json

Example

[
  {
    "caseId": 481920,
    "invoiceNumber": "202600145",
    "invoicePaymentReference": "RF71234567890123456789",
    "originalPaymentReference": "RF71999999999999999999",
    "accountName": "ACME Oy",
    "bookingDate": "2026-03-27T00:00:00Z",
    "paymentDate": "2026-03-27T00:00:00Z",
    "invoiceAmount": 1250.0,
    "paymentAmount": 1250.0,
    "capitalAmountPaid": 1100.0,
    "interestAmountPaid": 100.0,
    "costsAmountPaid": 50.0,
    "currency": "EUR",
    "agency": "NETVISOR"
  },
  {
    "caseId": 481921,
    "invoiceNumber": "202600146",
    "invoicePaymentReference": null,
    "originalPaymentReference": null,
    "accountName": null,
    "bookingDate": "2026-03-28T00:00:00Z",
    "paymentDate": "2026-03-28T00:00:00Z",
    "invoiceAmount": 980.5,
    "paymentAmount": 500.0,
    "capitalAmountPaid": 450.0,
    "interestAmountPaid": 35.0,
    "costsAmountPaid": 15.0,
    "currency": "EUR",
    "agency": "PROCOUNTOR"
  }
]

🟠401Unauthorized

Request

Responses