cancel_unconsumed_credit_m Sample Call and Response
This example shows a call that deletes all unused credits associated with a particular coupon, based on the cancel_unconsumed_credit_m method as defined in plsql_m_r73.yml.
This example covers the two identifying fields the method requires, the account and the coupon code. It does not cover the alternative client-defined account identifier.
Sample call
{
"rest_call": "cancel_unconsumed_credit_m",
"output_format": "json",
"client_no": 60123,
"auth_key": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
"acct_no": 3005567,
"coupon_cd": "SPRING2026PROMO"
}
The rest_call and output_format fields form the envelope that the REST layer adds to every call; they are not part of the method arguments defined in the yml file. The account is identified with acct_no, the Aria-assigned account identifier, rather than the alternative client-defined identifier, client_acct_id; you use only one of these two fields, never both. The coupon_cd field is the client-defined coupon code whose unused credits you want to remove, and it has no alternative form.
Sample response
{
"error_code": 0,
"error_msg": "OK"
}
An error_code of zero and an error_msg of "OK" indicate that all unused credits associated with the specified coupon were deleted successfully. This method returns no additional output fields beyond the standard error indicators.