settle_dispute_hold_m Sample Call and Response
This example shows a client settling a previously created dispute on an account by converting it to a permanent write-off, based on the settle_dispute_hold_m method defined in plsql_m_r73.yml.
This example covers settling one dispute, identified by dispute_no, with a settlement_action of permanent write-off and an explanatory comment. It does not cover the client_acct_id field, which is an alternative to acct_no, or the two other settlement_action values that remove the dispute hold instead of converting it to a write-off.
Sample call
{
"rest_call": "settle_dispute_hold_m",
"output_format": "json",
"client_no": 12345,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"acct_no": 700456123,
"dispute_no": 340221,
"settlement_action": 1,
"comments": "Customer confirmed the charge is uncollectible; converting to permanent write-off.",
"client_receipt_id": "RCPT-2026-0724-0142"
}
The rest_call and output_format fields are added by the REST layer and are not part of the method's own argument list. The acct_no field belongs to a group of alternatives with client_acct_id; this example supplies the Aria-assigned numeric identifier. The settlement_action field is required and uses a three-value enumeration: one converts the dispute to a permanent write-off, two removes the hold and re-ages the original charge as of today, and three removes the hold without re-aging the charge; this example selects one, converting the dispute to a permanent write-off. The comments and client_receipt_id fields are optional and are included here to record why the dispute was settled and to give the client its own tracking reference for the action.
Sample response
{
"created_by": "jsmith",
"amount": 249.99,
"invoice_no": 5512087,
"invoice_date": "2026-06-15",
"invoice_amt": 249.99,
"dispute_creation_date": "2026-06-20",
"comments": "Customer confirmed the charge is uncollectible; converting to permanent write-off.",
"reason_code": 12,
"dispute_ind": 0,
"rec_no_2": 340221,
"is_voided": 0,
"error_code": 0,
"error_msg": "OK"
}
An error_code value of zero, together with an error_msg value of "OK", indicates that Aria settled the dispute as instructed. A nonzero error_code, paired with a descriptive error_msg, indicates that the settlement did not complete, for example because dispute_no did not correspond to an open dispute on the account. The dispute_ind value of zero in the response means this hold is now recorded as a write-off rather than a dispute, consistent with the settlement_action of one requested in the call; the is_voided value of zero means the record is not voided. This example leaves out the secondary_reason_code and dispute_exp_date fields, which are not populated in this scenario, and it leaves out the rec_no and can_unsettle fields, both of which are deprecated in this release and no longer returned. It also leaves out the error_details field, since that field is internal to Aria and is not returned to callers.