Home > Aria6 User Documentation > Aria6 core api > set_pay_method_bank_draft
set_pay_method_bank_draft
set_pay_method_bank_draft
Table of contents
Sets a validated bank account as the payment method of a specified account.
Input Arguments
| Req | Field Name | Field Type | Max Length | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
 |
client_no | long | 22 | Aria-assigned unique identifier indicating the Aria client providing service to this account. | ||||||||
|
auth_key | string | 32 | Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor. | ||||||||
|
account_no | long | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | ||||||||
|
bank_routing_num | string | 22 | ABA routing number for the bank holding 'bank_acct_num' | ||||||||
|
bank_acct_num | string | 19 | Bank account number. | ||||||||
| do_collect | string | 1000 | If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.
|
|||||||||
| change_status_after_coll | string | 1000 | Indicates if the account status is to change after collection is completed.
|
|||||||||
| reset_dates_after_status | string | 1000 | If 'true', resets the billing dates after an account status change.
|
|||||||||
| bank_acct_type | string | 8 | The type of bank account being used.
|
|||||||||
| client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions. | |||||||||
| alt_caller_id | string | 30 | Person or process that submitted the API call. This can be someone's user ID, or the name of an application. | |||||||||
| optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||||||||||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |||||||||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. | |||||||||
| application_id | string | 300 | The application identifier in which the API is being used in. (Example: “Sales Force”) | |||||||||
| application_date | string | 300 | The application date/timestamp, ie. 01/01/2014 10:00:00 to track when the application called the API. |
Output Arguments
| Field Name | Field Type | Description |
|---|---|---|
| error_code | long | Aria-assigned error identifier. 0 indicates no error. |
| error_msg | string | Description of any error that occurred. "OK" if there was no error. |
| collection_error_code | long | Error code associated with the collection. |
| collection_error_msg | string | Error message associated with collection_error_code. |
| proc_cvv_response | string | The processor return code from CVV validation. |
| proc_avs_response | string | Processor return code from address validation |
| proc_cavv_response | string | Processor return code for security validation. |
| proc_status_code | string | Processor status code |
| proc_status_text | string | Processor status description |
| proc_payment_id | string | Processor payment ID |
| proc_auth_code | string | Authorization code provided by the issuing bank |
| proc_merch_comments | string | Additional information passed to payment processor |
- © Copyright 2023 Aria Developer Central