Skip to content
synpute

Monitoring

List payments

Preview

Payments under a contract, with status against the due date.

get/v1/contracts/{contract_id}/payments

Path parameters

contract_idSynpute IDrequired
Contract ID e.g. SYN-CT-4B71

Query parameters

limitinteger
Results per page, 1 to 100 e.g. 20
cursorstring
Cursor from the previous page's next_cursor

Response 200 · object

dataarray of Paymentrequired
Results, newest first
+Show properties
amountobject
Amount paid
+Show properties
amountinteger
Amount in the currency's minor unit (cents)
currencystring
ISO 4217 currency
USDEURGBP
contractSynpute ID
Contract
due_onstring
Due date
idstring
Payment ID
objectstring
Object type
paid_onstring | null
Date received
sourcestring
How it was recorded
bank_feedoperatorlender
statusstring
Status
paidlatemissedpending
has_morebooleanrequired
More results after this page
next_cursorstring | nullrequired
Pass as `cursor` for the next page
objectstringrequired
Object type

Errors

403404return the standard error shape.