validate_payment_information_m
Table of contents
- Input Arguments
- Allowable Values for alt_pay_method
- Allowable Values For fraud_filtering_enabled
- Allowable Values For change_status_on_fraud_filtering_failure
- Allowable Values For change_status_on_fraud_filtering_review
- Allowable Values For change_mp_status_on_fraud_filtering_cc_prefix_failure
- Allowable Values For change_mp_status_on_fraud_filtering_cc_number_failure
- Allowable Values For change_mp_status_on_fraud_filtering_cc_issuing_country_failure
- Allowable Values For change_mp_status_on_fraud_filtering_cc_issuing_country_suspect
- Allowable Values For perform_marketing_insights_inquiry
- Allowable Values For perform_balance_inquiry
- Allowable Values For perform_card_type_detail_inquiry
- Output Arguments
Determines the validity of a card by performing an authorization transaction. The default authorization amount is 0 or 1 unit of currency (for example, 0 or $1 USD) depending on payment processor and card type. Please note: In order to use this call, your payment processor must support card authorizations.
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.
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. | ||||||||
 |
account_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. | |||||||||
|
seq_no | long | 8 | The unique bill sequence number. | ||||||||
| OR | ||||||||||||
| alt_pay_method | long | 2 |
If you want to use an existing form of payment, leave this field empty and enter the billing_group_no or sequence_no. If you want to use an alternate payment method, enter the appropriate value. Allowable Values for alt_pay_method
|
|||||||||
| OR | ||||||||||||
| billing_group_no | long | 22 | Billing group number | |||||||||
| OR | ||||||||||||
| client_billing_group_id | string | 100 | Client-defined unique identifier for billing group | |||||||||
| CVV | long | 6 | The CVV code for the payment method given | |||||||||
| inTrackingNumber | string | 40 | The XID used for 3DSecure if 3DSecure was used for this authorization | |||||||||
| inAuthValue | string | 40 | The 3DSecure authorization value | |||||||||
| cc_number | string | 24 | Card number. | |||||||||
| cc_expire_mm | long | 2 | Expiration month for the card payment instrument. | |||||||||
| cc_expire_yyyy | long | 4 | Expiration year for the card payment instrument. | |||||||||
| bill_company_name | string | 100 | Company name of the billing contact. | |||||||||
| bill_first_name | string | 32 | 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_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_city | string | 32 | 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_zip | string | 16 | Zip Code of the billing contact | |||||||||
| bill_country | string | 2 | Country of the billing contact. The ISO-compliant 2-character country code abbreviation in uppercase. | |||||||||
| bill_email | string | 320 | Email of the billing contact. | |||||||||
| bill_phone | string | 25 | Phone number of the billing contact. | |||||||||
| bill_phone_extension | string | 20 | 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_extension | string | 20 | Work phone extenstion of the billing contact | |||||||||
| currency_cd | string | 3 | The 3-character ISO-compliant currency code in lowercase for monetary values used in the context of this API method. By default, this is the default currency associated with the account, but can represent an alternate currency_cd. | |||||||||
| acct_group_no | long | 8 | The collections account group for this account | |||||||||
| OR | ||||||||||||
| client_acct_group_id | string | 100 | The client-assigned group ID | |||||||||
| bill_address3 | string | 100 | The third line of the billing address. | |||||||||
| alt_client_acct_group_id | string | 100 | One-time collections account group to use for this specific call. Default collections group on the account is not changed. | |||||||||
| track_data1 | string | 300 | Raw "track 1" data from a swiped card used in a card-present transaction to initiate this request | |||||||||
| track_data2 | string | 300 | Raw "track 2" data from a swiped card used in a card-present transaction to initiate this request | |||||||||
| 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. | |||||||||
| 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 | |||||||||
 qualifier_name |
string | 100 | Name of the field you want to associate with this API call. | |||||||||
| qualifier_value |
string | 100 | Corresponding value of the field you want to associate with this API call. | |||||||||
| End of optional_transaction_qualifiers array | ||||||||||||
| 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:
|
|||||||||
| 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 | |||||||||
 fraud_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. Allowable Values For fraud_filtering_enabled
|
|||||||||
| change_status_on_fraud_filtering_failure |
string | 100 | Indicates whether to change the status of the account or master plan instance(s) if:
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 For change_status_on_fraud_filtering_failure
|
|||||||||
| status_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. | |||||||||
| change_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. Allowable Values For change_status_on_fraud_filtering_review
|
|||||||||
| status_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. | |||||||||
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) Allowable Values For change_mp_status_on_fraud_filtering_cc_prefix_failure
|
|||||||||
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) | |||||||||
| change_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) Allowable Values For change_mp_status_on_fraud_filtering_cc_number_failure
|
|||||||||
| mp_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) | |||||||||
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) Allowable Values For change_mp_status_on_fraud_filtering_cc_issuing_country_failure
|
|||||||||
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) | |||||||||
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) Allowable Values For change_mp_status_on_fraud_filtering_cc_issuing_country_suspect
|
|||||||||
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 | ||||||||||||
| perform_marketing_insights_inquiry | long | 2 |
Returns marketing information if your payment processor support is and is configured in Aria. Allowable Values For perform_marketing_insights_inquiry
|
|||||||||
| perform_balance_inquiry | long | 1 |
When supported, this will provide a balance inquiry that reflects the current balance for prepaid cards and gift cards. Allowable Values For perform_balance_inquiry
|
|||||||||
| perform_card_type_detail_inquiry | long | 1 |
This feature will return marketing information if your payment processor supports it and configured in Aria. Allowable Values For perform_card_type_detail_inquiry
|
|||||||||
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. |
| proc_cvv_response | string | The processor return code from CVV validation. |
| proc_avs_response | string | Processor return code from address validation |
| proc_cavv_response | string | The processors return code for security validation. |
| proc_status_code | string | The processor status code |
| proc_status_text | string | The processors 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 |
| proc_fraud_filter_response | string | The fraud filtering information provided by the payment processor in response to a fraud filtering request. |
| proc_fraud_filtering_info | array | The fraud filtering information provided by the payment processor as described below. |
| proc_fraud_country_status |
string | Fraud country status provided by the payment processor. |
| proc_fraud_country_code |
string | Fraud country code provided by the payment processor. |
| proc_prepaid_indicator | string | Additional information passed back from processor identifying this card as a prepaid card (if available). |
| proc_prepaid_available_balance | long | Additional information passed back from processor for available balance on prepaid card (if available). |
| proc_prepaid_reloadable | string | Additional information passed back from processor identifying whether or not the prepaid card is reloadable (if available). |
| proc_prepaid_card_type | string | Additional information passed back from processor to categorize the type of prepaid card (if available). |
| proc_issuing_country | string | Additional information passed back from processor indicating issuing country for the card. |
| 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. |
| proc_signature_debit_ind | string | Additional information passed back from processor identifying this card as a signature debit card. |
| proc_pinless_debit_ind | string | Additional information passed back from processor identifying this card as PINless-debit-eligible. |
| proc_durbin_regulated_ind | string | Additional information passed back from processor identifying this card as Durbin Regulated. |
| proc_card_available_balance | string | Additional information passed back from processor for available balance on gift card if available. |
| proc_affluence_type | string | Additional information passed back from processor indicating if card is affluent. |
| collection_error_code | long | If a collection is attempted, returns the error code associated with the collection. |
| collection_error_msg | string | The error message associated with collection_error_code. |
- © Copyright 2023 Aria Developer Central