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. | ||||||
![]() |
acct_no | long | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. | |||||||
OR | ||||||||||
userid | string | 100 | User's unique identifier. If account_no is valued, this value must be blank. | |||||||
OR | ||||||||||
client_acct_id | string | 50 | Client-defined account identifier. | |||||||
![]() |
payment_method_no | long | 22 | Aria-assigned sequence number for this payment method. | ||||||
OR | ||||||||||
client_payment_method_id | string | The client-defined billing primary payment method ID. | ||||||||
![]() |
mandate_signature_date | string | The date, in yyyy-mm-dd format, on which the mandate was signed. | |||||||
![]() |
mandate_signature_place | string | This describes the city or other designation where the mandate was signed. | |||||||
![]() |
mandate_signed | string | 5 |
This should be set to 'true' to indicate that the mandate has been signed by the debtor. Allowable values for mandate_signed:
|
||||||
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. | ||||||||
![]() |
string | 100 | Name of the field you want to associate with this API call. | |||||||
![]() |
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. |
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. |