latestOpenAPI 3.0.42026-08-194977335.3 KB

40bd25a4edaf

Cases

Fetch case payments

Returns all payments recorded on a specific case.

Payment Information Includes:

  • Payment amount and currency
  • Payment date (when received)
  • Payment type (full payment, partial payment, settlement)
  • Payment method (bank transfer, card, cash, etc.)
  • Payment status (pending, confirmed, reconciled)
  • Reference information
  • Allocation breakdown (principal, interest, fees)

Use Case: Use this endpoint to:

  • Track payment history for a case
  • Reconcile payments with your records
  • Display payment status to users
  • Calculate outstanding balances
  • Generate financial reports

Note: Only payments associated with this specific case are returned. All payments are returned in reverse chronological order (newest first).

get/cases/{id}/payments

Path parameters

idstring uuid required

Response

Payments returned (may be empty array)

idstring uuid
dateCreatedstring date-time
dateUpdatedstring date-time nullable
datestring date-time
grossAmountnumber double
recipientstring nullable required
methodstring nullable required
currencystring nullable required