Void Settlement
Header Parameters
Api-Keystring Required
Path Parameters
idinteger Required
Settlement Id
Response
200
Object
Success - Settlement is now voided
Response Attributes
client_idstring Required
ID of the Client for whom this settlement is being voided.
debt_idstring Required
ID of the Debt associated with the settlement being voided.
settlement_amountstring Required
Dollar amount of the settlement begin voided.
settlement_feestring Required
Fees associated with the settlement being voided.
notesstring Required
Notes associated with the settlement being voided.
referencestring Required
Additional reference information associated with the settlement being voided.
paymentsarray
Show child attributes
creditorobject
Show child attributes
400
Object
Error Response
Response Attributes
statusobject Required
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?