Monitoring
Record a payment
PreviewRecord a rent payment under a contract. Operators send payments; lenders can confirm them from a bank feed.
post/v1/contracts/{contract_id}/payments
monitor:writePath parameters
- contract_idSynpute IDrequired
- Contract ID e.g. SYN-CT-4B71
Body parameters
- amountobjectrequired
- Amount paid
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
- due_onstringrequired
- Due date
- paid_onstringrequired
- Date received
Response 201 · Payment
- amountobjectrequired
- Amount paid
+Show propertiesHide properties
- amountinteger
- Amount in the currency's minor unit (cents)
- currencystring
- ISO 4217 currency
USDEURGBP
- contractSynpute IDrequired
- Contract
- due_onstringrequired
- Due date
- idstringrequired
- Payment ID
- objectstringrequired
- Object type
- paid_onstring | nullrequired
- Date received
- sourcestringrequired
- How it was recorded
bank_feedoperatorlender- statusstringrequired
- Status
paidlatemissedpending
Errors
400404return the standard error shape.