update_payment_method_m

Last updated
Save as PDF
Share
1. Share
2. Tweet
3. Share

Summary

API Name	update_payment_method_m
Class	account_services_m
Update Version	56

Description

Updates or replaces a payment method on an account's billing group. Payment methods define how Aria collects payment for invoices — supported types include credit/debit cards, ACH/direct debit, tokenized payment methods, and net terms. Each billing group can have a primary and secondary (backup) payment method.

This API supports several operations:

Update payment details: Change the card number, expiration date, bank account, or other payment instrument details on an existing payment method by specifying the payment_method_no and providing new values.
Replace payment method type: Switch from one payment type to another (e.g., from credit card to ACH) by specifying a new pay_method_type with the corresponding payment details.
Update billing contact: Change the name, address, or other contact information associated with a payment method. You can provide new contact details inline or reference an existing contact on the account via bill_contact_no.
Disable a payment method: Permanently disable a payment method by setting disabled_ind to 1. Once disabled, a payment method cannot be re-enabled.
Update name/description: Change the display name or description label for a payment method.

To add a brand new payment method (rather than update an existing one), omit the payment_method_no — a new payment method will be created on the billing group. To retrieve existing payment methods, use get_acct_details_all_m. To validate a credit card before saving it, use validate_payment_information_m or authorize_electronic_payment_m.

Inputs

Name

Type

Length

Required

Description

client_no

long

Yes

Aria-assigned unique identifier indicating the Aria client providing service to this account.

auth_key

string

Yes

Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.

acct_no

long

Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

payment_method_no

long

Aria-assigned sequence number for this payment method.

client_payment_method_id

string

100

The client-defined billing primary payment method ID.

disabled_ind

long

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).

Allowed values:

Value	Description
0	Payment will remain enabled
1	Payment will be disabled

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.

bill_first_name

string

100

First name of the billing contact.

bill_middle_initial

string

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

Use this field instead of the state_prov field to designate 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 United States, Australia and Canada addresses.

bill_state_prov

string

State or Province of the billing contact. The official postal-service codes for all United States, Australia and Canada states, provinces, and territories. This field does not support states, provinces or territories from other countries. Use the locality field for other countries.

bill_country

string

Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase.

bill_postal_cd

string

Postal code for the billing contact.

bill_phone

string

Phone number of the billing contact.

bill_phone_ext

string

Phone extension of the billing contact.

bill_cell_phone

string

Cell phone number of the billing contact.

bill_work_phone

string

Work phone number of the billing contact.

bill_work_phone_ext

string

The work phone extension for the billing contact work phone.

bill_fax

string

Fax number of the billing contact.

bill_email

string

320

Email of the billing contact.

bill_birthdate

string

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

This is the method_id corresponding to a payment method such as credit card, Electronic Check, Pre-Paid, Net Terms, etc.

Allowed values:

Value	Description
-1	External Payment
1	Credit card
2	Electronic Check (ACH)
3	Pre-paid
4	Deprecated Net Terms 30 - use Payment Terms
5	Deprecated Net Terms 10 - use Payment Terms
6	Deprecated Net Terms 15 - use Payment Terms
7	Deprecated Net Terms 60 - use Payment Terms
8	Click&Buy
9	Deprecated Net Terms 0 - use Payment Terms
10	PayByCash
11	PayPal Express Checkout
12	Deprecated Net Terms 45 - use Payment Terms
13	Tokenized Credit Card
14	Purchase Power
15	Deprecated Net Terms 35 - use Payment Terms
16	Deprecated Net Terms 75 - use Payment Terms
17	Deprecated Net Terms 90 - use Payment Terms
18	Deprecated Net Terms 120 - use Payment Terms
19	Deprecated Net Terms 25 - use Payment Terms
20	NETS
26	Direct Debit
37	Tokenized Direct Debit
48	Tokenized ACH Payment
53	Tokenized BECS

cc_num

string

Credit card number.

cc_expire_mm

long

Expiration month for the credit card payment instrument.

cc_expire_yyyy

long

4-digit expiration year for the credit card payment instrument.

cvv

string

Card Verification Value, used to help verify a transaction is being requested by the card holder because this value is physically printed on the credit card.

bank_acct_num

string

The bank account number.

bank_routing_num

string

The American Banking Association (ABA) routing number for the financial institution.

bill_agreement_id

string

Unique ID of the bill agreement (also referred to as a token).

iban

string

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

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

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

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

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

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

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.

do_collect

string

If 'true', a collection is attempted after updating electronic billing information on accounts with outstanding balances.

Allowed values:

Value	Description
True
False

change_status_after_coll

string

Indicates whether the mpi status has to change after collection is completed.

Allowed values:

Value	Description
0	Do not reset the MPI status to active.
1	Reset the MPI status to active when its current status is any non-active status.
2	Reset the MPI status to active only when its current status "Suspended" (default).
3	Reset the MPI status to active only when its current is either "Suspended" or "Terminated".

reset_dates_after_status

string

If 'true', resets the billing dates after an account status change.

Allowed values:

Value	Description
True
False

client_receipt_id

string

Client-defined unique identifier used to track related system actions

cc_id

long

A numeric code indicating the type of credit card.

Allowed values:

Value	Description
1	Visa
2	MasterCard
3	American Express
4	Discover
5	Diners Club/Carte Blanche
6	Maestro
7	JCB
8	Laser
9	Dankoort

cc_auth_amount

double

For non-tokenized credit 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 Credit Card Update' client parameter is configured. When cc_auth_amount is not provided, the 'Perform Authorization Request on Credit Card Update' client parameter will determine whether or not a $1 authorization will be attempted when saving a new credit 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.

disable_existing_on_update

string

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.

Allowed values:

Value	Description
True
False

fraud_filter

long

Enable Fraud Filtering. This is supported if your payment processor supports this feature and has been certified with Aria. If no values are provided, the system will default to 2.

Allowed values:

Value	Description
0	False. Fraud Filtering and status update will not be performed on the transaction.
1	True. Fraud Filtering and status update on the transaction will be performed based on the API supplied fraud_control_fields. Collection group level or Payment Gateway level fraud control parameters will not be considered for the status update.
2	True. Fraud Filtering and status update on the transaction will be performed based on the API input and Collection Group/Payment Gateway level parameters. fraud_control_fields will be merged with API Inputs and Collection Group/Payment Gateway level values with the precedence of API inputs.

fraud_control_fields

object

List of key-value pair parameters to control Fraud Control.

See fields below

Allowed values:

Value	Description
fraud_filtering_enabled	This is a feature that some payment processors provide that will return fraud filtering results. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_filtering_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_filtering_failure	This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_failure if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_failure	This should only be set if change_status_on_fraud_filtering_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_filtering_review	This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_review if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_review	This should only be set if change_status_on_fraud_filtering_review is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_prefix_failure	This is a flag that indicates that the master plan instance status should be changed if the CC Prefix Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_prefix_failure	This should only be set if change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_number_failure	This is a flag that indicates that the master plan instance status should be changed if the CC Number Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_number_failure	This should only be set if change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_failure	This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_failure	This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect	This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process returned a "suspect" value. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_suspect	This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
fraud_scoring_enabled	This is a feature that some payment processors provide that will return a fraud score. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_scoring_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_scoring_failure	This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_scoring_failure if set to 1 (True) and the fraud_scoring_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_failure	This should only be set if change_status_on_fraud_scoring_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_scoring_review	This is a flag that indicates that the master plan instance status should be changed if a fraud scoring enabled was performed and "review" was returned as part of the fraud score result. Set it to 1 (True) if changing the master plan instance status is desired. The allowed values are 1 (True), 0 (False) and -1 (Use Collection Group/Payment Gateway Setting). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_review	This should only be set if change_status_on_fraud_scoring_review is set to 1 (True). This must be a valid Aria master plan instance status code. Aria master plan instance status codes can be found in the API documentation.
fraud_scoring_threshold	This is a feature that some payment processors provide that will return a fraud score as a numeric value. Aria must be certified with that particular payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If the payment processor returns non-numeric fraud score responses, Aria will ignore this threshold. As of now it is not supported for Vantiv processor.

include_auth_results

long

When set to 1, the API will return any authorization attempt results in addition to the collection attempt results in the collection_info output array.

Allowed values:

Value	Description
0	do not return authorization attempt results (default)
1	return authorization attempt results

end_user_session_id

string

This is a value that can be populated to identify an end user's shopping session that is often used to determine if 3DSecure authorization is required. Please note that this field is ignored if the payment gateway / payment processor configuration in Aria does not support this feature.

end_user_ip_address

string

IP address that was used for placing an online order.

end_user_browser_accept_header

string

Browser Accept Header that was used for placing an online order. Some examples might include 'text/html,application/xhtml+xml,application/xml ;q=0.9,&ast;/&ast;;q=0.8'.

end_user_browser_agent

string

Browser that was used for placing an online order. Some examples might include "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".

perform_card_type_detail_inquiry

long

This feature will return marketing information if your payment processor supports it and configured in Aria.

Allowed values:

Value	Description
-1	Use Client Defined Settings (Default)
0	Do Not Return
1	Return

perform_balance_inquiry

long

When supported, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards.

Allowed values:

Value	Description
0	False (Default)
1	True

new_client_payment_method_id

string

100

Specifies new client-defined unique identifier for payment method.

recurring_processing_model_ind

long

Defines a recurring payment type for Credit Card and Tokenized Credit Cards. A null value will default to 0 - Cardholder-Initiated Transaction - Credentials on File.

Allowed values:

Value	Description
0	Cardholder-Initiated Transaction - Credentials on File: a credit card transaction initiated by the cardholder for a new order or a plan upgrade that uses a credit card that is currently stored in Aria.
1	Cardholder-Initiated Transaction: a credit card transaction initiated by the cardholder for a new account or creating an order that uses an alternate credit card that is not currently stored in Aria.
2	Merchant-Initiated Transaction - Standing Instruction - Recurring: a credit card transaction initiated by Aria's clients for a recurring charge that uses a credit card that is currently stored in Aria.
3	Merchant-Initiated Transaction - Unscheduled Credentials on File: a credit card transaction initiated by Aria's clients for a non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.

attempt_3d_secure

string

This will manually trigger a 3DSecure check if the payment gateway/ payment processor supports this feature.

Allowed values:

Value	Description
Null	This will let processor to dynamically decide whether 3DS is required based on their rules (default)
True	Attempt 3DS authentication
False	Do not attempt 3DS authentication

proc_field_override

array

The processor-specific fields passed as an array of proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are highlighted in blue below.

See allowable proc_field_names

disable_pmt_method_on_auth_failure

string

If passed, and 'true', and the authorization fails, the card is added to the account with disabled_ind to 1 to indicate the card is disabled.

Allowed values:

Value	Description
True
False

bank_name

string

100

Bank name for the account payment method

bank_city

string

100

Bank city for the account payment method

alt_collection_acct_group_no

long

The alternate collection account group number used to perform authorization or collection

Alternative field: alt_client_collection_acct_group_id

alt_client_collection_acct_group_id

string

100

The alternate client defined collection account group id used to perform authorization or collection

Alternative field: alt_collection_acct_group_no

client_acct_id

string

Yes

Client-defined account identifier.

Alternative required field: acct_no

billing_group_no

long

The unique identifier of the billing group.

Alternative field: client_billing_group_id, master_plan_instance_no, or client_master_plan_instance_id

client_billing_group_id

string

100

The client-defined identifier of the billing group.

Alternative field: billing_group_no, master_plan_instance_no, or client_master_plan_instance_id

master_plan_instance_no

long

The unique identifier of the master plan instance.

Alternative field: billing_group_no, client_billing_group_id, or client_master_plan_instance_id

client_master_plan_instance_id

string

100

The client-defined identifier of the master plan instance.

Alternative field: billing_group_no, client_billing_group_id, or master_plan_instance_no

bank_acct_type

string

The type of bank account being used.

Allowed values:

Value	Description
savings
checking
business

bank_acct_holder_type

string

This field denotes the bank account holder type. The value can be either individual or company.

Allowed values:

Value	Description
individual
company

mandate_signature_date

string

The date, in yyyy-mm-dd format, on which the mandate was signed.

payment_method_verification_code

string

1000

The code provided by the account validator.

emandate_signature

string

1000

This is the electronic signature returned after successfully completing an e-mandate request through an e-Mandate service.

fraud_control_fields fields

Name	Type	Length	Required	Description
fraud_control_field_name	string	100	No	List of Fraud Control field names.
fraud_control_field_value	string	100	No	List of Fraud Control field values.

proc_field_override fields

proc_field_name

proc_field_value

transaction_type

Defines a transaction type for Credit Cards and Tokenized Credit Cards. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of transaction types, please read our documentation.

Allowed values:

proc_field_value	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.
1	(Chase) Single Transaction mail/telephone order (MOTO) - Designates a transaction where the accountholder is not present at a merchant location and consummates the sale via the phone or through the mail. The transaction is not for recurring services or product and does not include sales that are processed via an installment plan.
2	(Chase) 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	(Chase) Installment Transaction - Designates a group of transactions that originated from a single purchase where the merchant agrees to bill the accountholder in installments.
4	(Chase) Deferred Transaction - Designates a transaction that represents an order with a delayed payment for a specified amount of time.
5	(Chase) Secure Electronic Commerce Transaction - Designates a transaction consummated via the Internet at a 3-D Secure capable merchant and the accountholder is fully authenticated. (e.g. 3-D Secure includes Verified by Visa, Mastercard Identity Check, American Express SafeKey and Discover ProtectBuy).
6	(Chase) Non-Authenticated Electronic Commerce Transaction - Designates a transaction consummated via the Internet at a 3-D Secure capable merchant that attempted to authenticate the accountholder using 3-D Secure (e.g. 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 Issue * A non-participating accountholder of a participating Issuer * A participating Issuer, but the authentication server is not available
7	(Chase) Channel Encrypted Transaction - Designates a transaction between an accountholder and a merchant consummated via the Internet where the transaction includes the use of transaction encryption such as SSL, 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 but not using ProtectBuy for Cardholder authentication.
8	(Chase) Non-Secure Electronic Commerce Transaction - Designates a transaction between an accountholder and a merchant consummated 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	(Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder consummates the sale via an interactive voice response (IVR) system.
R	(Chase) Retail Transaction - Designates a transaction where the accountholder was present at a merchant location.
telephone	(Vantiv) The transaction is for a single telephone order.
mailorder	(Vantiv) The transaction is for a single mail order transaction.

client_3ds_nonce

The 3ds enriched nonce used for the card authorization.

payer_auth_reference_id

Reference id for 3ds transaction session.

payer_auth_transaction_mode

The transaction mode identifies the channel from which the transactions are originated of Cybersource 3ds 2.0.

Allowed values:

proc_field_value	Description
M	MOTO
R	Retail
S	eCommerce
P	Mobile Device
T	Tablet

payer_auth_transaction_id

Authentication Transaction id for 3ds authorization.

end_user_browser_accept_header

Browser Accept Header that was used for placing an online order. Some examples might include 'text/html,application/xhtml+xml,application/xml ;q=0.9,&ast;/&ast;;q=0.8'.

end_user_browser_agent

Browser that was used for placing an online order. Some examples might include "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".

end_user_browser_color_depth

Browser color depth in bits per pixel. This should be obtained by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth.

end_user_browser_java_enabled_ind

Boolean value indicating if the shopper's browser is able to execute Java.

end_user_browser_language

Browser supported language(as defined in IETF BCP 47). This should be obtained by using the browser's navigator.language property.

end_user_browser_screen_height

Browser total height that was used for placing an online order.

end_user_browser_screen_width

Browser total width that was used for placing an online order.

end_user_browser_timezone_offset_mins

Time difference between UTC time and the shopper's browser local time, in minutes.

pa_3ds_completion_ind

In Adyen, for 3DS v2.0 transaction, if the response of DDC is received within 10sec set this to 'Y', else set this to 'N'.

pa_3ds_trans_status

In Adyen, for 3DS v2.0 transaction, if the response of Challenge Shopper is NOT received within 10mins set this to 'U', else set the value from Challenge shopper response.

pa_3ds_termination_url

Termination url for 3DS transaction.

pa_machine_id

HTTP cookie to be used in the HTTP header for Worldpay 3DS transaction.

sca_exemption_type

Defines a exemption type indicator for 3D secure transactions. Depending upon the exemption reason, it can bypass Strong Customer Authentication. If a value is not entered, it will default to your client configuration settings. Please note that the values differ per processor. For a list of exemption types, please read our documentation. (values: -1 - Use client configuration settings for determining the exemption type. 0 - Transaction will be performed with no exemption. 1 - (Chase) Transaction will be performed with low value exemption.)

mandate_collection_method

Use this field to specify how the customer will authorize the mandate for direct debit collection. It is required for ACH, SEPA, and BACS. If the the mandate is collected online, the customer IP address and useragent must be collected and passed in the collection API. If offline, you must collect and maintain the authorization in your records. This is applicable for Stripe Payment Processor.

Allowed values:

proc_field_value	Description
0	Offline - Default
1	Online

end_user_ip_address

IP address that was used for placing an online order.

end_user_browser_agent

Browser that was used for placing an online order. Some examples might include "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".

bank_acct_holder_type

The type of entity that holds the account. This is applicable for Stripe Payment Processor.

Allowed values:

proc_field_value	Description
I	This bank account belongs to an individual
C	This bank account belongs to a company

kount_session_id

kount_session_id is a unique identifier generated by Kount, a fraud prevention and risk management platform for Evertec.

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error.
error_msg	string		No	Description of any error that occurred. "OK" if there was no error.
seq_no	long		No	The sequence number of this payment, as it appears on the account
collection_info	object		No	A multidimensional array of collection information of master plan instance. See fields below
bill_contact_no	long	22	No	Note: This field is deprecated. Aria no longer supports bill_contact_no.
proc_fraud_filtering_info	object		No	Fraud Filtering Response returned from Payment processor. See fields below
bill_contact_no_2	long	22	No	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.
cc_auth_details	object		No	Collection group and processor details when there is a cc auth or validation failure. See fields below

collection_info.proc_3dsecure_auth_data fields

Name

Type

Length

Required

Description

proc_3ds_field_name

string

100

Processor specific field name.

Allowed values:

Value	Description
attempt_3ds_auth_challenge	The flag represents the 3DS authorization challenge in enabled.
payer_auth_request	The unique number for a given authorization.
redirect_issuer_url	The URL where you must post the 3DS data to. This will redirect the shopper.
md	The payment session identifier returned by the card issuer.
client_auth_token	The client authorization token required to map the merchant account with the client JS SDK.
cc_single_use_token	The single use token for credit card.
cc_prefix	The first 6 digit of the credit card number.
pa_3ds_js_lib_url	The Client JS Library URL path used for Cybersource 3ds 2.0.
payer_auth_transaction_id	Authentication Transaction id for 3ds authorization.
payer_auth_reference_id	Reference id for 3ds transaction session.
pa_3ds_form_action	This form action is used for Direct post call to decide on attempting the device data collection or CCA
pa_3ds_df_method_url	Method URL used for Device Fingerprint for 3DS v2.0 transaction.
pa_3ds_message_version	Message/3DS version of the ongoing 3DS authorization.
pa_3ds_df_post_url	URL used for posting Device Fingerprint details for 3DS v2.0 transaction.
pa_3ds_cs_post_url	URL returned by processor which is used for Challenge Shopper for 3DS v2.0 transaction.
pa_3ds_form_content	Form content returned by processor which is used for Challenge Shopper for Chase 3DS transaction.
pa_machine_id	HTTP cookie to be used in the HTTP header for Worldpay 3DS transaction.

proc_3ds_field_value

string

4000

Processor specific field value.

collection_info.proc_bg_payment_response_field_list fields

Name

Type

Length

Required

Description

proc_payment_response_field_name

string

100

Field name of various response returned by the processor, example: micro_deposit_verify_url.

Allowed values:

Value	Description
micro_deposit_verify_url	The URL returned by the processor to share with the customer to validate their bank information and perform the micro deposits.

proc_payment_response_field_value

string

4000

Field value for the corresponding payment response field, example: Actual URL to be used for the micro deposit verification.

collection_info fields

Name	Type	Length	Required	Description
collection_error_code	long		No	If a collection is attempted, returns the error code associated with the collection.
collection_error_msg	string		No	The error message associated with collection_error_code.
bill_group_no	long		No	Aria-assigned bill group number
client_bill_group_id	string		No	Specifies Client-defined ID for bill group
proc_cvv_response	string		No	The processor return code from CVV validation.
proc_avs_response	string		No	Processor return code from address validation
proc_cavv_response	string		No	The processors return code for security validation.
proc_status_code	string		No	The processor status code
proc_status_text	string		No	The processors status description
proc_payment_id	string		No	Payment Gateway / Payment Processor ID used to identify the transaction requiring 3DSecure authorization. Please note that this field is used in other places to identify a particular ID for payment gateway orders and 3DSecure transactions.
proc_auth_code	string		No	Authorization code provided by the issuing bank
proc_merch_comments	string		No	Additional information passed to payment processor
proc_payer_auth_request	string		No	The unique number for a given authorization.
proc_redirect_issuer_url	string		No	The URL where you must post the 3DS data to. This will redirect the shopper.
proc_md	string		No	The payment session identifier returned by the card issuer.
proc_card_available_balance	double		No	Additional information passed back from processor for available balance on prepaid, gift card, and in some cases credit cards, if available.
proc_prepaid_ind	string		No	Additional information passed back from processor identifying this card as a prepaid card (if available).
proc_prepaid_reloadable	string		No	Additional information passed back from processor identifying whether prepaid card is reloadable (if available).
proc_prepaid_card_type	string		No	Additional information passed back from processor to categorize the type of prepaid card (if available).
proc_affluence_type	string		No	Additional information passed back from processor indicating if card is affluent.
proc_issuing_country	string		No	Additional information passed back from processor indicating issuing country for the card.
proc_card_product_type	string		No	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.
proc_signature_debit_ind	string		No	Additional information passed back from processor identifying this card as a signature debit card.
proc_pinless_debit_ind	string		No	Additional information passed back from processor identifying this card as PINless debit eligible.
proc_durbin_regulated_ind	string		No	Additional information passed back from processor identifying this card as Durbin Regulated.
proc_initial_auth_txn_id	string	100	No	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.
proc_3dsecure_auth_data	object		No	The 3ds processor specific fields that are mostly required for client side integration. See fields below
processor_id	long	3	No	The payment processor Id used for the external collection or authorization.
proc_bg_payment_response_field_list	object		No	Payment response fields returned by the processor for further actions if any. See fields below
collection_payment_method_no	long		No	The payment method sequence no for the payment attempted during collection.

proc_fraud_filtering_info fields

Name	Type	Length	Required	Description
proc_fraud_country_status	string	100	No	Fraud country status provided by the Payment processor.
proc_fraud_country_code	string		No	Fraud country code provided by the Payment processor.

cc_auth_details fields

Name	Type	Length	Required	Description
collection_group_no	long	22	No	Collection Group number.
collection_group_name	string	100	No	Collection Group Name.
processor_id	long	22	No	Payment Processor Id.
processor_name	string	100	No	Payment Processor Name.