Payer Authentication Fields

	Search documentation:

	Help Advanced
Published 08/07/2002

Chapter 3

Payer Authentication Fields

This chapter provides information about the fields that the ProcessPA and ValidatePA plug-ins use.

For information about how to use these fields in a Decision Server request, see the Risk Manager Developer's Guide.

ProcessPA Fields

This section describes the fields for the ProcessPA plug-in, which checks to see whether a customer is enrolled in VPAS.

Order Fields

The following table lists the order fields for the ProcessPA plug-in.

Note If the request includes the order field validatepa_signedpares, which is used by the ValidatePA plug-in, the ProcessPA plug-in sets the reply field processpa_enrolled to false and exits immediately.

Table 1 Order Fields for ProcessPA Plug-In

Field Name

Description

Required/Optional

Risk Manager Data Type

customer_cc_number

Credit card number of the customer.

Required

String

processpa_http_accept

Value of the Accept: header sent by the customer's Web browser.

Required

String

processpa_http_user_agent

Value of the User-Agent: header sent by the customer's Web browser.

Required

String

processpa_merchant_acceptable_brands

Card brands that you accept for payer authentication. Use the value VISA.

Required

String

processpa_merchant_country_code

Country code for your company. Use the three-digit ISO country code. For a list of valid codes, see the Arcot TransFort Merchant Software Installation Manual.

Required

String

processpa_merchant_gmt_offset

Number of hours by which your company's local time differs from Greenwich Mean Time (GMT). For example, use the value -8 for Pacific Standard Time.

Required

String

processpa_merchant_id

Identifier provided by the acquiring bank.

Required

String

processpa_merchant_name

Name of your company.

Required

String

processpa_merchant_ref_number

Reference number for the payer authentication.

Required

String

processpa_merchant_url

Address of your company's Web site (for example, http://www.example.com).

Required

String

processpa_purchase_amount

Text to display in the authentication window as the purchase amount (for example, $99.95).

Required

String

processpa_purchase_currency

Currency used for the order. Use the three-digit ISO currency code. For a list of valid codes, see the Arcot TransFort Merchant Software Installation Manual.

Required

String

processpa_purchase_date

Date of the purchase. Use the format YYYYMMDD.

Required

String

processpa_purchase_description

Brief description of the products in the order.

Required

String

processpa_purchase_installment

Indicates whether the order is an installment payment. If it is, use the value 1.

Optional

Number

processpa_purchase_recurring

Indicates whether the order is a recurring purchase. If it is, use the value 1.

Optional

Number

processpa_purchase_terms

Description of the terms of the purchase.

Optional

String

ship_to_address1

First line of the customer's shipping address.

Optional

String

Reply Fields

The following table lists the reply fields for the ProcessPA plug-in.

Table 2 Reply Fields for ProcessPA Plug-In

Field Name

Description

Risk Manager Data Type

processpa_acs_count

Number of issuing bank URLs included in the reply.

Number

processpa_acs_0..n

URLs for the issuing bank's authentication form. You use these URLs to display an authentication dialog to the customer.

String

processpa_enrolled

Indicates whether the customer is enrolled in a payer authentication program. This field will contain one of the following values:

true: The customer is enrolled in a payer authentication program.

false: The customer is not enrolled in a payer authentication program; the customer's enrollment status could not be determined; or the plug-in exited immediately because the request contained a PARes.

String

processpa_error_msg

Message describing whether any required fields were missing from the request.

String

processpa_pareq

Base 64-encoded payer authentication request (PAReq) message.

String

processpa_proxypan

Credit card number used in the payer authentication request message.

String

processpa_xid

Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.

String

ValidatePA Fields

This section describes the fields for the ValidatePA plug-in, which validates the results of payer authentication.

Order Fields

The following table lists the order fields for the ValidatePA plug-in.

Note If the request does not include the field validatepa_signedpares, the ValidatePA plug-in sets the reply field validatepa_validated to false and exits immediately.

Table 3 Order Fields for ValidatePA Plug-In

Field Name

Description

Required/Optional

Risk Manager Data Type

validatepa_signedpares

Base 64-encoded payer authentication result (PARes) message returned by the customer's issuing bank.

Required

String

Reply Fields

The following table lists the reply fields for the ValidatePA plug-in.

Table 4 Reply Fields for ValidatePA Plug-In

Field Name

Description

Risk Manager Data Type

card_authentication_type

If validation is successful, contains the value vpas.

String

cavv

Base 64-encoded transaction identifier generated by the issuing bank.

String

customer_cc_expmo

Expiration month (MM) of the credit card.

String

customer_cc_expyr

Expiration year (YYYY) of the credit card.

String

customer_cc_number

Credit card number of the customer.

String

validatepa_cavv

Base 64-encoded transaction identifier generated by the issuing bank.

String

validatepa_eci

Indicates the electronic commerce indicator (ECI) to use for credit card authorization. This field will contain one of the following values:

00: The customer did not complete authentication, or the signature is not valid.

05: The customer completed authentication.

String

validatepa_error_msg

Message describing errors that occurred during validation.

String

validatepa_status_code

Provides detail about the results of validation. This field will contain one of the following values:

-1: An Arcot TransFort error occurred while validating payer authentication.

0: The payer authentication was validated.

6: An error occurred at the issuing bank. Payer authentication could not be validated.

9: The customer participates in payer authentication but was not authenticated.

Number

validatepa_validated

Indicates whether the payer authentication was validated. This field will contain one of the following values:

true: The payer authentication was validated.

false: The payer authentication could not be validated, or the plug-in exited immediately because the request did not contain a PARes.

String

validatepa_xid

Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.

String

xid

Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.

String

Field Name	Description	Required/Optional	Risk Manager Data Type
customer_cc_number	Credit card number of the customer.	Required	String
processpa_http_accept	Value of the `Accept:` header sent by the customer's Web browser.	Required	String
processpa_http_user_agent	Value of the `User-Agent:` header sent by the customer's Web browser.	Required	String
processpa_merchant_acceptable_brands	Card brands that you accept for payer authentication. Use the value `VISA`.	Required	String
processpa_merchant_country_code	Country code for your company. Use the three-digit ISO country code. For a list of valid codes, see the Arcot TransFort Merchant Software Installation Manual.	Required	String
processpa_merchant_gmt_offset	Number of hours by which your company's local time differs from Greenwich Mean Time (GMT). For example, use the value `-8` for Pacific Standard Time.	Required	String
processpa_merchant_id	Identifier provided by the acquiring bank.	Required	String
processpa_merchant_name	Name of your company.	Required	String
processpa_merchant_ref_number	Reference number for the payer authentication.	Required	String
processpa_merchant_url	Address of your company's Web site (for example, `http://www.example.com`).	Required	String
processpa_purchase_amount	Text to display in the authentication window as the purchase amount (for example, `$99.95`).	Required	String
processpa_purchase_currency	Currency used for the order. Use the three-digit ISO currency code. For a list of valid codes, see the Arcot TransFort Merchant Software Installation Manual.	Required	String
processpa_purchase_date	Date of the purchase. Use the format `YYYYMMDD`.	Required	String
processpa_purchase_description	Brief description of the products in the order.	Required	String
processpa_purchase_installment	Indicates whether the order is an installment payment. If it is, use the value `1`.	Optional	Number
processpa_purchase_recurring	Indicates whether the order is a recurring purchase. If it is, use the value `1`.	Optional	Number
processpa_purchase_terms	Description of the terms of the purchase.	Optional	String
ship_to_address1	First line of the customer's shipping address.	Optional	String

Field Name	Description	Risk Manager Data Type
processpa_acs_count	Number of issuing bank URLs included in the reply.	Number
processpa_acs_0..n	URLs for the issuing bank's authentication form. You use these URLs to display an authentication dialog to the customer.	String
processpa_enrolled	Indicates whether the customer is enrolled in a payer authentication program. This field will contain one of the following values: `true`: The customer is enrolled in a payer authentication program. `false`: The customer is not enrolled in a payer authentication program; the customer's enrollment status could not be determined; or the plug-in exited immediately because the request contained a PARes.	String
processpa_error_msg	Message describing whether any required fields were missing from the request.	String
processpa_pareq	Base 64-encoded payer authentication request (PAReq) message.	String
processpa_proxypan	Credit card number used in the payer authentication request message.	String
processpa_xid	Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.	String

Field Name	Description	Risk Manager Data Type
card_authentication_type	If validation is successful, contains the value `vpas`.	String
cavv	Base 64-encoded transaction identifier generated by the issuing bank.	String
customer_cc_expmo	Expiration month (`MM`) of the credit card.	String
customer_cc_expyr	Expiration year (`YYYY`) of the credit card.	String
customer_cc_number	Credit card number of the customer.	String
validatepa_cavv	Base 64-encoded transaction identifier generated by the issuing bank.	String
validatepa_eci	Indicates the electronic commerce indicator (ECI) to use for credit card authorization. This field will contain one of the following values: `00`: The customer did not complete authentication, or the signature is not valid. `05`: The customer completed authentication.	String
validatepa_error_msg	Message describing errors that occurred during validation.	String
validatepa_status_code	Provides detail about the results of validation. This field will contain one of the following values: `-1`: An Arcot TransFort error occurred while validating payer authentication. `0`: The payer authentication was validated. `6`: An error occurred at the issuing bank. Payer authentication could not be validated. `9`: The customer participates in payer authentication but was not authenticated.	Number
validatepa_validated	Indicates whether the payer authentication was validated. This field will contain one of the following values: `true`: The payer authentication was validated. `false`: The payer authentication could not be validated, or the plug-in exited immediately because the request did not contain a PARes.	String
validatepa_xid	Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.	String
xid	Base 64-encoded transaction identifier generated by the Arcot Merchant Service. Used to match an outgoing PAReq with an incoming PARes.	String