 |
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_number |
long |
|
Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
|
first_name |
string |
300 |
Billing address first name |
|
last_name |
string |
300 |
Billing address last name |
|
middle_initial |
string |
2 |
Billing address middle initial |
|
company_name |
string |
100 |
Billing address company name |
|
address1 |
string |
300 |
Billing street address line one |
|
address2 |
string |
300 |
Billing street address line two. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. |
|
city |
string |
300 |
Billing address city |
|
locality |
string |
300 |
Billing address locality. Use this field instead of the <state> field to identify the state, province, or other local designation as appropriate for addresses in all countries other than the United States, Australia, and Canada. This field is ignored for all addresses in the United States, Australia, and Canada. |
|
state |
string |
10 |
Billing address state or province. The official postal-service code for any state, province, or territory in the United States, Australia, or Canada. This field does not support states, provinces, or territories in other countries.
This field is ignored for all addresses outside the United States, Australia, and Canada. Use the <locality> field for addresses in those countries.
|
|
country |
string |
15 |
Billing address ISO-compatible 2-letter country code |
|
zip |
string |
15 |
Billing address zip or postal code |
|
intl_phone |
string |
25 |
Billing address international phone number |
|
phone_npa |
string |
3 |
Numbering Plan Area value (area code) of the phone of the billing contact. |
|
phone_nxx |
string |
3 |
Exchange (first 3 numbers following the area code/NPA) of the phone of the billing contact. |
|
phone_suffix |
string |
10 |
Exchange (NXX) target number of the phone of the billing contact. |
|
phone_extension |
string |
10 |
Billing address telephone extension |
|
email |
string |
320 |
Billing address contact email |
|
pay_method |
string |
38 |
Billing address payment method code Allowable Values
Values |
Description |
-1 |
External payment |
-0 |
Other/None |
1 |
Credit card |
2 |
Electronic check |
3 |
Prepaid |
4 |
Net Terms 30 |
5 |
Net Terms 10 |
6 |
Net Terms 15 |
7 |
Net Terms 60 |
8 |
Click & Buy |
9 |
Net Terms 0 |
10 |
PayByCash |
11 |
PayPal Express Checkout |
12 |
Net Terms 45 |
13 |
Tokenized Credit Card |
14 |
Purchase Power |
15 |
Net Terms 35 |
16 |
Net Terms 75 |
17 |
Net Terms 90 |
18 |
Net Terms 120 |
19 |
Net Terms 25 |
20 |
NETS |
21 |
FIK |
26 |
Direct Debit |
29 |
Reserve Account |
|
|
cc_number |
string |
|
Credit card number, if payment method is CC |
|
cc_expire_mm |
long |
|
Credit card expiration month, 2-digit |
|
cc_expire_yyyy |
long |
|
Credit card expiration year, 4-digit |
|
bank_routing_num |
string |
|
Bank account routing number |
|
bank_acct_num |
string |
|
Bank account number |
|
do_collect |
string |
1000 |
If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances. Allowable Values
Values |
Description |
true |
true |
false |
false |
|
|
change_status_after_coll |
string |
1000 |
Indicates if the account status is to change after collection is completed. Allowable Values
Values |
Description |
true |
true |
false |
false |
|
|
reset_dates_after_status |
string |
1000 |
If 'true', resets the billing dates after an account status change. Allowable Values
Values |
Description |
true |
true |
false |
false |
|
|
client_receipt_id |
string |
50 |
Client-defined unique identifier used to track related system actions |
|
bank_acct_type |
string |
|
The type of bank account being used. Allowable Values
Values |
Description |
savings |
savings |
checking |
checking |
business |
business |
|
|
bill_agreement_id |
string |
32 |
Unique ID of the bill agreement (also referred to as a token). |
|
cc_id |
long |
2 |
A numeric code indicating the type of credit card. Allowable Values
Values |
Description |
1 |
Visa |
2 |
MasterCard |
3 |
American Express |
4 |
Discover |
5 |
Diners Club/Carte Blanche |
6 |
Maestro |
7 |
JCB |
8 |
Laser |
9 |
Dankoort |
|
|
iban |
string |
50 |
International Bank Account Number(IBAN). Used for the Direct Debit payment method. It consists of 16 to 34 alphanumeric characters. Only hyphen and space are allowed to format the IBAN. |
|
bank_check_digit |
long |
2 |
Bank check digits enable a sanity check of the bank account number to confirm its integrity before submitting a transaction. Used for the Direct Debit payment method. |
|
bank_swift_cd |
string |
15 |
SWIFT code is a standard format of Bank Identifier Codes (BIC). Used for the Direct Debit payment method. It consists of 8 or 11 alphanumeric characters. Only hyphen and space are allowed to format the SWIFT code. It is required for IBAN. |
|
bank_country_cd |
string |
2 |
Country of the bank. The ISO-compliant 2-character country code abbreviation in uppercase. Used for the Direct Debit payment method. It is required for IBAN and BBAN. |
|
mandate_id |
string |
35 |
Used for the Direct Debit payment method. A mandate is signed by the debtor to authorise the creditor to collect a payment and to instruct the bank of the debtor to pay those collections. |
|
bank_id_cd |
string |
10 |
Up to 10 digit numeric bank identifier code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank ID code. It is required for BBAN. |
|
bank_branch_cd |
string |
10 |
Up to 10 digit numeric bank branch code. Used for the Direct Debit payment method. Used in Europe. Only hyphen and space are allowed to format the bank branch code. |
|
primary_or_bkup_pay_method_ind |
long |
1 |
Indicates whether to update primary or secondary payment method. Allowable Values
Values |
Description |
1 |
update the primary payment method associated with the account. |
2 |
update the secondary payment method associated with the account. |
|
|
ref_bkup_seq_no |
long |
8 |
The unique bill sequence number of the existing payment method on account to be set as backup payment method. |
|
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. |
|
fraud_filter |
long |
1 |
Enables or disables fraud filtering. If no value is provided, the system will default to 2.
To use fraud filtering, you must have it enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.
Notes:
- If you set this field to 0, then Aria will ignore all other fraud filtering fields.
- If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will be ignore that field.
- If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.
|
Allowable Values
Values |
Description |
0 |
false (disable)
Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.
|
1 |
true (enable)
Note: If you set this field to 1, then Aria will apply the values that you specified in the other fraud filtering fields. However, if you pass -1 into any fraud filtering field, Aria will be ignore that field.
|
2 |
Use settings specified at the collection group or payment gateway level.
Note: If you set this field to 2, then Aria will apply the values that you specified in the other fraud filtering fields.
|
|
|
fraud_control_fields |
array |
|
Your chosen fraud protection options passed as an array of fraud_control_field_name/fraud_control_field_value key-value pairs. This array allows you to specify your fraud filtering options. To use fraud filtering, you must have fraud functionality enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation. The allowable fields and values for the key-value pairs are highlighted in blue below. |
|
|

fraud_filtering_enabled |
string |
100 |
Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields. Allowable Values
Values |
Description |
0 |
disable |
1 |
enable |
-1 |
Use settings specified at the collection group or payment gateway level. |
|
|
change_status_on_fraud_filtering_failure |
string |
100 |
Indicates whether to change the status of the account or master plan instance(s) if:
- The fraud filtering request returns a failure response; and
- fraud_filtering_enabled is set to 1 (enable).
Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable Values
Values |
Description |
0 |
false |
1 |
true |
-1 |
Use settings specified at the collection group or payment gateway level. |
|
|

status_on_fraud_filtering_failure |
string |
100 |
If change_status _on_fraud_filtering_failure is set to true and the fraud filtering request returns a failure response, use this field to indicate the desired status of the account. |
|
change_status_on_fraud_filtering_review |
string |
100 |
Indicates whether to change the status of the account or master plan instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. Allowable Values
Values |
Description |
0 |
false |
1 |
true |
-1 |
Use settings specified at the collection group or payment gateway level. |
|
|

status_on_fraud_filtering_review |
string |
100 |
If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the account. |
|

change_status_on_fraud_filtering_cc_prefix_failure |
string |
100 |
Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
Values |
Description |
0 |
false |
1 |
true |
|
|

status_on_fraud_filtering_cc_prefix_failure |
string |
100 |
If change_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) |
|

change_status_on_fraud_filtering_cc_number_failure |
string |
100 |
Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
Values |
Description |
0 |
false |
1 |
true |
|
|

status_on_fraud_filtering_cc_number_failure |
string |
100 |
If change_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) |
|

change_status_on_fraud_filtering_cc_issuing_country_failure |
string |
100 |
Indicates whether to change the status of the account if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
Values |
Description |
0 |
false |
1 |
true |
|
|

status_on_fraud_filtering_cc_issuing_country_failure |
string |
100 |
If change_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) |
|
change_status_on_fraud_filtering_cc_issuing_country_suspect |
string |
100 |
Indicates whether to change the status of the account if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status. (applies to Direct Post) Allowable Values
Values |
Description |
0 |
false |
1 |
true |
|
|

status_on_fraud_filtering_cc_issuing_country_suspect |
string |
100 |
If change_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the account. (applies to Direct Post) |
End of fraud_control_fields array |
Req |
Field Name |
Field Type |
Max Length |
Description |
|
end_user_session_id |
string |
32 |
The client-generated session ID that is often used with captcha fraud prevention measures as part of an online order. |
|
end_user_ip_address |
string |
15 |
IP address that was used to place an online order. |
|
end_user_browser_accept_header |
string |
32 |
Browser accept header that was used to place an online order. Example: “text/html,application/xhtml+xml,application/xml ;q=0.9,*/*;q=0.8". |
|
end_user_browser_agent |
string |
32 |
Browser that was used to place an online order. Example: "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0". |
Start of proc_field_override array |
|
proc_field_override |
array |
|
Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.
The allowable field(s) and values for the key-value pairs are listed below.
|
|
Field Name |
Field Type |
Max Length |
Description |
|
 transaction_type |
string |
2 |
If you use Chase Paymentech, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's payment information.
This field applies to credit cards and tokenized credit cards. If you don't pass a value into this field, it will default to -1 (use client configuration settings).
Notes:
- The value that you pass into this field will override the Recurring Options that you set in the Aria application under:
- Configuration > Payments > Payment Gateways > Chase Paymentech > Gateway Options; and
- Configuration > Payments > Collection Groups > Chase Paymentech > Collection Group Options.
- Currently, only Chase Paymentech supports this field. Other payment gateways might not honor all of the allowable values for this field. You will need to check your payment gateway documentation for confirmation.
Aria will use this order of precedence to determine the transaction type:
- value passed into this field
- collection group configuration
- payment gateway configuration
- transaction type that you specified in the <recurring_processing_model_ind> field
Allowable Values
Values |
Description |
-1 |
Use client configuration settings for "Send Transaction Type as Recurring for Initial Request Where Possible" or "Send Transaction Type as Recurring for Subsequent Request" as applicable. (default) |
1 |
Single transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and completes the sale over the phone or through the mail. The transaction is not for recurring services or products and does not include sales that are processed via an installment plan. |
2 |
Recurring Transaction - Designates a transaction that represents an arrangement between an accountholder and the merchant where transactions are going to occur on a periodic basis. |
3 |
Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments. |
4 |
Deferred Transaction - Designates a transaction that represents an order with a payment delayed for a specified amount of time. |
5 |
Secure Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant and in which the accountholder was fully authenticated. (examples: 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy.) |
6 |
Non-Authenticated Electronic Commerce Transaction - Designates a transaction completed via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (examples: 3-D Secure includes Verified by Visa and Mastercard Identity Check.) Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy transactions in the event of: * A non-participating issuer * A non-participating accountholder of a participating issuer * A participating issuer, but the authentication server is not available |
7 |
Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where the transaction includes the use of transaction encryption such as SSL (Secure Sockets Layer), but authentication was not performed. The accountholder payment data was protected with a form of Internet security, such as SSL, but authentication was not performed. For Discover, indicates an e-commerce Card Transaction with data protection in which ProtectBuy for Cardholder authentication was not used. |
8 |
Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant completed via the Internet where: * The transaction does not include the use of any transaction encryption such as SSL * Authentication is not performed * An accountholder certificate is not managed. |
I |
IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes the sale via an interactive voice response (IVR) system. |
R |
Retail Transaction - Designates a transaction where the accountholder was present at a merchant location. |
|