Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!


Home > Aria6 core api > authorize_3dsecure


Authorizes a credit or debit card if you specified that 3D Secure (3DS) is required for a particular transaction and the card is enrolled in 3DS. Example: an order over a particular amount that you specify. The 3DS authentication feature provides additional fraud prevention when transactions are processed. This feature requires account holders to provide additional information such as a password when they make an online purchase using a credit or debit card.

To use this API, you must have 3DS enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.

Note: This API call does not collect a payment.

3DS applies to Visa, Mastercard, American Express, Discover, and JCB (Japan Credit Bureau) for supported payment
. Please check your payment gateway documentation to find out the payment methods to which 3DS applies.

Example: to perform 3DS authentication, when an account holder makes a purchase with a credit or debit card:

  1. Use the inputs and outputs in any of the APIs listed below:


    Inputs and Outputs



    • Not all payment gateways require a value for the <attempt_3d_secure> field. Please check your payment gateway documentation to find out the requirements for 3DS. 
    • Not all payment gateways support the fraud protection features provided by the validate_acct_fraud_scoring API. Please check the list of supported features for your payment gateway for more information. 


    • <proc_payer_auth_request>
    • <proc_redirect_issuer_url>
    • <proc_md>

If the card is enrolled in 3DS and you specified that 3DS is required for the transaction, your payment gateway prompts the account holder to enter additional information for verification purposes.

  1. After the account holder enters the requested information, call authorize_3dsecure.
    The payment gateway then authorizes the payment.


Input Arguments

Req Field Name Field Type Max Length Description
client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.










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

Client-defined identifier for the account. This value is unique across all Aria-managed accounts.

  proc_payment_id string   Processor ID used to identify a transaction requiring 3D Secure authorization.
Please note that this field may also be an output that specifies a processor's payment ID.
  proc_payer_auth_response string   Processor's response received from a client's plugin that approved the transaction requiring 3D Secure authorization.
  end_user_session_id string 32 Processor's customer session identifier for a transaction requiring 3D Secure authorization.
  end_user_ip_address string   IP address used for placing an online order.
  proc_md string   Payment session identifier returned by the card issuer.
Start of proc_field_override array

Array of processor-specific fields.

  Field Name Field Type Max Length Description
   proc_field_name string 100 The name of the processor-specific field.
   proc_field_value string 1000 The value associated with the proc_field_name.
End of proc_field_override array

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" indicates no error.
bill_seq long The Aria-assigned bill sequence number.
proc_cvv_response string The processor return code from CVV (Card Verification Value) validation.
proc_avs_response string Processor return code from address validation.
proc_cavv_response string The processor return code for security validation.
proc_status_code string The processor status code.
proc_status_text string The processor status description.
proc_payment_id string The processor payment ID.
proc_auth_code string Authorization code provided by the issuing bank.
proc_merch_comments string Additional information passed to payment processor.
processor_id long The Payment Processor ID used for external collection or authorization.
Last modified


This page has no custom tags.


This page has no classifications.