Note: Inputs passed to this API call will override any fraud options that you specified in your payment gateway, collection group, or Direct Post settings, unless stated otherwise below.
For information on error messages generated by this API, see update_payment_method_m Error Messages.
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 | 22 | Aria-assigned account identifier. This value is unique across all Aria-managed accounts. |
OR | ||||
client_acct_id | string | 50 | Client-defined account identifier. | |
payment_method_no | long | 22 |
Aria-assigned sequence number for this payment method. To authorize a tokenized credit card, follow the instructions in the <cc_auth_amount> field (Note:The same pay method sequence number cannot be used for a primary and secondary payment method). |
|
client_payment_method_id | string | 100 | The client-defined billing primary payment method ID. | |
disabled_ind | long | 1 | Determines whether or not the existing payment method on the account (specified by payment_method_no / client_payment_method_id) should be disabled. When set to 1, the payment method will be disabled. Note that once a payment method has been disabled, it cannot be re-enabled. When set to 0 (default), the payment method will remain enabled. This input takes precedence over all other parameters available for updating a payment (i.e., the existing payment method specified will not be disabled and no new payment methods will be created on the account). Allowable Values | |
bill_contact_no | long | 22 | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. | |
bill_first_name | string | 100 | First name of the billing contact. | |
bill_middle_initial | string | 2 | Middle initial of the billing contact. | |
bill_last_name | string | 100 | Last name of the billing contact. | |
bill_company_name | string | 100 | Company name of the billing contact. | |
bill_address1 | string | 100 | First address line of the billing contact. | |
bill_address2 | string | 100 | Second address line of the billing contact. If you want to delete existing data in this field, leaving it blank, you must enter a '~' in this field. | |
bill_address3 | string | 100 | The third line of the billing address. | |
bill_city | string | 100 | City of the billing contact. | |
bill_locality | string | 32 |
Locality of the billing contact. Use this field instead of the <bill_state_prov> 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. |
|
bill_state_prov | string | 10 | State or province of the billing contact.
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 <bill_locality> field for addresses in those countries. |
|
bill_country | string | 2 | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |
bill_postal_cd | string | 15 | Postal code for the billing contact. | |
bill_phone | string | 25 | Phone number of the billing contact. | |
bill_phone_ext | string | 10 | Phone extension of the billing contact. | |
bill_cell_phone | string | 20 | Cell phone number of the billing contact. | |
bill_work_phone | string | 25 | Work phone number of the billing contact. | |
bill_work_phone_ext | string | 10 | The work phone extension for the billing contact work phone. | |
bill_fax | string | 25 | Fax number of the billing contact. | |
bill_email | string | 320 | Email of the billing contact. | |
bill_birthdate | string | 10 | Birthdate of the billing contact. | |
pay_method_name | string | 100 | The human-readable name of the payment method. | |
pay_method_description | string | 1000 | Description for the primary payment method.' | |
pay_method_type | long | 8 |
This is the method_id corresponding to a payment method such as card, Electronic Check, Pre-Paid, Net Terms, etc. To authorize a tokenized credit card, follow the instructions in the <cc_auth_amount> field. |
|
cc_num | string | 20 | Card number (for American Express®, must be a 15-character numeric value starting with 3). | |
cc_expire_mm | long | 2 | Expiration month for the card payment instrument. | |
cc_expire_yyyy | long | 4 | 4-digit expiration year for the card payment instrument. | |
cvv | string | 6 | Card Verification Value, used to help verify a transaction is being requested by the card holder because this value is physically printed on the card. | |
bank_acct_num | string | 19 | The bank account number. | |
bank_routing_num | string | 9 | The American Banking Association (ABA) routing number for the financial institution. | |
bill_agreement_id | string | 32 |
Unique ID of the bill agreement (also referred to as a token). To authorize a tokenized credit card, follow the instructions in the<cc_auth_amount> field. |
|
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). It is 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 authorize 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. 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. Only hyphen and space are allowed to format the bank branch code. | |
bank_name | string | 100 | Bank name for the account payment method. | |
bank_city | string | 100 | Bank city for the account payment method. | |
do_collect | string | 5 | If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances. Allowable Values | |
change_status_after_coll | string | 5 | Indicates whether the account status is to change after collection is completed. Allowable Values | |
reset_dates_after_status | string | 5 | If 'true', resets the billing dates after an account status change. Allowable Values | |
client_receipt_id | string | 50 | Client-defined unique identifier used to track related system actions | |
cc_id | long | 2 | A numeric code indicating the type of card. Allowable Values | |
cc_auth_amount | double | 22 |
For tokenized or non-tokenized cards, if an amount is provided for cc_auth_amount, a full authorization for the amount specified will be performed regardless of how the 'Perform Authorization Request on Card Update' client parameter is configured. When cc_auth_amount is not provided, the 'Perform Authorization Request on Card Update' client parameter will determine whether or not a $1 authorization will be attempted when saving a new card on an account. In the event authorization fails, the authorization will be reversed (for non-$0 authorizations) provided Aria's integration with the payment processor supports authorization reversals. To authorize a tokenized credit card:
Do one of the following:
Please contact your payment gateway representative for more information. |
|
disable_existing_on_update | string | 5 | When updating an existing payment method on an account, determines whether or not the original payment method (specified by payment_method_no / client_payment_method_id) should be disabled. When set to 'true' (default), the payment method will be disabled. Note that once a payment method has been disabled, it cannot be re-enabled. When set to 'false', the original payment method will remain enabled on the account. Allowable Values | |
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. | |
alt_client_collection_acct_group_id | string | 100 | The alternate client defined collection account group id used to perform authorization or collection.
Note: It is possible to have an account with more than one payment method with an agreement ID obtained outside of Aria with a collection group that is mapped with more than one billing group. When this input argument is used to pass a token outside Aria this API will validate the agreement ID against the collection group. When no collection group is passed as an input via API, then the agreement ID will be validated against the account level collection group. If there is no collection group at the account level, then the agreement ID is validated against the last processor mapped to that client. |
|
alt_collection_acct_group_no | string | 22 | The alternate collection account group number used to perform authorization or collection.
Note: It is possible to have an account with more than one payment method with an agreement ID obtained outside of Aria with a collection group that is mapped with more than one billing group. When this input argument is used to pass a token outside Aria this API will validate the agreement ID against the collection group. When no collection group is passed as an input via API, then the agreement ID will be validated against the account level collection group. If there is no collection group at the account level, then the agreement ID is validated against the last processor mapped to that client. |
|
Start of optional_transaction_qualifiers array | ||||
optional_transaction_qualifiers | array | Array of additional values you can associate with this API call. | ||
Field Name | Field Type | Max Length | Description | |
![]() |
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. | |
End of optional_transaction_qualifiers array | ||||
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:
|
|
Start of fraud_control_fields array | ||||
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. |
||
Field Name | Field Type | Max Length | Description | |
![]() |
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 | |
![]() |
string | 100 | Indicates whether to change the status of the account or master plan instance(s) if:
|
|
![]() |
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 master plan instance. | |
![]() |
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 | |
![]() |
string | 100 | If change_status _on_fraud_filtering_review is set to 1 (true), use this field to indicate the desired status of the master plan instance. | |
![]() change_mp_status_on_fraud_filtering_cc_prefix_failure |
string | 100 | Indicates whether to change the status of the master plan instance(s) 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 | |
![]() mp_status_on_fraud_filtering_cc_prefix_failure |
string | 100 | If change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |
![]() |
string | 100 | Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the 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 | |
![]() |
string | 100 | If change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |
![]() change_mp_status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 | Indicates whether to change the status of the master plan instance(s) 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 | |
![]() mp_status_on_fraud_filtering_cc_issuing_country_failure |
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |
![]() change_mp_status_on_fraud_filtering_cc_issuing_country_suspect |
string | 100 | Indicates whether to change the status of the master plan instance(s) 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 | |
![]() mp_status_on_fraud_filtering_cc_issuing_country_suspect |
string | 100 | If change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post) | |
End of fraud_control_fields array | ||||
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". | |
perform_marketing_insights_inquiry | long | 2 | Returns marketing information if your payment processor supports it and it is configured in Aria. Allowable Values | |
perform_balance_inquiry | long | 1 | When supported, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards. Allowable Values | |
perform_card_type_detail_inquiry | long | 1 | This feature will return marketing information if your payment processor supports it and configured in Aria. Allowable Values | |
new_client_payment_method_id | string | 100 | Specifies new client-defined unique identifier for payment method. | |
recurring_processing_model_ind | long | 1 |
Defines a recurring payment type for Credit Card and Tokenized Credit Cards. This feature is available to you if your payment gateway supports Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT). Note: Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled. Refer to your payment gateway documentation to see if this applies. Please contact your payment gateway representative for more information.
|
|
attempt_3d_secure | string |
This will manually trigger a 3DSecure check if the payment gateway/processor supports this feature. To perform 3DS authentication, follow the instructions provided in the authorize_3dsecure_m API documentation. |
||
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. |
||
![]() |
string | 100 | List of processor field names | |
![]() |
string | 1000 | List of processor field values | |
proc_field_name | Field Type | Max Length | proc_field_value | |
![]() |
string | 2 |
If you use Chase Paymentech or Vantiv, 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:
Aria will use this order of precedence to determine the transaction type:
|
|
Note: 3DS-related fields are listed below. Not all payment gateways support 3DS. The payment gateways documentation identifies payment gateways that support 3DS. Please contact your payment gateway representative for more information about which version of 3DS is supported and other details. | ||||
|
string | 2000 | Reference ID for a 3DS transaction session. | |
![]() |
string | 1 |
The transaction mode identifies the channel from which the 3DS transactions are originated. |
|
![]() |
string | 2000 | Authentication transaction ID for a 3DS authorization. | |
![]() |
string | 2000 | Browser accept header that was used for making a purchase online. Example: "text/html,application/xhtml+xml,application/xml ;q=0.9,*/*;q=0.8". | |
![]() |
string | 2000 | Browser that was used for making a purchase online. Example: "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0". | |
![]() |
string | 2000 | Browser color depth in bits per pixel. You can obtain this by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth. | |
![]() |
string | 2000 | Boolean value indicating whether the customer's browser is able to execute Java. | |
![]() |
string | 2000 | Browser supported language (as defined in IETF BCP-Internet Engineering Task Force Best Current Practice 47). You can obtain this by using the browser's navigator.language property. | |
![]() |
string | 2000 | Total height of the browser that was used for placing an online order. | |
![]() |
string | 2000 |
Total width of the browser that was used for placing an online order. |
|
![]() |
string | 2000 | Difference between UTC (Universal Time Coordinated) time and the customer's browser local time, in minutes. | |
![]() |
string | 2000 | If the response of DDC (Device Data Collection) is received within 10 seconds set this field to "Y". If not, set this field to "N". | |
![]() |
string | 2000 | If the response to the challenge shopper (requested authentication information) is not received within 10 minutes, set this field to "U". If not, set this field to the value received from the challenge shopper response. | |
End of proc_field_override array | ||||
disable_pmt_method_on_auth_failure | string | 5 |
Specifies whether to disable or enable a payment method after a failed card authorization. A card authorization will automatically be performed after successful completion of fraud scoring/filtering (if your payment gateway supports fraud scoring/filtering). If you pass in true and the authorization fails, the card is added to the account with a disabled status. |
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. |
seq_no | long | The sequence number of this payment, as it appears on the account |
collection_info | hash | A multidimensional array of collection information of master plan instance. |
![]() |
long | If a collection is attempted, returns the error code associated with the collection. |
![]() |
string | The error message associated with collection_error_code. |
![]() |
long | Aria-assigned bill group number |
![]() |
string | Specifies Client-defined ID for bill group |
![]() |
string | The processor return code from CVV validation. |
![]() |
string | Processor return code from address validation |
![]() |
string | The processors return code for security validation. |
![]() |
string | The processor status code |
![]() |
string | The processors status description |
![]() |
string | The processor payment ID |
![]() |
string | Authorization code provided by the issuing bank |
![]() |
string | Additional information passed to payment processor |
![]() |
double | Additional information passed back from processor for available balance on prepaid, gift card, and in some cases cards, if available. |
![]() |
string | Additional information passed back from processor identifying this card as a prepaid card (if available). |
![]() |
string | Additional information passed back from processor identifying whether prepaid card is reloadable (if available). |
![]() |
string | Additional information passed back from processor to categorize the type of prepaid card (if available). |
![]() |
string | Additional information passed back from processor indicating if card is affluent. |
![]() |
string | Additional information passed back from processor indicating issuing country for the card. |
![]() |
string | Additional information passed back from processor indicating whether the submitted card is a commercial or consumer card, providing you with additional data useful when analyzing sales patterns and/or planning marketing campaigns. |
![]() |
string | Additional information passed back from processor identifying this card as a signature debit card. |
![]() |
string | Additional information passed back from processor identifying this card as PINless-debit-eligible. |
![]() |
string | Additional information passed back from processor identifying this card as Durbin Regulated. |
![]() |
string | The unique number for an authorization. |
![]() |
string | The URL to which you must post the 3DS (3D Secure) data. This will redirect the customer. |
![]() |
string | The payment session identifier returned by the card issuer. |
![]() |
string | Transaction ID from payment processor. If received as part of an auth request, it must be retained for future settlement and match the value from the auth response. It should also be used for future recurring transaction auths/settlement. |
bill_contact_no | long | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. DEPRECATED |
bill_contact_no_2 | long | The Aria-assigned unique identifier for the contact on this account to be used as the billing contact for the payment method. If bill_contact_no is included in the API request, all other billing contact parameters are ignored. |
proc_fraud_filtering_info | array | The fraud filtering information provided by the payment processor as described below. |
![]() |
string | Fraud country status provided by the payment processor. |
![]() |
string | Fraud country code provided by the payment processor. |
Start of proc_3dsecure_auth_data array | ||
![]() |
array |
Array of 3D Secure processor-specific fields required for client-side integration. returned as proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are listed below. Note: Not all values for this field apply to all payment gateways. In addition, not all payment gateways support 3DS. The payment gateways documentation identifies payment gateways that support 3DS. Please contact your payment gateway representative for more information about which version of 3DS is supported and other details. |
proc_field_name | Field Type | proc_field_value |
![]() ![]() |
string | Returns true or false to indicate whether or not the 3DS authorization challenge is enabled for the card.2000 |
|
string | The unique number for a given authorization. |
![]() ![]() |
string | The URL where you must post the 3DS data to. This will redirect the customer. |
![]() ![]() |
string | The payment session identifier returned by the card issuer. |
![]() ![]() |
string | The client authorization token required to map the merchant account with the client JS SDK (JavaScript Software Development Kit). |
![]() ![]() |
string |
The single use token for the credit card. |
![]() ![]() |
string | The first six digits of the customer's card number. |
![]() ![]() |
string | Your JavaScript Library URL path used for 3DS 2.0. |
![]() ![]() |
string | The unique number for a given transaction. |
![]() ![]() |
string | The unique number for a given authorization. |
![]() ![]() |
string | This form action is used for a Direct Post call to decide whether to attempt device data collection or credit card authorization. |
![]() ![]() |
string | Method URL used for Device Fingerprint for 3DS 2.0 transactions. |
![]() ![]() |
string | Message/3DS version of the ongoing 3DS authorization. |
![]() ![]() |
string | If the issuer's Access Control Server (ACS) supports this feature, this field will receive content to populate the client’s form page to enable 3DS authentication. If the issuer’s ACS does not support this feature, no information for authentication will be returned to this field. |
![]() ![]() |
string | URL used for posting Device Fingerprint details for 3DS 2.0 transactions. |
![]() ![]() |
string | URL returned by your payment gateway, which is used for the 3DS authorization challenge for 3DS 2.0 transactions. |
End of proc_3dsecure_auth_data array | ||
Field Name | Field Type | Description |
processor_id | string | The Payment Processor ID used for external collection or authorization. |