Home > Aria Crescendo Documentation > Aria Crescendo core api > validate_acct_fraud_scoring_m

validate_acct_fraud_scoring_m

Obtains a fraud score and/or a fraud filter response from a payment gateway based on your criteria specified in your payment gateway. Example: when an account holder tries to make a purchase, you can take your chosen action on the account if:

  • the transaction is above your specified fraud score; or   
  • the transaction is determined to be a fraud risk based on your fraud filtering criteria. 

To use this API, you must have fraud functionality enabled and configured in your payment gateway. Contact your payment gateway representative for setup information and additional documentation.

Notes:

  • 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. 
  • You cannot obtain the fraud score for credit or debit cards enrolled in 3D Secure.

 

For information about error messages generated by this API, see validate_acct_fraud_scoring_m_Error Messages.

Input Arguments

Req Field Name Field Type Max Length Description
required-icon.png client_no long 22 Aria-assigned unique identifier indicating the Aria client providing service to this account.
required-icon.png auth_key string 32 Aria-assigned unique key to be passed with each method call for authenticating the validity of the requestor.
required-icon.png acct_no long   22  Aria-assigned account identifier. This value is unique across all Aria-managed accounts.
  OR      
  client_acct_id string 22

Client-defined identifier for the account. This value is unique across all Aria-managed accounts.
required-icon.png amount double  

The monetary amount of the electronic payment.

To authorize a tokenized credit card:

  1. For the Braintree payment gateway, complete the required Aria configuration fields.
  2. For the Worldpay payment gateway, first add the client_acct_id to the account as described in the  Worldpay configuration notes.
  3. Do either of the following:
    1. If the token was already generated outside of Aria, set the <alt_pay_method> to 13 and pass in the <bill_agreement_id>; or
    2. If you need to generate a token for the card, set the <alt_pay_method> to 13 and pass in the credit card details.
  4. Pass in the <amount> to be authorized.
  5. Optionally pass a value into the <cc_id> field to identify the type of credit card you are authorizing.
  6. Optionally pass in a <recurring_processing_model_ind> to specify the kind of transaction you are completing.

Notes:

  • 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.
Start of plan_instance_list array
required-icon.png plan_instance_list array 22     Pass in either the plan_instance_no or client_plan_instance_id to identify which master plan instance to use for fraud scoring. At this time, only the first value entered will be honored. Multiple values may be accepted in the future. To use fraud scoring, you must have it enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation. The field names and allowable values for the array are highlighted in blue below.
  Field Name Field Type Max Length Description
  brd_arrow.gifplan_instance_no
long
22


The Aria-assigned identifier for the master plan instance.

Note: A value at this field or <client_plan_instance_id> is required to honor the billing group's collection group for 3DS and non-3DS payment authorization.
  OR      
  brd_arrow.gifclient_plan_instance_id string 100

The client-defined identifier for the master plan instance.

Note: A value at this field or <plan_instance_no> is required to honor the billing group's collection group for 3DS and non-3DS payment authorization.
End of plan_instance_list array
 
required-icon.png alt_pay_method long 1

If you want to use the account's current form of payment, leave this field empty. If you want to use an alternate payment method, enter "1" in this field.

To authorize a tokenized credit card, pass 13 into the <alt_pay_method> field and follow the instructions in the <amount> field.
  OR      
  billing_group_no long 22

The unique identifier for the billing group.

Note: A value at this field or <client_billing_group_id> is required to honor the billing group's collection group for 3DS and non-3DS payment authorization.
  OR      
  client_billing_group_id string 100

The client-defined identifier for the billing group.

Note: A value at this field or <billing_group_no> is required to honor the billing group's collection group for 3DS and non-3DS payment authorization.
  OR      
  payment_method_no long 22 Aria-assigned payment method ID. Either payment method or MPI (master plan instance) information must be provided. If both are provided, the identified payment method will be used to collect the amount due for the specified MPI.
  OR      
  client_payment_method_id string 100 Client-defined payment method ID.
  cc_num string 24 Credit card number.
  cc_expire_mm long 2 Expiration month of the credit card.
  cc_expire_yyyy long 4 Expiration year of the credit card.
  cvv long 6 Card verification value used to help confirm that a transaction is being requested by the card holder since this value is physically printed on the credit card.
  payment_source long 22 Records the source of the payment information.
  alt_acct_group_no long 100 Aria-assigned collection group to be used only for this specific call. This does not change the default collection group to which the account belongs.
  alt_client_acct_group_id string 100 Client-defined collection group to be used only for this specific call. This does not change the default collection group to which the account belongs.
  track_data1 string 300 Raw "track 1" data from a swiped credit card used in a card-present transaction.
  track_data2 string 300 Raw "track 2" data from a swiped credit card used in a card-present transaction.
  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 1 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, you must enter "~" in this field.
  bill_address3 string 100 Third address line of the billing contact.
  bill_city string 32 City of the billing contact.
  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_locality string 33

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_country string 2 Country of the billing contact. The International Organization for Standardization (ISO)-compliant 2-character country code abbreviation in uppercase.
  bill_zip string 16 Zip code of the billing contact.
  bill_email string 320 Email of the billing contact.
  bill_phone string 12 Phone number of the billing contact.
  bill_phone_ext string 20 Phone extension of the billing contact.
  bill_birthdate string 10 Billing contact's date of birth.
  bill_drivers_license_no string 32 Billing contact's driver's license number.
  ship_company_name string 100 Company name of the shipping address contact.
  ship_first_name string 32 First name of the shipping address contact.
  ship_last_name string 100 Last name of the shipping address contact.
  ship_address1 string 100 First address line of the shipping address contact.
  ship_address2 string 100 Second address line of the shipping address contact. If you want to delete existing data in this field, you must enter "~" in this field.
  ship_address3 string 100 Third address line of the shipping address contact.
  ship_city string 32 City of the shipping address contact.
  ship_state_prov string 10 State or province of the shipping address 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 <ship_locality> field for addresses in those countries.
  ship_locality string 30

Locality of the shipping address contact. Use this field instead of the <ship_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.
  ship_country string 2 Country of the shipping address contact. The ISO-compliant 2-character country code abbreviation in uppercase.
  ship_zip string 16 Zip code of the shipping address contact.
  ship_phone string 30 Phone number of the shipping address contact.
  ship_phone_extension string 30 Phone extension of the shipping address contact.
  end_user_ip_address string 15 IP address that was used to place an online order.
  end_user_browser_accept_header string 32 Browser accept header that was used to place an online order. Example: “'text/html,application/xhtml+xml,application/xml ;q=0.9,*/*;q=0.8'”.
  end_user_browser_agent string 32 Browser that was used to place an online order. Example: "Mozilla/5.0 (X11; Linux i586; rv:31.0) Gecko/20100101 Firefox/31.0".
  end_user_session_id string 32 The client-generated session ID that is often used with captcha fraud prevention measures as part of an online order.
Start of fraud_field array
  fraud_field array   The processor-specific fraud scoring parameters passed as an array of fraud_field_name/fraud_field_value key-value pairs. To use fraud scoring, you must have it 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
  brd_arrow.gifcustomer_ani string 32 ANI (Automatic Number Identification) is a service that provides the receiver of a telephone call with the number of the calling phone.
The method for providing this information is determined by the service provider (examples: AT&T, Sprint).
  brd_arrow.gifwebsite_short_name string 8 Short name of the client's website.
  brd_arrow.giffencible_item_cash_value double 12 The cash value of any fencible items in the order.
  brd_arrow.giffraud_merchant_id string 32 A client-generated ID for a specific customer.
  brd_arrow.gif customer_id_timestamp       Time when the customer merchant ID was created in yyyy-mm-dd hh24:mi:ss format.
  brd_arrow.gif
customer_gender		 long 1 Gender of the customer.
Values Description
F Female
M Male
  brd_arrow.gifcustomer_udf string 100 User-defined information in an online order. Example: “UPROMOCODE=X6Y3Z1&|UCUSTOMERREFERAL=SocialMedia&|UDISCOUNTGIVEN=10.00&|”.
  brd_arrow.gif
order_shipping_method		 long 1 Method of shipment for an item.  The allowable values for American Express transactions are identified  with " * ". If an invalid value is sent for American Express transactions, the transaction is rejected with response reason code 225 (invalid field data). The order_shipping_method field is required only if you are requesting a fraud score from Chase Paymentech.
Values Description
C Lowest cost
D Carrier designated by customer
E Electronic delivery*
G Ground*
I International
M Military
N Next day/overnight*
O Other/standard
P Store pickup*
S Same day*
T Two day service*
W Three day service*
  brd_arrow.gifpersonal_information_payer_id string 100 Payer identification provided when using fraud scoring with a processor.
Example: PayPal account number captured as part
of an online order paid for using PayPal Express Checkout.
End of fraud_field array
 
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 scoring and fraud filtering options. To use fraud protection, 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
  brd_arrow.gif
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.
Values Description
0 disable
1 enable
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifchange_status_on_fraud_filtering_failure string 100 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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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.
  brd_arrow.gifchange_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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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.
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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)
  brd_arrow.gifchange_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)
Values Description
0 false
1 true
  brd_arrow.gifmp_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)
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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)
  brd_arrow.gif
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)
Values Description
0 false
1 true
  brd_arrow.gif
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)
  brd_arrow.giffraud_scoring_enabled
 		 string 100 Indicates whether to send a request to the processor for a fraud score.  If you set it to 0 (disable), then Aria will ignore all other fraud scoring fields.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.giffraud_scoring_threshold string 100

Allows you to set a threshold that your payment processor will use to determine a fraud score as a numeric value. If the payment processor returns a non-numeric fraud score response, Aria will ignore the threshold that you entered.

To use fraud scoring, you must have it enabled and configured in your payment gateway's portal. Contact your payment gateway representative for setup information and additional documentation.

As of now, it is not supported for Vantiv (Litle) processor.
  brd_arrow.gifchange_status_on_fraud_scoring_failure string 100 Indicates whether to change the status of the account or master plan instance(s) if the fraud scoring request returns a failure response. 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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_on_fraud_scoring_failure string 100 If change_status_on_fraud_scoring_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance.
  brd_arrow.gif change_mp_status_on_fraud_scoring_failure   string 100 Indicates whether to change the status of the master plan instance(s) if the fraud scoring request returns a failure response. 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)
Values Description
0 false
1 true
  brd_arrow.gifmp_status_on_fraud_scoring_failure string 100 If change_mp_status_on_fraud_scoring_failure is set to 1 (true), use this field to indicate the desired status of the master plan instance. (applies to Direct Post)
  brd_arrow.gifchange_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.
Values Description
0 false
1 true
-1 Use settings specified at the collection group or payment gateway level.
  brd_arrow.gifstatus_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.
Values Description
0 INACTIVE
1 ACTIVE
2 CANCELLATION PENDING
3 TERMINATION PENDING
31 INSTALLATION PENDING
32 REGISTERED PENDING ACTIVATION
41 ACTIVE TRIAL
61 ACTIVE NON-BILLABLE
-1 SUSPENDED
-2 CANCELLED
-3 TERMINATED
End of fraud_control_fields array
 
  session_id string 100 Value used with ThreatMetrix to identify Fraud Scoring Session
  cust_field_1 string 100 Configurable value 1 to be used with ThreatMetrix.
  cust_field_2 string 100 Configurable value 2 to be used with ThreatMetrix.
  cust_field_3 string 100 Configurable value 3 to be used with ThreatMetrix.
  cust_field_4 string 100 Configurable value 4 to be used with ThreatMetrix.
  cust_field_5 string 100 Configurable value 5 to be used with ThreatMetrix.
  recurring_processing_model_ind long 1

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

This feature is available to you if your payment gateway supports Cardholder Initiated Transactions (CIT) and Merchant Initiated Transactions (MIT).

Note: Currently, for only the Vantiv payment gateway, the value in this field will automatically be set to 2 if your payment gateway or collection group configuration has the Send orderSource as recurring for all transactions option enabled.

Refer to your payment gateway documentation to see if this applies.

Please contact your payment gateway representative for more information.

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 non-recurring charge (one-time order or plan upgrade) that uses a credit card that is currently stored in Aria.
  attempt_3d_secure string  

This will manually trigger a 3DSecure check if the payment gateway/processor supports this feature.

To perform 3DS authentication, follow the instructions provided in the authorize_3dsecure_m API documentation.

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.
  bill_taxpayer_id string 32 Taxpayer ID of the billing contact
Start of proc_field_override array
  proc_field_override array  

Your chosen data to send to your payment gateway passed as an array of proc_field_name/proc_field_value key-value pairs.

The allowable field(s) and values for the key-value pairs are listed below.
  brd_arrow.gif proc_field_name string 100 List of processor field names
  brd_arrow.gif proc_field_value string 1000 List of processor field values
  Field Name Field Type Max Length Description
    brd_arrow.gif transaction_type string 2

If you use Chase Paymentech or Vantiv, this field allows you to tell that payment gateway which transaction type is involved (examples: single or recurring transaction) when you process a customer's  payment information.

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

 

Notes:

  • 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:

  1. value passed into this field
  2. collection group configuration
  3. payment gateway configuration
  4. transaction type that you specified in the <recurring_processing_model_ind> field
Values Description
-1 (Chase) 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 processes via an installment plan.
2 (Chase) Recurring Transaction - Designates a transaction that represents an agreement 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 accountholder 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.
Note: 3DS-related fields are listed below. 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.
  brd_arrow.gif end_user_browser_color_depth string 2000 Browser color depth in bits per pixel. You can obtain this by using the browser's screen.colorDepth property. Accepted values: 1, 4, 8, 15, 16, 24, 32 or 48 bit color depth.            
  brd_arrow.gif end_user_browser_java_enabled_ind string 2000 Boolean value indicating whether the customer's browser is able to execute Java.
  brd_arrow.gif end_user_browser_language string 2000 Browser supported language (as defined in IETF BCP-Internet Engineering Task Force Best Current Practice 47). You can obtain this by using the browser's navigator.language property.            
  brd_arrow.gif end_user_browser_screen_height string 2000 Total height of the browser that was used for placing an online order.
  brd_arrow.gif end_user_browser_screen_width string 2000

Total width of the browser that was used for placing an online order.
  brd_arrow.gif end_user_browser_timezone_offset_mins string 2000 Difference between UTC (Universal Time Coordinated) time and the customer's browser local time, in minutes.
End of proc_field_override array
 
Req Field Name Field Type Max Length Description
  bill_agreement_id string 32

Unique identifier of the bill agreement (also referred to as a token).

To authorize a tokenized credit card, follow the instructions in the <amount> field.
  cc_id long 2

A numeric code indicating the type of card.

Values Description
1 Visa
2 Mastercard
3 American Express
4 Discover
5 Diners Club/Carte Blanche
6 Maestro
7 JCB
8 Laser
9 Dankoort
  disable_pmt_method_on_auth_failure string 5

Specifies whether to disable or enable a payment method after a failed card authorization.

A card authorization will automatically be performed after successful completion of fraud scoring/filtering (if your payment gateway supports fraud scoring/filtering).

If you pass in true and the authorization fails, the card is added to the account with a disabled status.

Values Description
false (default) Disable a payment method after a failed card authorization.
true Enable a payment method after a failed card authorization.
 

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" indicates no error.
proc_cvv_response string The processor return code from CVV (Card Verification Value) validation.
proc_avs_response string Processor return code from address validation
proc_cavv_response string The processor return code for security validation.
proc_status_code string The processor status code.
proc_status_text string The processor 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_payer_auth_request string The unique number for an authorization.
proc_redirect_issuer_url string The URL to which you must post the 3DS (3D Secure) data. This will redirect the customer.
proc_fraud_scoring_info array The fraud scoring information provided by the payment processor as described below.
brd_arrow.gifproc_fraud_score string Fraud score provided by the payment processor.
brd_arrow.gifproc_fraud_score_result string Fraud score result provided by the payment processor, if available.
proc_fraud_filtering_info array The fraud filtering information provided by the payment processor as described below.
brd_arrow.gifproc_fraud_country_status string Fraud country status provided by the payment processor.
brd_arrow.gifproc_fraud_country_code string Fraud country code provided by the payment processor.
proc_fraud_score_result string Fraud score response provided by the payment processor.  Used when automatically configured at payment processor to return pass, fail, or verify/suspect/unknown.
proc_initial_auth_txn_id string 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.
Start of proc_3dsecure_data array

proc_3dsecure_data

 array

Array of 3D Secure processor-specific fields required for client-side integration. returned as proc_field_name/proc_field_value key-value pairs. The allowable fields and values for the key-value pairs are listed below.

Note: 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.
proc_field_name Field Type proc_field_value
brd_arrow.gif attempt_3ds_auth_challenge string Returns true or false to indicate whether or not the 3DS authorization challenge is enabled for the card.

brd_arrow.gif payer_auth_request

 string  The unique number for a given authorization.
brd_arrow.gif redirect_issuer_url string The URL where you must post the 3DS data to. This will redirect the customer.
brd_arrow.gif md string The payment session identifier returned by the card issuer.
brd_arrow.gif client_auth_token     string  The client authorization token required to map the merchant account with the client JS SDK (JavaScript Software Development Kit).
brd_arrow.gif cc_single_use_token string

The single use token for the credit card.
brd_arrow.gif cc_prefix string The first six digits of the customer's card number.
brd_arrow.gif pa_3ds_js_lib_url string Your JavaScript Library URL path used for 3DS 2.0.
brd_arrow.gif payer_auth_transaction_id string The unique number for a given transaction.
brd_arrow.gif payer_auth_reference_id string The unique number for a given authorization.
brd_arrow.gif pa_3ds_form_action string This form action is used for a Direct Post call to decide whether to attempt device data collection or credit card authorization.
brd_arrow.gif pa_3ds_df_method_url string Method URL used for Device Fingerprint for 3DS 2.0 transactions.
brd_arrow.gif pa_3ds_message_version string Message/3DS version of the ongoing 3DS authorization.
brd_arrow.gif pa_3ds_form_content string If the issuer's Access Control Server (ACS) supports this feature, this field will receive content to populate the client’s form page to enable 3DS authentication. If the issuer’s ACS does not support this feature, no information for authentication will be returned to this field.
brd_arrow.gif pa_3ds_df_post_url string URL used for posting Device Fingerprint details for 3DS 2.0 transactions.
brd_arrow.gif pa_3ds_cs_post_url string URL returned by your payment gateway, which is used for the 3DS authorization challenge for 3DS 2.0 transactions.
End of proc_3dsecure_data_array
 
Field Name Field Type Description
processor_id long Payment Processor Id.
 
Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.
Powered by CXone Expert ®