Back

EPX Hosted Pay Page and Browser Post API Request Fields

This chapter describes the fields that can be used in a transaction request to the EPX Hosted Pay Page or Browser Post API.

CANCEL_URL

The CANCEL_URL field contains the URL that the customer will be redirected to when the Cancel button is selected by the user from the EPX Hosted Pay Page. During this process the session will be destroyed and then the redirection will occur. If no redirect URL is provided, the default redirection is to an epx webpage.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

CANCEL_URL=www.merchantswebsite.com/cancel.htm

CUSTOM_CSS_URL

The CUSTOM_CSS_URL field and the CUSTOM_JAVASCRIPT_URL field are used together to allow development of the EPX Hosted Pay Page customization. This field would contain the URL of the CSS file that the merchant would host locally in their environment. When sent in the EPX Hosted Pay Page POST, the browser will use the local file to customize the EPX Hosted Pay Page allowing an easier development process. This field will only work in the test environment and will be ignored if sent in Production.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

CUSTOM_CSS_URL=http://localhost/9001-900300-1.css

CUSTOM_JAVASCRIPT_URL

The CUSTOM_JAVASCRIPT_URL field and the CUSTOM_CSS_URL field are used together to allow development of the EPX Hosted Pay Page customization. This field would contain the URL of the JavaScript PHP file that the merchant would host locally in their environment. When sent in the EPX Hosted Pay Page POST, the browser will use the local file to customize the EPX Hosted Pay Page allowing an easier development process. This field will only work in the test environment and will be ignored if sent in Production.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

CUSTOM_JAVASCRIPT_URL=http://localhost/9001-900300-1.php

FORCE_CREDIT

The FORCE_CREDIT field contains a value which will determine if the EPX Hosted Pay Page will require the use of a credit card transaction rather than giving the option of various transaction types on the page, such as PIN-less debit or ACH. This field is used when a EPX Hosted Pay Page is set up for both credit card and PIN-less debit transactions.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

FORCE_CREDIT=Y

FORCE_CREDIT Values

• Y—Sending a tag with a value of Y will allow only credit card transactions. All PIN-less debit options that would otherwise be available on the page will not be available.

• N—When this field is not sent, the default value is N.

INVALID_REDIRECT_URL

The INVALID_REDIRECT_URL field contains the URL the user will be redirected to when there is an issue with the TAC during a EPX Hosted Pay Page or Browser Post API request.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

INVALID_REDIRECT_URL=www.merchantswebsite.com/tac_invalid.html

INVALID_REDIRECT_URL Error Cases

• Post no parameters in the post
• Empty TAC value on initial post
• TAC decryption error
• Expired TAC—A TAC is good for 2 hours after generation
• Invalid TAC—Failed 4-part Key match
• Invalid TAC—TRAN_NBR doesn’t match value supplied in TAC
• Invalid TAC—Invalid 4-part Key

• Multiple TAC Use

RECEIPT

The RECEIPT field contains a value which will determine if the receipt is shown after a EPX Hosted Pay Page transaction prior to redirecting the user to the URL sent in the REDIRECT_URL field.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

RECEIPT=N

RECEIPT Values

• Y—The EPX Hosted Pay Page will show the receipt before redirecting the user.
• N—This value will redirect without first showing the receipt.

REDIRECT_ECHO

The REDIRECT_ECHO field contains a value which will determine how much of the transaction response will be posted to the URL sent in the REDIRECT_URL. The values used with the REDIRECT_ECHO field are below.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

REDIRECT_ECHO=V

REDIRECT_ECHO Values

• N—No response will be sent to the REDIRECT_URL.
• R—The default response fields will be sent to the REDIRECT_URL.
• V—A verbose response will be sent to the REDIRECT_URL. The verbose response contains the default response files as well as the additional fields submitted with the transaction request.

REDIRECT_NON_APPROVALS

The REDIRECT_NON_APPROVALS field contains a value that determines if the user will be redirected on a decline to the URL sent in the REDIRECT_URL field during a EPX Hosted Pay Page transaction. The values used with the REDIRECT_NON_APPROVALS field are below.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

REDIRECT_NON_APPROVALS=N

REDIRECT_NON_APPROVALS Values

• Y—The EPX Hosted Pay Page redirects the user.
• N—This value will not redirect the user, but allows him to resubmit the transaction using the same BATCH_ ID/TRAN_NBR combination as the original transaction attempt.

REDIRECT_URL

The REDIRECT_URL field contains the URL the user will be redirected to once the transaction has been completed during a EPX Hosted Pay Page or Browser Post transaction. This URL can also be made to accept the post of response values during the redirection.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

REDIRECT_URL=www.merchantswebsite.com/transaction_complete.php

RESPONSE_ECHO

The RESPONSE_ECHO field contains a value to determine how much of the transaction response will be posted to the URL sent in the RESPONSE_URL. The values used with the RESPONSE_ECHO field are below.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

RESPONSE_ECHO=V

RESPONSE_ECHO Values

• R—The default response fields will be sent to the RESPONSE_URL.
• V—A verbose response will be sent to the RESPONSE_URL. The verbose response contains the default response fields as well as the additional fields submitted with the transaction request.

RESPONSE_FORMAT

The RESPONSE_FORMAT field contains the value XML which will instruct the PostMaster to post the transaction response in XML format to the URL sent in the RESPONSE_URL. When this field is not sent, the default format of the response will be key value pairs.

• Variable Type: Alpha
• Max Length: 1

Key Value Pair Example:

RESPONSE_FORMAT=XML

RESPONSE_URL

The RESPONSE_URL field contains the URL of an HTTP server in the merchant domain that will receive the transaction results via HTTP post from the EPX Postmaster application.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

RESPONSE_URL=www.merchantswebsite.com/accept_response.php

TAC

The TAC field contains the Terminal Authentication Code generated by the EPX Key Exchange service. The TAC is a required field when calling the EPX Hosted Pay Page or Browser Post API.

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

TAC=FEU86Eo5/S1jfob4gVaDPP7w1IpJSFIiehqsHymY7dltXrJmcRNMAw==

TIMEOUT_REDIRECT_URL

The TIMEOUT_REDIRECT_URL field contains the URL the user will be redirected to when the EPX Hosted Pay Page session times out (default of 15 minutes).

• Variable Type: Alphanumeric
• Max Length: N/A

Key Value Pair Example:

TIMEOUT_REDIRECT_URL=www.merchantswebsite.com/session_timeout.html

TRAN_CODE

The TRAN_CODE field contains the transaction code that loosely corresponds to the EPX TRAN_TYPE field. This field can be configured in the custom JavaScript that is used to customize the EPX Hosted Pay Page API and will dictate the transaction performed on the EPX Hosted Pay Page during submission. This field is also required when using a web form to send a transaction to the Browser Post API. Refer to the TRAN_GROUP field definition for more information on the possible values for this field.

TRAN_GROUP

The payment page may offer an end user a choice of payment methods, which would then determine the TRAN_ CODE tag that is submitted by the EPX Hosted Pay Page API, or to the Browser Post API by the merchant payment page. The TRAN_GROUP field is used during the KeyExchange request to validate that the TRAN_CODE submitted during the transaction corresponds to a general category of payment types, since the merchant may not know which payment option the customer will choose on the payment page at the time of serving the page. The following table shows the available values for TRAN_GROUP and the corresponding TRAN_CODE values that must match for successful validation. Refer to the TRAN_TYPE field definition for more information on the corresponding TRAN_TYPEs listed.

• Variable Type: Alpha
• Max Length: N/A

Key Value Pair Example:

TRAN_GROUP=SALE

Specified Groups

TRAN_ GROUP Values