Home > Aria6 User Documentation > Aria6 core api > record_external_payment


Records a payment transaction for a payment collected from an account holder without using Aria.

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.
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
specific_charge_transaction_id long array 32 Unique transaction ID for specific charges, usually when the account holder makes a purchase that is not part of their normal recurring charges.
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
invoice_no long array 32 account holder makes a payments and the check can be applied to a specific invoices.
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
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.

Last modified


This page has no custom tags.


This page has no classifications.