authorize_electronic_payment_m
Summary
| API Name | authorize_electronic_payment_m |
|---|---|
| Class | account_services_m |
| Update Version | 33 |
Description
Authorizes a credit card for a specified amount. 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. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id |
||||||||||||||||||||||||||||||||||||||||
| amount | double | 12 | Yes |
The monetary amount of the electronic payment. |
||||||||||||||||||||||||||||||||||||||||
| payment_source | long | 32 | No |
Note: This field is deprecated. Aria no longer supports payment_source. |
||||||||||||||||||||||||||||||||||||||||
| CVV | string | 6 | No |
Card Verification Value, used to help verify a transaction is being requested by the card holder since this value is physically printed on the credit card. |
||||||||||||||||||||||||||||||||||||||||
| bill_seq | long | 22 | No |
The unique identifier of the bill sequence number. |
||||||||||||||||||||||||||||||||||||||||
| inTrackingNumber | string | 40 | No |
The XID used for 3DSecure if 3DSecure was used for this authorization |
||||||||||||||||||||||||||||||||||||||||
| inAuthValue | string | 40 | No |
The 3DSecure authorization value |
||||||||||||||||||||||||||||||||||||||||
| alt_client_acct_group_id | string | 100 | No |
One-time collections account group to use for this specific call. Default collections group on the account is not changed. |
||||||||||||||||||||||||||||||||||||||||
| track_data1 | string | 300 | No |
Raw "track 1" data from a swiped credit card used in a card-present transaction to initiate this request |
||||||||||||||||||||||||||||||||||||||||
| track_data2 | string | 300 | No |
Raw "track 2" data from a swiped credit card used in a card-present transaction to initiate this request |
||||||||||||||||||||||||||||||||||||||||
| alt_pay_method | long | 2 | No |
If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate credit card, enter '1' in this field. |
||||||||||||||||||||||||||||||||||||||||
| cc_number | string | 24 | No |
Credit card number. |
||||||||||||||||||||||||||||||||||||||||
| cc_expire_mm | long | 2 | No |
Expiration month for the credit card payment instrument. |
||||||||||||||||||||||||||||||||||||||||
| cc_expire_yyyy | long | 4 | No |
Expiration year for the credit card payment instrument. |
||||||||||||||||||||||||||||||||||||||||
| bank_routing_num | string | 22 | No |
The American Banking Association (ABA) routing number for the financial institution. |
||||||||||||||||||||||||||||||||||||||||
| bank_acct_num | string | 32 | No |
The bank account number. |
||||||||||||||||||||||||||||||||||||||||
| bank_acct_type | string | 32 | No |
The type of bank account being used. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||
| bill_company_name | string | 100 | No |
Company name of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_first_name | string | 32 | No |
First name of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_middle_initial | string | 2 | No |
Middle initial of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_last_name | string | 32 | No |
Last name of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_address1 | string | 100 | No |
First address line of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_address2 | string | 100 | No |
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 | No |
The third line of the billing address. |
||||||||||||||||||||||||||||||||||||||||
| bill_city | string | 32 | No |
City of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_locality | string | 32 | No |
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 | 10 | No |
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_zip | string | 16 | No |
Zip Code of the billing contact |
||||||||||||||||||||||||||||||||||||||||
| bill_country | string | 3 | No |
Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. |
||||||||||||||||||||||||||||||||||||||||
| bill_email | string | 320 | No |
Email of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_phone | string | 25 | No |
Phone number of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_phone_extension | string | 20 | No |
Phone extension of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_cell_phone | string | 20 | No |
Cell phone number of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_work_phone | string | 25 | No |
Work phone number of the billing contact. |
||||||||||||||||||||||||||||||||||||||||
| bill_work_phone_extension | string | 20 | No |
Work phone extenstion of the billing contact |
||||||||||||||||||||||||||||||||||||||||
| bill_drivers_license_no | string | 32 | No |
Drivers license number of the billing contact |
||||||||||||||||||||||||||||||||||||||||
| bill_drivers_license_state | string | 2 | No |
Drivers license state of the billing contact. The official postal-service codes for all United States and Canada states, provinces, and territories. |
||||||||||||||||||||||||||||||||||||||||
| bill_taxpayer_id | string | 32 | No |
Taxpayer ID of the billing contact |
||||||||||||||||||||||||||||||||||||||||
| record_cc_on_auth_failure | string | 5 | No |
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. If an authorization requires 3DSecure, this will automatically disable the credit card until a successful authorization is achieved using authorize_3dsecure_m. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||
| iban | string | 50 | No |
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 | No |
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 | No |
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 | No |
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 | No |
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 | No |
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 | No |
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. |
||||||||||||||||||||||||||||||||||||||||
| plan_instance_no | long | 22 | Yes |
The unique identifier of the master plan instance. Alternative required field: client_plan_instance_id, billing_group_no, or client_billing_group_id |
||||||||||||||||||||||||||||||||||||||||
| client_plan_instance_id | string | 100 | Yes |
The client-defined identifier of the master plan instance. Alternative required field: plan_instance_no, billing_group_no, or client_billing_group_id |
||||||||||||||||||||||||||||||||||||||||
| billing_group_no | long | 22 | Yes |
The unique identifier of the billing group. Alternative required field: plan_instance_no, client_plan_instance_id, or client_billing_group_id |
||||||||||||||||||||||||||||||||||||||||
| client_billing_group_id | string | 100 | Yes |
The client-defined identifier of the billing group. Alternative required field: plan_instance_no, client_plan_instance_id, or billing_group_no |
||||||||||||||||||||||||||||||||||||||||
| soft_descriptor | string | No |
Transaction description shown on the buyer's statement that displays a Merchant Name or Item Description typically. This field will be ignored if not supported/certified by the payment processor. |
|||||||||||||||||||||||||||||||||||||||||
| soft_descriptor_customer_service | string | No |
Transaction description shown on the buyer's statement that displays a City for Card Present transactions or a Phone Number for Card Not Present transactions. This field will be ignored if not supported/certified by the payment processor. |
|||||||||||||||||||||||||||||||||||||||||
| fraud_filter | long | 1 | No |
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:
|
||||||||||||||||||||||||||||||||||||||||
| fraud_control_fields | object | No |
List of key-value pair parameters to control Fraud Control. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||
| end_user_session_id | string | No |
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 | No |
IP address that was used for placing an online order. |
|||||||||||||||||||||||||||||||||||||||||
| end_user_browser_accept_header | string | No |
Browser Accept Header that was used for placing an online order. Some examples might include 'text/html,application/xhtmlxml,application/xml ;q=0.9,*/*;q=0.8'. |
|||||||||||||||||||||||||||||||||||||||||
| end_user_browser_agent | string | No |
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 | 1 | No |
This feature will return marketing information if your payment processor supports it and configured in Aria. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||
| perform_balance_inquiry | long | 1 | No |
When supported, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||
| recurring_processing_model_ind | long | 1 | No |
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:
|
||||||||||||||||||||||||||||||||||||||||
| attempt_3d_secure | string | No |
This will manually trigger a 3DSecure check if the payment gateway/ payment processor supports this feature. Allowed values:
|
|||||||||||||||||||||||||||||||||||||||||
| 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. |
|||||||||||||||||||||||||||||||||||||||||
| bill_agreement_id | string | 32 | No |
Unique ID of the bill agreement (also referred to as a token). |
||||||||||||||||||||||||||||||||||||||||
| cc_id | long | 2 | No |
A numeric code indicating the type of credit card. Allowed values:
|
||||||||||||||||||||||||||||||||||||||||
| client_acct_id | string | 50 | Yes |
Client-defined account identifier. Alternative required field: acct_no |
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:
|
||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||
| 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,*/*;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:
|
||||||||||||||||||||||||||||
| 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:
|
||||||||||||||||||||||||||||
| 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. |
|
| 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_fraud_filtering_info | object | No |
Fraud Filtering Response returned from 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_data | object | No |
The 3ds processor specific fields that are mostly required for client side integration. |
|
| processor_id | long | 3 | No |
The payment processor Id used for the external collection or authorization. |
| payment_method_no | long | 22 | No |
Aria-assigned sequence number for this payment method. |
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. |
proc_3dsecure_data fields
| Name | Type | Length | Required | Description | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| proc_3ds_field_name | string | 100 | No |
Processor specific field name. Allowed values:
|
||||||||||||||||||||||||||||||||||||
| proc_3ds_field_value | string | 4000 | No |
Processor specific field value. |