validate_payment_information_m Guide
- Last updated
-
-
Save as PDF
Determines the validity of a credit 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 credit card authorizations.
|
API Specification:
|
validate_payment_information_m |
|
Required Fields:
|
- <client_no>
- <auth_key>
- <acct_no> or <client_acct_id>
- <seq_no> or <alt_pay_method>
- <billing_group_no> or <client_billing_group_no>
|
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.
- If you require $0 authorizations, you should use this API call rather than authorize_electronic_payment_m.
Input Fields
| Field Name |
Notes |
| <fraud_filter> |
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.
Allowable Values
| Values |
Description |
| 0 |
false (disable)
Note: If you set this field to 0, then Aria will ignore all other fraud filtering fields.
|
| 1 |
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.
|
| 2 |
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.
|
|
| <alt_pay_method> |
Allowable Values
| Values |
Description |
| 1 |
Credit card |
| 13 |
Tokenized Credit Card |
| 40 |
Merchant-Specific Gift Card |
|
| <fraud_filtering_enabled> |
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> |
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> |
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> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_number_failure> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_issuing_country_failure> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <change_mp_status_on_fraud_filtering_cc_issuing_country_suspect> |
Allowable Values
| Values |
Description |
| 0 |
false |
| 1 |
true |
|
| <perform_marketing_insights_inquiry> |
Allowable Values
| Values |
Description |
| NULL or -1 (Default) |
Use client-defined settings |
| 0 |
Do not return |
| 1 |
Return |
|
| <perform_balance_inquiry> |
Allowable Values
| Values |
Description |
| 0 (default) |
False, do not return card balance. |
| 1 |
True, do not return card balance. |
|
| <perform_card_type_detail_inquiry> |
Allowable Values
| Values |
Description |
| -1 |
Use Client Defined Settings (Default) |
| 0 |
Do Not Return |
| 1 |
Return |
|
Error Codes
| Error Code/Description |
Associated Inputs |
|
|
|
1004: authentication error
Associated Inputs: auth_key, client_id, client_no
|
<client_no>, <auth_key> |
1009: account does not exist, Account not found: AriaNo (acct_no), Account not found: Userid (userid), or Account not found: ClientId (client_acct_id)
Associated Inputs: acct_no, account_no, client_acct_id, user_id, userid, parent_acct_no
|
<account_no>, <client_acct_id> |
25020: Illegal characters entered
Associated Inputs: All character field inputs like firstname lastname, dunning_group_name, comments, etc.
|
<auth_key>, <inTrackingNumber>, <inAuthValue>, <cc_number>, <bill_company_name>, <bill_first_name>, <bill_middle_initial>, <bill_last_name>, <bill_address1>, <bill_address2>, <bill_city>, <bill_locality>, <bill_state_prov>, <bill_zip>, <bill_country>, <bill_email>, <bill_phone>, <bill_phone_extension>, <bill_cell_phone>, <bill_work_phone>, <bill_work_phone_extension>, <currency_cd>, <bill_address3>, <alt_client_acct_group_id>, <track_data1>, <track_data2>, <client_acct_group_id>, <client_billing_group_id>, <fraud_control_field_name>, <fraud_control_field_value client_acct_id>, <alt_caller_id>, <attach_qualifier_option>, <qualifier_name>, <qualifier_value> |
12001: Account group does not exist
Associated Inputs: group_no, acct_group_id
Additional Comments: An invalid seq_function group_id was entered.
|
<acct_group_no>, <alt_client_acct_group_id>, <client_acct_group_id> |
12010: Client account group does not exist
Associated Inputs: collections_acct_group_no, client_acct_group_id, alt_client_acct_group_id
|
<acct_group_no>, <alt_client_acct_group_id>, <client_acct_group_id> |
6004: validation not supported for this payment method
Associated Inputs: alt_pay_method, seq_no
Additional Comments: Only payment methods 1 and 13 are supported.
|
<alt_pay_method>, <seq_no> |
5007: invalid currency cd
Associated Inputs: currency_cd, Currency code of Threshold Billing Rule does not match Account. Rule: AriaNo ($AriaNo)
|
<currency_cd> |
6051: Invalid Billing sequence number.
Associated Input: seq_no
|
<seq_no> |
26010: Invalid billing group number
Associated Inputs: billing_group_no
|
<billing_group_no> |
26012: Invalid client-defined billing group ID.
Associated Inputs: client_billing_group_id
|
<client_billing_group_id> |
6003: could not validate billing information
Associated Inputs: pay_method_type, cc_auth_amount
Additional Comments: There was an error during the $1 authorization attempt.
|
|
