API v4.14
Merchant Parameters
Merchant parameters for transaction requests
| Field Name | Description |
|---|---|
| CHKAVS | Address Verification Service Flag (this is for enabling, ignoring or disabling the AVS option).AVS Check is enabled by default. |
| AVSMATCHSET | Used for setting the response codes to check when approving transactions based on the AVS response code.See AVSMatchSet explanation for more details. |
| CHKCVV | CVV Check flag (this is for enabling, ignoring, or disabling the Credit Card CVV2 or CVC2 check).CVV check is enabled by default. Some processors may automatically decline transactions that return a negative CVV response code. |
| CVVMATCHSET | Used for setting the response codes to check when approving transactions based on the CVV response code.See CVVMATCHSET explanation for more details. |
| CUST_BRCPFCNPJ | Individual CPF/Business CPNJ Number – Specific to Brazil |
| CONVENIENCE_FEE | Reference Field used to indicate the surcharge fee amount which is included in the amount of the transaction |
| REQUEST_AFF_ID | External Affiliate ID |
| REQUEST_API_VERSION | Payment Service API Version (4.12) |
| REQUEST_LANGUAGE | Language 3-letter Code |
| REQUEST_RESPONSE_FORMAT | Service Response Format |
| XTL_UDFXX | Merchant’s User Defined Field, with xx having a value from 01 to 20, i.e. xtl_udf01, xtl_udf02, xtl_udf03 |
| XTL_ORDER_ID | Merchant’s Order ID |
| XTL_CUST_ID | Merchant’s Customer ID |
| LI_XTL_PROD_ID_X | Merchant’s Product ID Name. “x” indicates a dynamic number depending on the line items sent in the request. For more information see the Multiple Line Items section. |
| REQUEST_INITIATOR | Used in Card on File (COF) transactions. Set this parameter to 'C' for Customer Initiated transactions (CIT). Set this parameter to 'M' for Merchant Initiated transactions (MIT). |
| REQUEST_INSTALLMENT | Default: “0”Set this parameter to ‘1” if the transaction is an installment payment. |
| PMT_NUMB_COF | Default: “0”Set this parameter to “1” to specify that a stored payment number has been used by the merchant's own system for a COF transaction. |
| REQUEST_REBILL | Default: "0"Set this parameter to “1” to specify that the transaction is a Rebill in a subscriptionSet this parameter to “2” to specify that the transaction is the FIRST transaction in a subscription |
| REQUEST_XSALE | Request Cross-sale transaction. |
| PROC_GUID | Processor GUID/GUWID |
| P3DS_RETURN_URL | Deprecated3-D Secure Return URL after verification. |
| P3DS_PARAMS | Deprecated3-D Secure Verification Parameters (Payspace accounts with 3DS only)Note: Data returned in this field is URL-encoded. |
| P3DS_VERIFICATION_URL | Deprecated3-DS Verification URL where customers should be redirected to for external verification. |
| REQUEST_ENROLLMENT | Transforms a request into a 3-D Secure enrollment check request |
| P3DS_TRANSID | Transaction ID specific to a 3-D Secure vendor |
| P3DS_VERSION | 3DS Version used on transaction (2) |
| P3DS_ECI | 3-D Secure ECI value |
| P3DS_SCREEN_HEIGHT | Total height of the cardholder's screen in pixels |
| P3DS_SCREEN_WIDTH | Total width of the cardholder's screen in pixels |
| P3DS_JAVA_ENABLED | A Boolean value (TRUE/FALSE) that represents the ability of the cardholder browser to execute Java |
| P3DS_JAVASCRIPT_ENABLED | A Boolean value (TRUE/FALSE) that represents the ability of the cardholder browser to execute JavaScript |
| P3DS_BROWSER_HEADER | The exact content of the HTTP accept headers sent from the cardholder's browser. Example:text/html,application/xhtml+xml,application/xml;q=0.9,/;q=0.8 |
| P3DS_BROWSER_LANGUAGE | Value represents the browser language as defined in IETF BCP47 |
| P3DS_BROWSER_COLOR_DEPTH | Value represents the bit depth of the color palette for displaying images, in bits per pixel Possible Values: 1, 4, 8, 15, 16, 24, 32, 48 |
| P3DS_BROWSER_TIME_ZONE | Time difference between UTC time and the cardholder browser local time, in minutesNote: Regardless of direction value should be positive. |
| P3DS_CHALLENGE_WINDOW | An override field that a merchant can pass in to set the challenge window size to display to the end cardholder. The ACS will reply with content that is formatted appropriately to this window size to allow for the best user experience. The sizes are width x height in pixels of the window displayed in the cardholder browser window. Possible values: 01 - 250x400, 02 - 390x400, 03 - 500x600, 04 - 600x400, 05 - Full page |
| REQUEST_PARES | Submitted in a 3-D Secure transaction, a value obtained from an enrollment request |
| REQUEST_AFF_ID_SUB | External Sub-affiliate ID |
| REQ_LOW_VALUE_SCAEXEMPTION | Used by Merchants to bypass 3DS on low value transactions by requesting Low-Value SCA Exemption |
| UNIQUE_XTL_ORDER_ID | Enables External Order ID uniqueness. |
| PMT_ID_XTL | External Payment /Credit Card Unique ID |
| PROC_UDF01 | Processor Defined Field 1 |
| PROC_UDF02 | Processor Defined Field 2 |
| PROC_SUCCESS_URL | Redirect URL after successful 3-D Secure authentication process. |
| PROC_ERROR_URL | Redirect URL after unsuccessful 3-D Secure authentication process. |
| PROC_REDIRECT_URL | 3DS Authentication URL where customers should be redirected to for authentication. |
| PROD_NAME | Product Name |
| PROD_TYPE | 1- Membership Cancels, 2-Membership Renews |
| PROD_REBILL_METRIC | M - MonthD - DayY - Year |
| PROD_REBILL_PERIOD | 73090 etc |
| TAX_AMT | Used to capture the tax amount charged on a transaction. |
| TAX_EXEMPT | A flag to indicate if a business is exempted from paying taxes or not. |
| TRANS_TRIAL_REBILL_CUSTOMER_CONSENT | Reports on Customer Consent for rebill |
| TRANS_CUSTOMER_RECEIPT | Stores Customer transaction receipt |
| MBSHP_ID_XTL | For capturing customer membership id for memberships managed by the merchant. |
| TRANS_REBILL_TYPE | Reports if rebill is of either of these types NONE, TRIAL, INITIAL, REBILL |
| TPPE_ID | Third-Party Processing Entity; this can be an e-Commerce platform, a CRM, another gateway or any other entity which transmits cardholder data on a merchant’s behalf. |
| PMT_WALLET | This field shall be used to hold all the different types of wallets including e-wallet and m-wallet when available |
| PMT_WALLET_CRYPTOGRAM | Base64 URL encoded field that’ll hold the payload of the authorized transaction which comes from the Apple Pay or Google Pay session on the payment form hosted by the merchant |
| ORIG_CARD_BRAND_TRANSID | This is the incoming card scheme transaction id from the original transaction for the card and the merchant account. |