Update Settlement
Header Parameters
Api-Keystring Required
Path Parameters
idinteger Required
Settlement Id
Body Parameters
client_idstring Required
A unique identifier of the client related to this settlement.
debt_idstring Required
A unique identifier for the debt related to this settlement being updated.
settlement_amountstring Required
Dollar amount of the settlement being updated.
settlement_feestring Required
Fees associated with the settlement being updated.
notesstring Required
Notes associated with the settlement being updated.
referencestring Required
Additional reference information associated with this settlement being updated.
paymentsarray
Show child attributes
creditorobject Required
Show child attributes
Response
200
Object
The attempt to update this settlement entry was successful
Response Attributes
client_idstring Required
debt_idstring Required
settlement_amountstring Required
settlement_feestring Required
notesstring Required
referencestring Required
paymentsarray
Show child attributes
creditorobject
An object containing detailed information about the creditor participating in the settlement.
Show child attributes
400
Object
Update attempt was unsuccessful
Response Attributes
statusobject Required
The current status of the settlement, indicating its progress or final state (e.g., pending, completed, failed).
Show child attributes
Was this section helpful?
What made this section unhelpful for you?
Response
Was this section helpful?
What made this section unhelpful for you?