get_accts_with_existing_pay_method_m Sample Call and Response
This example shows a client searching for every account that already has a specific bank account number on file as a payment method, based on the get_accts_with_existing_pay_method_m method defined in plsql_m_r73.yml.
The example searches for an electronic check (ACH) payment method identified by a bank account number and routing number. It does not cover a search for a credit card number, and it does not cover a search that also supplies a bill agreement ID (token).
Sample call
{
"rest_call": "get_accts_with_existing_pay_method_m",
"output_format": "json",
"client_no": 4009,
"auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
"pay_method": 2,
"form_payment_acct_id": "000123456789",
"bank_routing_num": "021000021"
}
The pay_method value of two indicates that the search is for an electronic check (ACH) payment method, identified by bank account number rather than credit card number; the other allowable value is one, for a credit card search. Because the search targets a bank account, this example includes bank_routing_num alongside form_payment_acct_id and omits the optional bill_agreement_id field, which applies to tokenized payment methods. The auth_key value shown here carries masked logging in the yml, meaning Aria treats it as sensitive in system logs, and form_payment_acct_id is masked for the same reason. The rest_call and output_format fields are added by the REST layer.
Sample response
{
"error_code": 0,
"error_msg": "",
"accts_with_pay_method": [
{
"acct_no": 3300145,
"active": 1
},
{
"acct_no": 3300612,
"active": 0
}
]
}
An error_code value of zero together with an empty error_msg indicates that Aria completed the search successfully. The accts_with_pay_method field is an array because more than one account can share the same bank account number, for example a household with several linked accounts; this example shows two matching accounts, but a real search could return none, one, or many more. The active value of one on the first account means that this bank account number is currently the active, primary payment method for that account, while the active value of zero on the second account means the same bank account number is on file there but is not the current primary payment method. This example omits the nonpublic error_details field.