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. | |
![]() | reference_code | string | 32 | This code provides a reference correlation to the external payment. This field must be unique for every payment submitted by the client. |
![]() | payment_amount | double | 12 | The amount of the payment being/to-be made against the outstanding account balance |
comments | string | 500 | Additional explanatory text relating to this API call. | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
external_destination_id | long | 38 | The external system from which this payment originated | |
external_id | string | 38 | The ID of the corresponding record to this payment in the external system | |
payment_received_date | string | 10 | Date that the payment was received in yyyy-mm-dd format. This is specified for backdated external payments. | |
![]() | long array | 32 | Unique transaction IDs for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges. | |
OR | ||||
![]() | long array | 32 | Account holder makes a payment and the check can be applied to specific invoices. | |
alt_caller_id | string | 100 | ||
optional_transaction_qualifiers | array | |||
![]() | string | 100 | ||
![]() | string | 100 | ||
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 |
---|---|---|
transaction_id | long | The unique identifier for a given transaction. |
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. |
Fill out the required input parameter to execute API Live. A Live call will be made against the URL you specify to give you actual results formatted.