Summary

API Name	authorize_3dsecure_m
Class	account_services_m
Update Version	14.0

Description

Authorizes a credit card for a specified amount when 3DSecure is required. Please note: This API call does not collect a payment.

Inputs

Name	Type	Length	Required	Description
client_no	long	22	Yes	Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key	string	32	No	Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no	long	22	Yes	Aria-assigned account identifier. Alternative required field: client_acct_id
client_acct_id	string	50	Yes	Client-defined identifier for the account. This value is unique across all Aria-managed accounts. Alternative required field: acct_no
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_payer_auth_response	string		No	Payment Gateway / Payment Processor Response received from a merchant plugin that authorized the transaction requiring 3DSecure authorization.
end_user_session_id	string		No	Payment Gateway / Payment Processor Shopper Session Identifier used to identify the transaction requiring 3DSecure authorization.
end_user_ip_address	string		No	IP address that was used for placing an online order.
proc_md	string		No	Payment session identifier that was returned by the card issuer.
proc_field_override	array		No	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

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.
payment_method_no	long	22	No	Aria-assigned sequence number for this payment method.
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	The processor payment ID
proc_auth_code	string		No	Authorization code provided by the issuing bank
proc_merch_comments	string		No	Additional information passed to payment processor
processor_id	long	3	No	The payment processor Id used for the external collection or authorization.
proc_3dsecure_data	object		No	The 3ds processor specific fields that are mostly required for client side integration. See fields below
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_data fields

Name

Type

Length

Required

Description

proc_3ds_field_name

string

100

No

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

No

Processor specific field value.