settle_account_balance_bulk_m Sample Call and Response
This example shows a client submitting multiple accounts in a single batch for collection attempts against a payment processor, based on the settle_account_balance_bulk_m method defined in plsql_m_r73.yml.
This example covers three accounts in the account_info array, two identified by an Aria-assigned payment method number and one identified by an Aria-assigned master plan instance number. It does not cover the client_acct_id, client_payment_method_id, or client_master_plan_instance_id fields, which are client-defined alternatives to the Aria-assigned identifiers used in this example.
Sample call
{
"rest_call": "settle_account_balance_bulk_m",
"output_format": "json",
"client_no": 12345,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"account_info": [
{
"acct_no": 700456123,
"payment_method_no": 55012
},
{
"acct_no": 700456456,
"payment_method_no": 55089
},
{
"acct_no": 700456789,
"master_plan_instance_no": 900321
}
]
}
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 account_info field is an array, as its description states directly, allowing this bulk method to submit multiple accounts for collection in a single call; this example includes three entries to illustrate that the bulk version accepts multiple accounts, in contrast to the singular settle_account_balance_m method, which acts on only one account per call. For each entry, acct_no belongs to a group of alternatives with client_acct_id, and the payment identification fields, payment_method_no, client_payment_method_id, master_plan_instance_no, and client_master_plan_instance_id, form a second group of alternatives, exactly one of which each entry must supply; this example uses payment_method_no for the first two accounts and master_plan_instance_no for the third, since Aria uses the payment method tied to that instance when an instance number is supplied. Every account submitted must already be assigned to a collection group before this call, or Aria does not attempt collection for it.
Sample response
{
"error_code": 0,
"error_msg": "Batch successfully submitted"
}
An error_code value of zero, together with an error_msg value of "Batch successfully submitted", indicates that Aria accepted the batch and added the submitted accounts to the flat file sent to the payment processor; it does not by itself mean that every individual account was collected successfully, since the processor returns its own response file after making the collection attempts. A nonzero error_code, paired with a descriptive error_msg, indicates that Aria rejected the batch, for example because one or more entries in account_info did not supply a required identifier. This example leaves out the error_details field, since that field is internal to Aria and is not returned to callers.