Home > Aria Crescendo Documentation > Aria Crescendo core api > update_payment_method_m

update_payment_method_m

This API allows you to update payment method-related information associated with an account. This information includes:
  • Billing Contact Information: Update, or completely replace, the billing contact associated with a payment method. You can either specify new contact information; or, replace the contact information with another contact already associated with the account, specified by a bill_contact_no.
  • Payment Method: You can update or replace a payment method by specifying a pay_method_type, then supplying the new payment method information.
  • Payment Method Name and Description: When updating or replacing a payment method as described above, you can also replace the Payment Method Name and/or Description.

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.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png 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.
  billing_group_no long 22 The unique identifier of the billing group.
  client_billing_group_id string 100 The client-defined identifier of the billing group.
  master_plan_instance_no long 22 The unique identifier of the master plan instance.
  client_master_plan_instance_id string 100 The client-defined identifier of the master plan instance.
  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).  
Values Description
0 Payment will remain enabled
1 Payment will be disabled
  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.

Values Description
-1 External Payment
1 Credit card
2 Electronic Check (ACH)
3 Pre-paid
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
26 Direct Debit
37 Tokenized Direct Debit
40 Merchant-Specific Gift Card
  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.  
Values Description
true true
false false
  change_status_after_coll string 5 Indicates whether the account status is to change after collection is completed.  
Values 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 5 If 'true', resets the billing dates after an account status change.  
Values Description
true true
false false
  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 for cc_id

Values Description
1 Visa
2 MasterCard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankort
10 Aura
11 ELO
12 Hipercard
13 UnionPay Express Pay
Note: <cc_id> is sometimes a required field when using payment method 13, Tokenized Credit Card, as the <pay_method_type> field for certain payment processors as defined in the internal Aria processor pay methods table.
  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:

  • For the Braintree payment gateway, complete the required Aria configuration fields.
  • For the Worldpay payment gateway, first add the client_acct_id to the account as described in the Worldpay configuration notes.

Do one of the following:

  • If the card has already been added to the account, pass in the <payment_method_no>; or
  • If the token was already generated outside of Aria, set the <pay_method_type> to 13 and pass in the <bill_agreement_id>; or
  • If you need to generate a token for the card, set the <pay_method_type> to 13 and pass in the credit card details.
  • Pass in the <cc_auth_amount> to be authorized.

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.  
Values Description
true true
false false
  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
  brd_arrow.gif qualifier_name string 100 Name of the field you want to associate with this API call.
  brd_arrow.gif qualifier_value 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:

  • 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 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.
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 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.
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
  brd_arrow.giffraud_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.
Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifchange_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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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 master plan instance.
  brd_arrow.gifchange_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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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 master plan instance.
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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)
  brd_arrow.gifchange_mp_status_on_fraud_filtering_cc_number_failure 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)
Values Description
0 false
1 true
  brd_arrow.gifmp_status_on_fraud_filtering_cc_number_failure 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)
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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)
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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.
Values Description
NULL or -1 (Default) Use client-defined settings
0 Do not return
1 Return
  perform_balance_inquiry long 1 When supported, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards.
Values Description
0 (default) False, do not return card balance.
1 True, do not return card balance.
  perform_card_type_detail_inquiry long 1 This feature will return marketing information if your payment processor supports it and configured in Aria.
Values Description
-1 Use Client Defined Settings (Default)
0 Do Not Return
1 Return
  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.

 

Values 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. (Default)
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/processor supports this feature.

To perform 3DS authentication, follow the instructions provided in the authorize_3dsecure_m API documentation.

Values 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.
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.
    brd_arrow.gif proc_field_name string 100 List of processor field names
    brd_arrow.gif proc_field_value string 1000 List of processor field values
  proc_field_name Field Type Max Length proc_field_value
    brd_arrow.gif transaction_type 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:

  • 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/Vantiv > Gateway Options; and
    • Configuration > Payments > Collection Groups > Chase Paymentech/Vantiv > Collection Group Options.
  • Currently, only Chase Paymentech and Vantiv support 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:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. transaction type that you specified in the <recurring_processing_model_ind> field
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 (Chase) 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 (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 payment delayed for a specified amount of time.
5 (Chase) 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 (Chase) 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 (Chase) 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 (Chase) 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 (Chase) IVR Transaction (PINless Debit only) - Designates a transaction where the accountholder completes 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.
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.
 

brd_arrow.gif payer_auth_reference_id

 string 2000 Reference ID for a 3DS transaction session.
  brd_arrow.gif payer_auth_transaction_mode string 1

The transaction mode identifies the channel from which the 3DS transactions are originated.

Values Description
M MOTO (mail/telephone order)
R Retail
S eCommerce
P Mobile Device
T Tablet
  brd_arrow.gif payer_auth_transaction_id string 2000 Authentication transaction ID for a 3DS authorization.
  brd_arrow.gif end_user_browser_accept_header string 2000 Browser accept header that was used for making a purchase online.  Example: "text/html,application/xhtml+xml,application/xml ;q=0.9,&ast;/&ast;;q=0.8".      
  brd_arrow.gif end_user_browser_agent 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".         
  brd_arrow.gif end_user_browser_color_depth 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.            
  brd_arrow.gif end_user_browser_java_enabled_ind string 2000 Boolean value indicating whether the customer's browser is able to execute Java.
  brd_arrow.gif end_user_browser_language 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.            
  brd_arrow.gif end_user_browser_screen_height string 2000 Total height of the browser that was used for placing an online order.
  brd_arrow.gif end_user_browser_screen_width string 2000

Total width of the browser that was used for placing an online order.
  brd_arrow.gif end_user_browser_timezone_offset_mins string 2000 Difference between UTC (Universal Time Coordinated) time and the customer's browser local time, in minutes.
  brd_arrow.gif pa_3ds_completion_ind 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".           
  brd_arrow.gif pa_3ds_trans_status 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.

Values Description
false (default) Disable a payment method after a failed card authorization.
true Enable a payment method after a failed card authorization.

 

Output Arguments

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.
brd_arrow.gif collection_error_code long If a collection is attempted, returns the error code associated with the collection.
brd_arrow.gif collection_error_msg string The error message associated with collection_error_code.
brd_arrow.gif bill_group_no long Aria-assigned bill group number
brd_arrow.gif client_bill_group_id string Specifies Client-defined ID for bill group
brd_arrow.gif proc_cvv_response string The processor return code from CVV validation.
brd_arrow.gif proc_avs_response string Processor return code from address validation
brd_arrow.gif proc_cavv_response string The processors return code for security validation.
brd_arrow.gif proc_status_code string The processor status code
brd_arrow.gif proc_status_text string The processors status description
brd_arrow.gif proc_payment_id string The processor payment ID
brd_arrow.gif proc_auth_code string Authorization code provided by the issuing bank
brd_arrow.gif proc_merch_comments string Additional information passed to payment processor
brd_arrow.gif proc_card_available_balance double Additional information passed back from processor for available balance on prepaid, gift card, and in some cases cards, if available.
brd_arrow.gif proc_prepaid_ind string Additional information passed back from processor identifying this card as a prepaid card (if available).
brd_arrow.gif proc_prepaid_reloadable string Additional information passed back from processor identifying whether prepaid card is reloadable (if available).
brd_arrow.gif proc_prepaid_card_type string Additional information passed back from processor to categorize the type of prepaid card (if available).
brd_arrow.gif proc_affluence_type string Additional information passed back from processor indicating if card is affluent.
brd_arrow.gif proc_issuing_country string Additional information passed back from processor indicating issuing country for the card.
brd_arrow.gif proc_card_product_type 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.
brd_arrow.gif proc_signature_debit_ind string Additional information passed back from processor identifying this card as a signature debit card.
brd_arrow.gif proc_pinless_debit_ind string Additional information passed back from processor identifying this card as PINless-debit-eligible.
brd_arrow.gif proc_durbin_regulated_ind string Additional information passed back from processor identifying this card as Durbin Regulated.
brd_arrow.gif proc_payer_auth_request string The unique number for an authorization.
brd_arrow.gif proc_redirect_issuer_url string The URL to which you must post the 3DS (3D Secure) data. This will redirect the customer.
brd_arrow.gif proc_md string The payment session identifier returned by the card issuer.
brd_arrow.gif proc_initial_auth_txn_id 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.
brd_arrow.gifproc_fraud_country_status string Fraud country status provided by the payment processor.
brd_arrow.gifproc_fraud_country_code string Fraud country code provided by the payment processor.
Start of proc_3dsecure_auth_data array
 brd_arrow.gif proc_3dsecure_auth_data 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
  brd_arrow.gifbrd_arrow.gif attempt_3ds_auth_challenge string Returns true or false to indicate whether or not the 3DS authorization challenge is enabled for the card.2000

  brd_arrow.gifbrd_arrow.gif payer_auth_request

 string  The unique number for a given authorization.
  brd_arrow.gifbrd_arrow.gif redirect_issuer_url string The URL where you must post the 3DS data to. This will redirect the customer.
  brd_arrow.gifbrd_arrow.gif md string The payment session identifier returned by the card issuer.
  brd_arrow.gifbrd_arrow.gif client_auth_token     string  The client authorization token required to map the merchant account with the client JS SDK (JavaScript Software Development Kit).
  brd_arrow.gifbrd_arrow.gif cc_single_use_token string

The single use token for the credit card.
  brd_arrow.gifbrd_arrow.gif cc_prefix string The first six digits of the customer's card number.
  brd_arrow.gifbrd_arrow.gif pa_3ds_js_lib_url string Your JavaScript Library URL path used for 3DS 2.0.
  brd_arrow.gifbrd_arrow.gif payer_auth_transaction_id string The unique number for a given transaction.
  brd_arrow.gifbrd_arrow.gif payer_auth_reference_id string The unique number for a given authorization.
  brd_arrow.gifbrd_arrow.gif pa_3ds_form_action string This form action is used for a Direct Post call to decide whether to attempt device data collection or credit card authorization.
  brd_arrow.gifbrd_arrow.gif pa_3ds_df_method_url string Method URL used for Device Fingerprint for 3DS 2.0 transactions.
  brd_arrow.gifbrd_arrow.gif pa_3ds_message_version string Message/3DS version of the ongoing 3DS authorization.
  brd_arrow.gifbrd_arrow.gif pa_3ds_form_content 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.
  brd_arrow.gifbrd_arrow.gif pa_3ds_df_post_url string URL used for posting Device Fingerprint details for 3DS 2.0 transactions.
  brd_arrow.gifbrd_arrow.gif pa_3ds_cs_post_url 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.
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®