Skip to main content
Aria Knowledge Central

validate_payment_information_m

Summary

API Name validate_payment_information_m
Class account_services_m
Update Version 33

Description

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.

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.

account_no long 22 Yes

Aria-assigned account identifier. This value is unique across all Aria-managed accounts.

Alternative required field: client_acct_id

CVV long 6 No

The CVV code for the payment method given

seq_no long 8 Yes

The unique bill sequence number.

Alternative required field: alt_pay_method, billing_group_no, or client_billing_group_id

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_pay_method long 2 Yes

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.

Alternative required field: seq_no, billing_group_no, or client_billing_group_id

Allowed values:

Value Description
1 Credit card
13 Tokenized Credit Card
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.

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 100 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_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 2 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

currency_cd string 3 No

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 No

The collections account group for this account

Alternative field: client_acct_group_id

bill_address3 string 100 No

The third line of the billing address.

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

client_acct_group_id string 100 No

The client-assigned group ID

Alternative field: acct_group_no

billing_group_no long 22 Yes

Billing group number

Alternative required field: seq_no, alt_pay_method, or client_billing_group_id

client_billing_group_id string 100 Yes

Client-defined unique identifier for billing group

Alternative required field: seq_no, alt_pay_method, or billing_group_no

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:

Value Description
0 False. Fraud Filtering and status update will not be performed on the transaction.
1 True. Fraud Filtering and status update on the transaction will be performed based on the API supplied fraud_control_fields. Collection group level or Payment Gateway level fraud control parameters will not be considered for the status update.
2 True. Fraud Filtering and status update on the transaction will be performed based on the API input and Collection Group/Payment Gateway level parameters. fraud_control_fields will be merged with API Inputs and Collection Group/Payment Gateway level values with the precedence of API inputs.
fraud_control_fields object   No

List of key-value pair parameters to control Fraud Control.

See fields below

Allowed values:

Value Description
fraud_filtering_enabled This is a feature that some payment processors provide that will return fraud filtering results. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_filtering_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_filtering_failure This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_failure if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_failure This should only be set if change_status_on_fraud_filtering_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_filtering_review This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_filtering_review if set to 1 (True) and the fraud_filtering_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_filtering_review This should only be set if change_status_on_fraud_filtering_review is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_prefix_failure This is a flag that indicates that the master plan instance status should be changed if the CC Prefix Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_prefix_failure This should only be set if change_mp_status_on_fraud_filtering_cc_prefix_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_number_failure This is a flag that indicates that the master plan instance status should be changed if the CC Number Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_number_failure This should only be set if change_mp_status_on_fraud_filtering_cc_number_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_failure This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process failed. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_failure This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_failure is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
change_mp_status_on_fraud_filtering_cc_issuing_country_suspect This is a flag that indicates that the master plan instance status should be changed if the CC Issuing Country Fraud Filtering check as part of the Direct Post process returned a "suspect" value. Set it to 0 (False) if changing master plan instance status is not desired.
mp_status_on_fraud_filtering_cc_issuing_country_suspect This should only be set if change_mp_status_on_fraud_filtering_cc_issuing_country_suspect is set to 1 (True). This must be a valid master plan instance status code. Master plan instance status codes can be found in the API documentation.
fraud_scoring_enabled This is a feature that some payment processors provide that will return a fraud score. Aria must be certified with that specific payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If False(0) is set, all other fraud_scoring_xxx features are ignored. If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (Use Payment Gateway Setting or Enabled or Disabled) will be used.
change_status_on_fraud_scoring_failure This parameter will change the status on the Master Plan Instance(s) to status_on_fraud_scoring_failure if set to 1 (True) and the fraud_scoring_enabled parameter is set to 1 (True). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_failure This should only be set if change_status_on_fraud_scoring_failure is set to 1 (True). This must be a valid Master Plan Instance status code. Master Plan Instance status codes can be found in the API documentation.
change_status_on_fraud_scoring_review This is a flag that indicates that the master plan instance status should be changed if a fraud scoring enabled was performed and "review" was returned as part of the fraud score result. Set it to 1 (True) if changing the master plan instance status is desired. The allowed values are 1 (True), 0 (False) and -1 (Use Collection Group/Payment Gateway Setting). If -1 (Use Collection Group/Payment Gateway Setting) is set, the CG/PG level configured value (True or False) will be used.
status_on_fraud_scoring_review This should only be set if change_status_on_fraud_scoring_review is set to 1 (True). This must be a valid Aria master plan instance status code. Aria master plan instance status codes can be found in the API documentation.
fraud_scoring_threshold This is a feature that some payment processors provide that will return a fraud score as a numeric value. Aria must be certified with that particular payment processor and you must have it properly configured within the payment processor's portal and in Aria's UI configuration - payments section. If the payment processor returns non-numeric fraud score responses, Aria will ignore this threshold. As of now it is not supported for Vantiv processor.
perform_card_type_detail_inquiry long 1 No

This feature will return marketing information if your payment processor supports it and configured in Aria. This input will be ignored for Gift Card payment method.

Allowed values:

Value Description
-1 Use Client Defined Settings (Default)
0 Do Not Return
1 Return
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:

Value Description
0 False (Default)
1 True
client_acct_id string 50 Yes

Client-defined account identifier.

Alternative required field: account_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.

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.

collection_errors object   No

See fields below

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

proc_fraud_filtering_info object   No

Fraud Filtering Response returned from Payment processor.

See fields below

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.

collection_errors fields

Name Type Length Required Description
collection_error_code long   No

If a collection is attempted, returns the error code associated with the collection.

collection_error_msg string   No

The error message associated with collection_error_code.

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.

TOP
  • Was this article helpful?