authorize_electronic_payment_m Guide

Last updated
Save as PDF

Authorizes a credit card for a specified amount. Please note: This API call does not collect a payment.

API Specification:	authorize_electronic_payment_m
Required Fields:	<client_no> <auth_key> <acct_no> or <client_acct_id> <amount> <plan_instance_no> or <client_plan_instance_id> or <billing_group_no> or <client_billing_group_id>

Error Codes

Click here.

Additional Guidance:

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.

Input Fields

Field Name:	Notes:
<amount>	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 <bill_seq>; or If the token was already generated outside of Aria, set the <alt_pay_method> to 13 and pass in the <bill_agreement_id>; or If you need to generate a token for the card, set the <alt_pay_method> to 13 and pass in the credit card details. Pass in the <amount> to be authorized. Optionally, pass a value into the <cc_id> field to identify the type of credit card you are authorizing. Optionally pass in a <recurring_processing_model_ind> to specify the kind of transaction you are completing. You can use the <recurring_processing_model_ind> field only for payment methods for which your payment gateway supports Cardholder Initiated Transaction?s (CIT) and Merchant Initiated Transactions (MIT). Please contact your payment gateway representative for more information.
<fraud_filter>	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. 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.
<transaction_type>	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). 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: value passed into this field collection group configuration payment gateway configuration transaction type that you specified in the <recurring_processing_model_ind> field

Output Fields

Field Name:	Notes:
<proc_3dsecure_data>	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.

Allowable Values:

Input Fields

Field Name:

Description:

<bank_acct_type>

The type of bank account being used.

Allowable values:

Values	Description
savings	savings
checking	checking
business	business

Field Name:

Description:

<record_cc_on_auth_failure>

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

Allowable values:

Values	Description
true	true
false	false

<cc_id>

A numeric code indicating the type of card.

Allowable values:

Values	Description
1	Visa
2	Mastercard
3	American Express
4	Discover
5	DIners Club/Carte Blanche
6	Maestro
7	JCB
8	Laser
9	Dankort

<fraud_filter>

Allowable values:

Values

Description

false (disable)

Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.

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.

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.

<fraud_filtering_enabled>

Indicates whether to send a request to the processor for fraud filtering information. If you set it to 0 (disable), then Aria will ignore all other fraud filtering fields.

Allowable values:

Values	Description
0	disable
1	enable
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_failure>

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.

Allowable values:

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_status_on_fraud_filtering_review>

Indicates whether to change the status of the account or master plan instance(s) if fraud_filtering_enabled is set to 1 (enable). Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

Allowable values:

Values	Description
0	false
1	true
-1	Use settings specified at the collection group or payment gateway level.

<change_mp_status_on_fraud_filtering_cc_prefix_failure>

Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card prefix. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

(applies to Direct Post)

Allowable values:

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_number_failure>

Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the the fraud filtering check for the credit card number. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

(applies to Direct Post).

Allowable values:

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_failure>

Indicates whether to change the status of the master plan instance(s) if the purchase transaction failed the fraud filtering check for the credit card issuing country. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

(applies to Direct Post)

Allowable values:

Values	Description
0	false
1	true

<change_mp_status_on_fraud_filtering_cc_issuing_country_suspect>

Indicates whether to change the status of the master plan instance(s) if the fraud filtering check for the credit card issuing country returned a "suspect" value. Set it to 1 (true) if you want to change the status. Set it to 0 (false) if you do not want to change the status.

(applies to Direct Post)

Allowable values:

Values	Description
0	false
1	true

<perform_marketing_insights_inquiry>

Returns marketing information if your payment processor support is and is configured in Aria.

Allowable values:

Values	Description
NULL or -1 (Default)	Use client-defined settings
0	Do not return
1	Return

<perform_balance_inquiry>

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

Allowable values:

Values	Description
0 (default)	False, do not return card balance
1	True, do not return card balance

<perform_card_type_detail_inquiry>

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

Allowable values:

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

<recurring_process_model_ind>

Defines a recurring payment type for Credit Card and Tokenized Credit Cards.

Allowable values:

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 nonrecurring charge (onetime order or plan upgrade) that uses a credit card that is currently stored in Aria.

<attempt_3d_secure>

This will manually trigger a 3DSecure check if the payment gateway/processor supports this feature (must be set to True for Worldline/Ingenico). To perform 3DS authentication, follow the instructions provided in the authorize_3dsecure_m API documentation..

Allowable values:

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

transaction_type

Allowable values:

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

<payer_auth_transaction_mode>

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

Allowable values:

Values	Description
M	MOTO (mail/telephone order)
R	Retail
S	eCommerce
P	Mobile Device
T	Tablet