CAPTURE
Last updated: 23-Jan-2025
This command captures payment authorization(s) and marks them eligible for settlement.
- If both AUTH_CODE and CTROUTD are sent in the command request, POS will issue an error (example, AUTH_CODE/CTROUTD combination not valid).
- In case of PITSTOP solutions, ANYWHERECARDENABLED parameter in (Device/PINPad Parameters) table, should be set if merchant wants to enable card readers on both IPP and EPP devices.
Note
Device UI Required: Yes, Conditional (if CTROUTD is provided, Device UI is NOT required).
Request Packet
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| FUNCTION_TYPE | Required | Static value | N/A | N/A | PAYMENT | Type of function. |
| COMMAND | Required | Static value | N/A | N/A | CAPTURE | Command name |
| TRANS_AMOUNT | Required | Floating point number | 1(2) | 6(2) | Total transaction amount (including any TIP_AMOUNT) Examaple: 5.35 | |
| TIP_AMOUNT | Optional | Floating point number | 1(2) | 6(2) | This indicates to send the TIP amount. Examaple: 1.00 | |
| POS_RECON | Optional | Character | 1 | 30 | POS Reconciliation field to be echoed back in response to POS. Examaple: RetailPOS1 | |
| EBTCASH_ELIGIBLE | Optional | Floating point number | 1(2) | 6(2) | Amount eligible for Cash Benefits EBT. When this field is present, SCA displays EBT payment button. Examaple: 5.00 | |
| EBTSNAP_ELIGIBLE | Optional | Floating point number | 1(2) | 6(2) | Amount eligible for Food Stamp EBT. When this field is present, SCA displays EBT payment button. Examaple: 5.00 | |
| EBT_VOUCHER_NUM | Optional | Character | 0 | 15 | This field is used to send EBT voucher number. This is an optional field for EBT Post Auth/Force transaction. Examaple: 2222222 | |
| PAYMENT_TYPE | Conditional | List | N/A | N/A |
|
This field is required when CTROUTD is sent. Else this is an OPTIONAL field. When this field is present, the application will bypass the consumer payment selection screen. PAYMENT_TYPE field is mandatory for card token based transactions. |
| PAYMENT_SUBTYPE | Optional | List | N/A | N/A | This indicates to send with payment types of GIFT and PRIV_LBL. Examaple: BLACKHAWK | |
| CARD_PRESENT | Optional | Binary |
|
Card Present Indicator | ||
| EBT_TYPE | Optional | List |
|
This is required for EBT transactions. | ||
| AUTH_CODE | Conditional | Character | 1 | 16 | When this field is present, the capture is performed offline as a POST_AUTH. Worldpay allows maximum 6 bytes. Examaple: TA1260 | |
| MANUAL_ENTRY | Optional | Binary | N/A | N/A |
|
This instructs application to collect the account information through the keypad on the device. |
| CUSTOMER_STREET | Optional | Character | 1 | 20 | This is applicable when MANUAL_ENTRY is set to TRUE. Merchants should send this field only when required by the processor. Not required for customers using Point Gateway services. | |
| CUSTOMER_ZIP | Optional | Character | 9 | This is applicable when MANUAL_ENTRY = TRUE. Merchants should send this field only when required by the processor. Not required for customers using Point Gateway services. | ||
| MANUAL_PROMPT_OPTIONS | Optional | Character | 1 | 50 |
|
This is applicable when MANUAL_ENTRY = TRUE and payment type is Credit Card. When this is present, SCA will prompt for customer zip code and/or not prompt for CVV value. The zip code that is entered will be returned in the CUSTOMER_ZIP field in the response. |
| PAYMENT_TYPES | Optional | Character | 3 | Pipe-delimited list of valid tender types (for capture/refund transactions) specified by POS. Only listed payment types will appear on consumer payment selection screen. All included tender types must be configuration enabled. Example: CREDIT|DEBIT|GIFT|FSA | ||
| POS_TENDER1 | Optional | Character | 8 | POS-defined tender for SCA dynamic display. This will be truncated on display if >8 char. For example, STORE CREDIT will display as STORE CR. As of this publication POS-defined tender only supported by Point Classic implementations. | ||
| TENDER1_ACTION | Optional | List |
|
POS-defined action. | ||
| POS_TENDER2 | Optional | Character | See POS_TENDER1. Example: ACME GIFT CARD | |||
| TENDER2_ACTION | Optional | List | See TENDER1_ACTION. Example: NOTIFICATION | |||
| POS_TENDER3 | Optional | Character | See POS_TENDER1. Example: CHECK | |||
| TENDER3_ACTION | Optional | List | See TENDER1_ACTION. Example: NOTIFICATION | |||
| CTROUTD | Conditional | Numeric | 1 | 16 | When this field is present, Point will mark the referenced transaction as eligible for settlement (performed with the COMPLETION command). CTROUTD is a sequence number for PAYMENT transactions (always enabled) that is generated per Client ID. Each Client ID has its own CTROUTD sequence counter. This is applicable for Credit card only. This is not supported by FDRC in Point Classic RVE006 implementation. Example: 1234567 | |
| RECURRING | Optional | Binary | 1 | 1 |
|
This is used when Payment Type is Credit. This field denotes Recurring Billing Flag to indicate the transaction is recurring. This is applicable to UGP only. |
| BILLPAY | Optional | Binary | 1 | 1 |
|
This is used to indicate a bill payment. This is applicable to UGP and Worldpay. |
| FORCE_FLAG | Conditional | Binary |
|
This field is used to override duplicate checking for the transaction, when DUPLICATECHECK parameter (Application Parameters) is enable. The value should be sent as TRUE to override duplicate checking. | ||
| CAPTURECARD_EARLYRETURN | Optional | Binary |
|
If the sending value is TRUE, then the application returns card data to POS before processing. PCI BIN checking in place to return full PAN or masked PAN BIN range level. SCA will cache data from the swipe, but will only use in immediately subsequent CAPTURE request containing explicit tender type – else, it will discard. Refer to Capture Card Early Return for the sample request and response. | ||
| EMV_TAGS_REQD | Conditional | Binary | Valid values: Y/N | EMV tags detail required. This field is sent in request to return the EMV tags in the response, only in case of CAPTURECARD_EARLYRETURN is sent as TRUE. | ||
| ENCRYPT | Conditional | Binary |
|
This field is required to encrypt the PAN details before passing it on to processor/gateway. In case of P2PE encryption, this field needs to be set to TRUE as value. If this field is not present, then the application will internally treat this field as a value TRUE when the device encryption is ADE/VSD. | ||
| INSTALLMENT | Conditional | Character |
|
This field denotes that the Stored Credential transaction will be processed for instalment payments. This is a required field, when SCMCI_INDICATOR=3. This field is prohibited, when SCMCI_INDICATOR=2. This is an optional, when SCMCI_INDICATOR=1. NOTE: Value N and Y are applicable to GSC. Value Y and F are applicable to UGP. | ||
| RECURRING | Conditional | Character |
|
This is used when Payment Type is Credit. This field denotes Recurring Billing Flag to indicate the transaction is recurring. With respect to Stored Credential transaction, this field denotes this transaction will be processed for recurring payments. This is a required field, when SCMCI_INDICATOR=3. This field is prohibited, when SCMCI_INDICATOR=2. This is an optional, when SCMCI_INDICATOR=1. NOTE: In case of Stored Credential transaction, value N and Y are applicable for GSC. Value Y and F are applicable for UGP. | ||
| UNSCHEDULED | Conditional | Binary |
|
This field denotes that the Stored Credential transaction will be processed for unscheduled payments. This is a required field, when SCMCI_INDICATOR=3. This field is prohibited, when SCMCI_INDICATOR=2. This is an optional, when SCMCI_INDICATOR=1. NOTE: This is applicable to GSC only. | ||
| SCMCI_INDICATOR | Optional | Numeric |
|
This field denotes the Stored Credential Transaction Indicator. This is a Required field for stored credential transaction and the value should be set as 1. NOTE: Value 2 is applicable to Worldpay Direct. Value 1 and 3 are applicable to GSC. Value 1 and 2 are applicable to UGP. | ||
| SCMCI_REASON | Character | Numeric |
|
This field indicates the message as reason code for the SCMCI indicator to host. It is a passthrough field. NOTE: This is applicable to UGP only. | ||
| CDD_DATA | Optional | Character | 1 | 10000 | Customer Defined Data. This field is optional and the datatype is String. It is a pass through field and it is passed in the host request if this field is present in the POS request and also returned in POS response. This field is applicable for all payment transactions. NOTE: In case of UGP with PWC processor, SCA supports up to 30 characters of data. For other Hosts, application supports 10000 characters of data. Example: <CDD_DATA>INV200471</CDD_DATA> |
|
| DEPARTMENT_CODE | Optional | Character | 40 | Department code. Application will accept this field in the POS Request and the same will be forwarded in the host request. Example: <DEPARTMENT_CODE>Verifone01!</DEPARTMENT_CODE> |
||
| TOKEN_TYPE | Optional | Character | LVT (Low Value Token) | Token type. A limited used token called Low Value Token (LVT) is introduced. This is a transactional token that has 24-hour duration for expiration. This LVT can be used the same manner as the current High Value Token/Omni-Token (HVT) is used. If this field is not sent, then HVT will be used by default. If TOKENIZE is set to ‘0’ and the POS sends a command request with TOKEN_TYPE=LVT then the terminal will request an LVT token. This field is applicable for Worldpay Direct only. Refer to Application Parameters table for more details on TOKENIZE parameter. | ||
| PROMO_SPECIAL_FIN_IND | Optional | Character | 2 | 2 | Promo Special Financial Indicator. To request the promotional APR(s) (Annual Percentage Rate). This field will also contain the result of the promotional requests. As of this publication, this field is applicable for GSC only. Refer to Notes on PROMO fields for additional details. Examaple: 02 | |
| PROMO_PLAN_CODE | Optional | Character | 3 | 3 | Promo Plan Code. This field contains the promotional code for the cards applicable for Retail Special Financing clients. As of this publication, this field is applicable for GSC only. Refer to Notes on PROMO fields for additional details. Examaple: A54 | |
| PROMO_PLAN_EXP_DATE | Optional | Character | 6 | 6 | Promo Plan Expiry Date. This field contains the promotional plan expiration date. This is a passthrough field for the application. Merchant or POS receives the format from the processor or gateway to configure. As of this publication, this field is applicable for GSC only and the format is yyyy-mm-dd. Refer to Notes on PROMO fields for additional details. Example: 122024 | |
| PROMO_NEEDED | Optional | Character | 4 | This field is sent from POS in case of PLCC (Private Label Credit Card) transactions. This will be sent in host request. This field is Required only for PLCC transactions with maximum length of 4 characters. This field is also applicable to CLOSE_TAB, FORCE, and COMPLETION commands. As of this publication, this field is applicable for Worldpay solutions only. Examaple: 0999 | ||
| COL_3, COL_4, COL_5, COL_6, COL_7, COL_8, COL_9, COL_10 | Optional | Character | 1 | 255 | These fields represent Column 3 to Column 10. These fields are expected for the Merchants internal POS System, which will record any additional data and link those to the PWC CLIENT_ID and CTROUTD. When a value for COL_n is passed in, that same value will be returned in the response. These COL_n values are not indexed, or searchable in any command report. These fields are not sent to any payment processor. These fields are sent in SAF transaction request. Example: Merchant defined data | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is used to authenticate the POS. Example: 100 | |
| MAC | Required | Base64 Encoded Data | N/A | N/A | Message Authentication Code. This is used to authenticate the POS. | |
| MAC_LABEL | Required | Character | 1 | 50 | Associated label that tells the device which MAC_KEY to use to decrypt the value of MAC. This is used to authenticate the POS. Example: REG1 |
Level II
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| TAX_AMOUNT | Conditional | Floating point number | 1(2) | 6(2) | Tax amount. Example: 5.00 | |
| TAX_IND | Conditional | List |
|
Tax indicator | ||
| CMRCL_FLAG | Conditional | List |
|
Commercial flag | ||
| CUSTOMER_CODE | Conditional | Character | 1 | 25 | Customer code | |
| RETAIL_ITEM_DESC_1 | Conditional | Character | 1 | 40 | Default is (empty) | Items description |
| ALLOW_DUP_TRAN | Conditional | Character | 1 | 40 | User can send this field if the previous CAPTURE transaction in the same session was declined as “DUPLICATE TRANSACTION”. The user must send ALLOW_DUP_TRAN tag with the same value as the INVOICE of current transaction in the current CAPTURE command. Refer to Duplicate Detection section for more details on the ALLOW_DUP_TRAN tag. Examaple: TA1234 |
Keyed Account Information for Gift Card and Credit Card Payment Types Only
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| ACCT_NUM | Optional | Numeric | 1 | 25 | This field is used to enter the account number manually. For this field, MANUAL_ENTRY must be set to TRUE. Pre-swipe data will not be honored. Examaple: 67823456781313 | |
| CARD_EXP_MONTH | Optional | Numeric | 2 | 2 | Card expiry month. Examaple: 12 | |
| CARD_EXP_YEAR | Optional | Numeric | 2 | 2 | Card expiry month. Examaple: 49 | |
| BARCODE | Optional | Character | 1 | 100 | Barcode scanning option. | |
| PIN_CODE | Optional | Numeric | 1 | 10 | PIN code. | |
| CVV2 | Optional | Numeric | 1 | 10 | Card Verification Value 2. |
FSA/HSA (Payment type CREDIT only)
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| AMOUNT_HEALTHCARE | Conditional | Floating point number | 1(2) | 6(2) | Total FSA-eligible amount. Required for FSA. Example: 5.00 | |
| AMOUNT_PRESCRIPTION | Optional | Floating point number | 1(2) | 6(2) | FSA-eligible prescription amount. Example: 2.00 | |
| AMOUNT_VISION | Optional | Floating point number | 1(2) | 6(2) | FSA-eligible vision amount. Example: 1.00 | |
| AMOUNT_CLINIC | Optional | Floating point number | 1(2) | 6(2) | FSA-eligible clinic amount. Example: 1.00 | |
| AMOUNT_DENTAL | Optional | Floating point number | 1(2) | 6(2) | FSA-eligible dental amount. Example: 1.00 |
Checks (Payment type CHECK_SALE or CHECK_VERIFY)
Refer to Check Processing for the sample request and response.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| MICR | Conditional | Character | 128 | Check transactions with MICR. As of RCHI 1.00.10 B4, if this is sent, then the transaction will process as Telecheck ECA. For FDRC, the maximum length for MICR is 113. Example: T999999992T1234567890111O3241 | ||
| ABA_NUM | Conditional | Numeric | 10 | Required if MICR not sent. Example: 123456789 | ||
| ACCT_NUM | Conditional | Numeric | 6 | 40 | Required if MICR not sent. Examaple: 656565656565 | |
| CHECK_NUM | Character | Numeric | 10 | Required if MICR not sent. Examaple: 1234 | ||
| CHECK_TYPE | Optional | List |
|
Check type. For FDRC, value 0 and 1 are applicable only. | ||
| DL_STATE | Optional | Character | 2 | 2 | Driver’s license state abbreviation. Examaple: CA | |
| DL_NUMBER | Optional | Character | 1 | 12 | Driver’s license number. NOTE: For FDRC, the maximum length for DL_NUMBER is 37. For GSC, the maximum length for DL_NUMBER is 16 characters. Examaple: A1234567 | |
| CUSTOMER_DOB | Optional | Numeric | 8 | 8 | Date of Birth (MMDDYYYY). Examaple: 01281974 | |
| ECA_BILL_NUM | Optional | Numeric | 1 | 25 | ECA bill number. This is a Host specific field for FDRC. Examaple: ECABCN |
Processor-Specific Private Label (ADS)
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| CREDIT_PLAN_NBR | Conditional | Numeric | 1 | 15 | Credit plan number, as required by processor. This is applicable for Completion transaction. | |
| PROMO_CODE | Optional | Character | 1 | 10 | Promo Code is a code defined by the merchant that affects the calculation from amount and units to points. Example: <PROMO_CODE>000001</PROMO_CODE> |
Processor-Based Token (Conditional)
Note
For use with host based processors supporting card based token implementations.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| TKN_RENEW | Conditional | Character | 1 | Valid value: 1 | Application will send this field to the Gateway, requesting for Token renewal. As of this publication, this is applicable for UGP only. | |
| CARD_TOKEN | Conditional | Character | 1 | 40 | Card token is processor-based or gateway-based and can represent a unique card. Refer to Two Way Card Token section. Example: 7987654321098765 | |
| DCC_IND | Conditional | Numeric | 1 | 1 |
|
DCC Indicator. |
| CARD_EXP_MONTH | Conditional | Numeric | 2 | Card expiry month details are required when sending AUTH_CODE and CARD_TOKEN. This is applicable to SCA Fiserv and Direct to Worldpay implementations only. | ||
| CARD_EXP_YEAR | Conditional | Numeric | 2 | Card expiry year details are required when sending AUTH_CODE and CARD_TOKEN. This is applicable to SCA Fiserv and Direct to Worldpay implementations only. | ||
| BANK_USERDATA | Conditional | Character | 1 | 50 | Returned with CARD_TOKEN. Whatever comes back with BANK_USERDATA in the response for the token should also be sent in the request. Example: 01/00/02/Visa/ | |
| OC_INDUSTRY_CODE | Conditional | Character | 1 | 1 |
|
This is used to convert a transaction from the Merchants default industry of Retail or Restaurant to E-Commerce or MOTO. This is used only in case of UGP host. |
Preset Counter Tip
Note
This section is applicable for CAPTURE, COMPLETION, CLOSE_TAB, FORCE transactions.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| PRESET_TIP_AMOUNT1 | Optional | Floating point number | 1(2) | 6(2) | Preset counter TIP amount 1. Maximum value possible would be 999999.99$. Example: 4.00 | |
| PRESET_TIP_AMOUNT2 | Optional | Floating point number | 1(2) | 6(2) | Preset counter TIP amount 2. Maximum value possible would be 999999.99$. Example: 2.00 | |
| PRESET_TIP_AMOUNT3 | Optional | Floating point number | 1(2) | 6(2) | Preset counter TIP amount 3. Maximum value possible would be 999999.99$. Example: 1.00 | |
| PRESET_TIP_AMOUNT4 | Optional | Floating point number | 1(2) | 6(2) | Preset counter TIP amount 4. Maximum value possible would be 999999.99$. Example: 0.20 | |
| PRESET_TIP_PCT1 | Conditional | Numeric | 1 | 3 | This field must be present if PRESET_TIP_AMOUNT1 is present. Maximum value is 100. Example: 20 | |
| PRESET_TIP_PCT2 | Conditional | Numeric | 1 | 3 | This field must be present if PRESET_TIP_AMOUNT2 is present. Maximum value is 100. Example: 10 | |
| PRESET_TIP_PCT3 | Conditional | Numeric | 1 | 3 | This field must be present if PRESET_TIP_AMOUNT3 is present. Maximum value is 100. Example: 5 | |
| PRESET_TIP_PCT4 | Conditional | Numeric | 1 | 3 | This field must be present if PRESET_TIP_AMOUNT4 is present. Maximum value is 100. Example: 1 |
Pay with Points
Note
REWARDSENABLED parameter (Application Parameters) is used to enable the feature to receive and send reward related fields. Refer to Pay with Points Sale Request for sample request and Pay with Points for more details on this feature.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| INVOICE | Character | Numeric | To process a transaction as Pay with Points, INVOICE should always be NUMERIC type. Along with the correct REWARD fields, if merchant provides Numeric INVOICE only, then PWC will send it to host as Pay with Points transaction. If INVOICE is not provided or if Non-Numeric INVOICE, then it is provided by merchant/device, PWC will process it as normal transaction without Pay with Points. This field is a Required for Pay with Points transactions. |
Stored Credential on File transaction - Worldpay
- The following fields are specific to WorldPay only.
- These are added for Credential on File transaction, in which a cardholder explicitly authorizes the merchant to store the cardholder’s account information and subsequently authorizes that same merchant to bill them.
- Credential on File transaction option is supported only in Credit payment type.
- CUSTOMER_ID, CUSTOMER_EMAIL, CUSTOMER_PHONE_NUM tags will be sent from POS in G059 (Customer Order Information) in the request packet and CUSTOMER_NAME_ON_CARD tag will be sent from POS in G063 (Merchant Fraud Customer Name) in the request packet.
Note
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| CUSTOMER_ID | Optional | Conditional | 0 | 32 | Customer order ID. | |
| CUSTOMER_EMAIL | Optional | Conditional | 0 | 64 | Customer email. | |
| CUSTOMER_PHONE_NUM | Optional | Numeric | 10 | Customer phone number. | ||
| CUSTOMER_NAME_ON_CARD | Optional | Conditional | 0 | 20 | Customer name on card. |
Stored Credential Charge transaction (Conditional)
Note
All the fields are applicable for GSC, however COF_REFERENCE field applicable for UGP as well. Refer to Stored Credential transaction for the sample request and response.
| Field | Rule | Type | Minimum | Maximum | Value(s) | Description |
|---|---|---|---|---|---|---|
| COF_REFERENCE | Reruired | Character | Maximum length 50 | For GSC, this is the Signup Reference UUID. For UGP, this is SCMCI host field for charge transaction. | ||
| COF_PROCESSOR_TRANS_ID | Optional | Character | Maximum length 128 | Signup Processor Transaction ID. Maps to POS Request field: PROCESSOR_TRANS_ID | ||
| COF_ISSUER_AUTH_RESULT | Optional | Character | Maximum length 50 | Signup Issuer Authorisation Result. | ||
| COF_ACQ_AUTH_RESULT | Optional | Character | Maximum length 50 | Signup Acquirer Authorisation Result. | ||
| COF_ACQ_REFERENCE_DATA | Required | Character | Maximum length 200 | Signup Acquirer Reference Data. | ||
| COF_SCHEME_REFERENCE_DATA | Optional | Character | Maximum length 200 | Signup Scheme Reference Data. | ||
| COF_AUTH_CODE | Required | Numeric | Maximum length 10 | Signup Authorisation Code. Maps to POS Request field: AUTH_CODE | ||
| COF_ACQ_RESP_DATETIME | Required | Character | Maximum length 30 | Signup Acquirer Response Date/Time. Maps to POS Request field: ACQUIRER_DATETIME. | ||
| COF_SETTLEMENT_DATE | Optional | Character | Maximum length 30 | Signup Settlement Date. |
- PROMO_SPECIAL_FIN_IND, PROMO_PLAN_CODE and PROMO_PLAN_EXP_DATE fields are applicable for Post Authorization transactions.
- If PROMO_PLAN_CODE is sent and PROMO_SPECIAL_FIN_IND is not sent, then the Promo Special Financial Indicator will consider the configured value from PROMOSPECIALFININD parameter.
- If PROMO_PLAN_CODE is sent and PROMO_PLAN_EXP_DATE is not sent, then the Promo Expiry Date will consider the configured value from PROMOEXPIRYDATE parameter.
Note
Example
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<COUNTER>1</COUNTER>
<MAC> … </MAC>
<MAC_LABEL>REG2</MAC_LABEL>
<TRANS_AMOUNT>5.00</TRANS_AMOUNT>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<TAX_IND>1</TAX_IND>
<RETAIL_ITEM_DESC_1>FOOD1</RETAIL_ITEM_DESC_1>
<PAYMENT_TYPES>CREDIT|DEBIT|GIFT|FSA</PAYMENT_TYPES>
<ENCRYPT>TRUE</ENCRYPT>
<FORCE_FLAG>FALSE</FORCE_FLAG>
<RECURRING>Y</RECURRING>
<BILLPAY>TRUE</BILLPAY>
<OC_INDUSTRY_CODE>M</OC_INDUSTRY_CODE>
<SCMCI_INDICATOR>2</SCMCI_INDICATOR>
</TRANSACTION>
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: SUCCESS/APPROVAL(VHI)/APPROVED(RCHI and CPHI) | |
| RESULT | Character | This indicates the Result details. Commonly CAPTURED or DECLINED. Example: SUCCESS (CPHI) or CAPTURED (VHI) or APPROVED (RCHI) or DECLINED. | |
| RESULT_CODE | Numeric | Expected result code: 4, 5, 6, 59074 | This indicates the result code. Refer to Result/Error Codes for details. |
| RESPONSE_CODE | Character | A and E | Response code data will be returned to POS, same as received from the Host if this is present in Host response. Example: <RESPONSE_CODE>E</RESPONSE_CODE> |
| TERMINATION_STATUS | Character | SUCCESS or FAILURE | This indicates the transaction termination status. This is the overall status of the transaction irrespective of approved or declined. Like, if the output is generated then the status is SUCCESS and if no output is generated then the status will be FAILURE. |
| COUNTER | Numeric | Echoes counter sent in the request. Example: 100 | |
| TROUTD | Numeric | Transaction routing ID (not meaningful for direct host integrations). Example: 000042 | |
| CTROUTD | Numeric | CTROUTD is a sequence number for PAYMENT transactions (always enabled) that is generated per Client ID. Each Client ID has its own CTROUTD sequence counter. For private label transaction (ADS), PT_CTROUTD field will be mapped to CTROUTD field back to SCA. In case of APM transaction, if this field is present, then order ID will be received from alternate payment method. For example, Alipay, Klarna, WeChat, PayPal, Venmo. Example: 028660198 | |
| TRANS_SEQ_NUM | Numeric | Processor/Batch trans sequence number (not meaningful for direct host integrations). For private label transaction (ADS), PT_SEQ_NUM field will be mapped to TRANS_SEQ_NUM and TROUTD fields back to SCA. Example: 000042 | |
| INTRN_SEQ_NUM | Numeric | PWC transaction ID (not meaningful for direct host integrations). Example: 000042 | |
| LPTOKEN | Numeric | LP Token is a non-sensitive unique number assigned to each unique card number processed with the UGP gateway. This value will automatically increment by one for each unique card number. This is a conditional field. Refer to Responses from Point section in Message Format. Example: 12357 | |
| TOKEN_TYPE | Character | Returns low value token type, if sent as the query request field. This field is applicable for Worldpay Direct only. | |
| EMV_TAGS | Character | This is returned for Early Card Capture payment flows for Non PCI card BIN ranges, only when EMV_TAGS_REQD is sent as Y. | |
| CMRCL_FLAG | Character | P (purchase card) | This is returned for Early Card Capture payment flows, when the application analyses the card as Purchase card through the BIN ranges data using CommercialCards.DB. Example: <CMRCL_FLAG>P</CMRCL_FLAG> |
| TKN_EXPDATE | Token expiration date. May be sent on Payment Transaction or Token Query transaction to override default expiration date assigned to the Token. Example: 07022021 | ||
| TKN_MATCHING | Matching Token. This is a non-reversible token used for matching purposes. For example, loyalty tracking. Example: 3278483765646148999 | ||
| TKN_USED |
|
Whether the Token is used. | |
| DEPARTMENT_CODE | Character | Application returns the field on the POS Response. If value of this field gets changed in the host response, then the updated value will be sent to POS. | |
| PAYMENT_TYPE | Character | Type of payment (example, CREDIT, DEBIT, APM, CHECK). PAYMENT_TYPE field will return the value, if this is entered in capture request. Example: CREDIT | |
| PAYMENT_MEDIA | Character | Commonly VISA/MC/DISC/AMEX/DEBIT | Mode of payment |
| MERCHID | Numeric | Merchant ID. Example: 900000000123 | |
| TERMID | Numeric | Terminal ID. Example: 001 | |
| SERVER_ID | Numeric | Echoes what is sent in START request. Example: 10 | |
| CASHIER_ID | Character | Echoes what is sent in START request. Example: 10 | |
| EBT_TYPE | Character | Indicates processed EBT transaction. FOOD_STAMP or CASH_BENEFITS. Example: FOOD_STAMP | |
| ACCT_NUM | Numeric | This field returned as masked account number. Example: 400555******0019 | |
| ACCOUNT_TYPE | Character | Indicates the type of debit account based on the selection on the customer. Example: CHECKING/SAVINGS | |
| AUTH_CODE | Character | Processor authorization number. Example: TA01561 | |
| AVAILABLE_BALANCE | Floating point number | Available balance on the card used for transaction. This field will be returned to POS, when the Host returns the Available Balance data. SCA application sends <BALANCE_ENQ> as Host request field and based on the processor, it returns the Available Balance, and SCA will send it back to POS. Example: 0.01 | |
| APPROVED_AMOUNT | Floating point number | Amount approved on authorization. Example: 5.00 | |
| DIFF_AMOUNT_DUE | Floating point number | For partial authorizations – remaining payment amount (TRANS_AMOUNT – APPROVED_AMOUNT). Applicable if PARTIALAUTH6 configuration parameter (Host Specific parameter) is enabled. Example: 2.00 | |
| ORIG_TRANS_AMOUNT | Floating point number | Conditionally returned when supplied in the host response. | |
| FSA_AMOUNT | Floating point number | Indicates processing with FSA items in transaction. FSA amount. Example: 5.00 | |
| CASHBACK_AMNT | Floating point number | Returned for Debit or EBT Cash Benefits transactions with cash back. Example: 10.00 | |
| TIP_AMOUNT | Floating point number | Returned if counter tip selected or if TIP_AMOUNT sent in request. Example: 2.00 | |
| FS_AVAIL_BALANCE | Floating point number | Available balance on EBT SNAP card. 0.00 | |
| CB_AVAIL_BALANCE | Floating point number | Available balance on EBT Cash Benefits card. Example: 0.00 | |
| CARD_ENTRY_MODE | Character | Returns the card entry mode value. Refer to Card Entry Mode for details on possible values. Example: Swiped | |
| CARDHOLDER | Character | Returned for swiped/insert transactions. Example: Doe/John | |
| CARD_EXP_MONTH | Numeric | Card expiry month. Example: 12 | |
| CARD_EXP_YEAR | Numeric | Card expiry year. Example: 20 | |
| AVS_CODE | Character | Result of AVS check. Example: Z | |
| CVV2_CODE | Character | Result of CVV2 check. Example: M | |
| SERVER_ID | Numeric | Echoes what is sent in START request. Example: 10 | |
| CASHIER_ID | Numeric | Echoes what is sent in START request. Example: 10 | |
| CUSTOMER_ZIP | Numeric | Returned when zip code is captured with MANUAL_PROMPT_OPTIONS in request. Example: 02134 | |
| MERCH_DECL | Character |
|
Merchant decline codes will return when this is configured. It returns when declined by Host due to AVS/CVV mismatch. |
| MERCH_REF | Character |
|
Merchant reference will return when this is configured. It returns when declined by Host due to AVS/CVV mismatch. |
| AUTH_RESP_CODE | Character | Returned by some processors when the transaction is declined. Maximum 19 bytes. Example: 0131 | |
| BANK_USERDATA | Character | Bank User Data, normally returned with CARD_TOKEN. Maximum 50 alphanumeric. Example: /CustData`JANE`K`DOE`````00` | |
| EMBOSSED_ACCT_NUM | Numeric | Card number conditionally returned if present in the SSI response. Returned if payment type = GIFT and returnembossednumforgift is enabled. Example: 6499991111115789 | |
| SAF_NUM | Numeric | Returned instead of CTROUTD when transaction has been put in SAF. SAF number is per device. Example: 0008 | |
| RECEIPT_DATA | Receipt Data | Refer to Receipt Data in Response section for more details. | |
| ISSUER_RECEIPT_TEXT | Character | Additional text to print on transaction receipt, which optionally may be provided by the issuer. | |
| TRANS_DATE | Character | Transaction date returned. Example: 2016.09.20 | |
| TRANS_TIME | Character | Transaction time returned. Example: 09:16:25 | |
| TRAINING_MODE | Character | Conditionally returned when session is in Training Mode. Example: ON | |
| TRAN_LANG_CODE | Character |
|
This field contains the language code for the current transaction which is finalized based on the configured language on terminal and language preference from the card. This field will be returned only whenever the Card data is captured from cardholder during transaction flow. If Language code is not available from card, then terminal language will be returned. This field needs to be added for the below transaction flows. |
| VSP_CODE | Numeric | If present, returns the VSP code. Example: 100 | |
| VSP_RESULTDESC | Character | If present, returns the VSP result description. Example: Success | |
| VSP_TRXID | Numeric | If present, returns the VSP transaction ID. Example: 987696060049091234 | |
| PPCV | Character | This field is sent from the Host Response to POS Response, without any change. This field will be returned in case of Force transaction. Example: CBCC.WSI | |
| TRACE_NUM | Numeric | This field is sent from the Host Response. This field contains the Interac Sequence number from the host. Examaple: 1400040000000004001951 | |
| CDD_DATA | Character | Customer Defined Data field is returned in POS response when it is present in the POS request and passed in the host request. Example: <CDD_DATA>INV200471</CDD_DATA> |
|
| SIGNATUREDATA | Base64 Encoded Data | Signature data. | |
| TRANS_CURRENCY_CODE | Numeric | Ex: 0840 |
|
| PROMO_SPECIAL_FIN_IND | Character | Ex: 02 | This field is used to request the promotional APR(s) (Annual Percentage Rate). This field will also contain the result of the promotional requests. As of this publication, this field is applicable for GSC only. |
| PROMO_APR_FLAG | Character | Ex: 10 | This field identifies the type of the APR, which will be applied during the promotional period. As of this publication, this field is applicable for GSC only. |
| PROMO_APR | Character | This field contains the APR, which will be applied during the promotional period. As of this publication, this field is applicable for GSC only. | |
| AFTER_PROMO_FLAG | Character | Ex: 01 | This field identifies the type of the APR, which will be applied after the promotional period. As of this publication, this field is applicable for GSC only. |
| AFTER_PROMO_APR | Character | This field contains the APR, which will be applied after the promotional period. As of this publication, this field is applicable for GSC only. | |
| PROMO_DURATION | Character | This field contains the promo duration. As of this publication, this field is applicable for GSC only. | |
| PROMO_DESCRIPTION | Character | This field contains the promo description. As of this publication, this field is applicable for GSC only. | |
| HOST_PAYTYPE | Character | Ex: CREDIT | This field is sent back to POS when the Debit Optimization feature is applied for a transaction. If Debit Optimization flag in G035 (EMV Tag Data) is sent in the Worldpay host response, then HOST_PAYTYPE with the value ‘CREDIT’ will be sent back in the POS response. In other cases, this field will be absent in the POS response. As of this publication, this field is applicable for Worldpay only. |
| PROMO_NEEDED | Character | Ex: 0999 | This field is sent back to POS in case of PLCC (Private Label Credit Card) transactions. As of this publication, this field is applicable for Worldpay only. |
| AUTH_REF_NUMBER | Character | Example: 123456789012345 Or It can be empty | This tag returns in the host response with the value for the particular transaction. This is used by some merchants to refer to the transaction at the host side. This is also applicable for Completion transaction response. Currently this is applicable only for Worldpay processor. |
| COL_3, COL_4, COL_5, COL_6, COL_7, COL_8, COL_9, COL_10 | Character | Column 3 to Column 10 fields value will be echoed in POS response. These fields are not sent to any payment processor. |
Checks
Refer to Check Processing for the sample request and response.
| Field | Type | Value | Description |
|---|---|---|---|
| DENIAL_REC_NUM | Numeric | Check response field conditionally returned for declined transactions. Example: 1234567 | |
| RETURN_CHECK_FEE | Floating point number | Check response field. Example: 25.00 | |
| RETURN_CHECK_NOTE | Character | Check response field. Example: Above fee increases to 30.01 + 12% interest if …” |
APM Based Respose Fields - (Conditional)
Refer to Transaction using APM for the more details on sample request and response.
| Field | Type | Value | Description |
|---|---|---|---|
| APM_TRAN | Numeric |
|
This field returns to indicate if the current transaction is performed with alternate payment method. |
| CP_MERCH_RECEIPT_DATA | Character | Additional field will be sent along with RECEIPT_DATA field. | |
| CP_CUST_RECEIPT_DATA | Character | Additional field will be sent along with RECEIPT_DATA field. |
POS-defined Tender Response Fields - (Conditional)
Refer to POS Defined Tender Response for the sample response.
| Field | Type | Value | Description |
|---|---|---|---|
| POS_TENDER1_DATA | Character | Track II Data or NOTIFICATION (or not sent) dependent on TENDER1_ACTION in request. Example: 545454******1111 | |
| POS_TENDER2_DATA | Character | Dependent on TENDER2_ACTION in request. | |
| POS_TENDER3_DATA | Character | Dependent on TENDER3_ACTION in request. |
Processor-Based Token (Conditional)
Note
For use with host based processors supporting card based token implementations.
| Field | Type | Value | Description |
|---|---|---|---|
| CARD_TOKEN | Character | Card token. Example: 7987654321098765 | |
| TOKEN_SOURCE | Character | Source of token. Example: PWC |
Duplicate Detection Response Fields (Conditional)
Note
Refer to Duplicate Detection section for more details.
| Field | Type | Value | Description |
|---|---|---|---|
| DUP_ACCT_NUM | Numeric | Duplicate detection for account number. This is Conditional field. Example: 400555******0019 | |
| DUP_AUTH_CODE | Character | Duplicate detection for authorization code. This is Conditional field. Example: 123123 | |
| DUP_AVS_CODE | Character | Duplicate detection for AVS code. This is Conditional field. Example: Y | |
| DUP_CTROUTD | Numeric | Duplicate detection for CTROUTD. This is Conditional field. Example: 45 | |
| DUP_CVV2_CODE | Character | Duplicate detection for CVV2 code. This is Conditional field. Example: M | |
| DUP_INVOICE | Character | Duplicate detection for invoice. This is Conditional field. Example: IN045 | |
| DUP_PAYMENT_MEDIA | Character | Duplicate detection for mode of payment. This is Conditional field. Example: VISA | |
| DUP_TRANS_AMOUNT | Floating point number | Duplicate detection for transaction amount. This is Conditional field. Example: 5.00 | |
| DUP_TRANS_DATE | Date | Duplicate detection for transaction date. This is Conditional field. Example: 2016.09.26 | |
| DUP_TRANS_TIME | Time | Duplicate detection for transaction time. This is Conditional field. Example: 13:05:22 |
Pay with Points (Conditional)
Note
Refer to Pay with Points Sale Response for sample response and Pay with Points section for more details.
| Field | Type | Value | Description |
|---|---|---|---|
| REWARD_DISCOUNT_AMOUNT | Numeric | Discount amount. Example: 12.00 | |
| REWARD_LOYALTY_TRANS_ID | Character | Loyalty transaction Id. Example: 1234567890ABCDE | |
| REWARD_ID | Character | Reward Id. Example: RD0000016891 | |
| REWARD_PROMOTION_ID | Character | Promotion Id. Example: RD000001689 | |
| REWARD_PROMPT_TEXT | Character | Text prompted for the reward. Example:* LOYALTY REWARDS | |
| REWARD_OPT_IN | Numeric |
|
Duplicate Transaction (Conditional)
| Field | Type | Value | Description |
|---|---|---|---|
| DUPLICATE_TRANSACTION | Character | 1 - Duplicate transaction detected | A duplicate transaction is detected if the same card is swiped in the context of two consecutive cash-less purchase transactions on the same PIN pad. The DUPLICATECHECK parameter must be enabled on Engage device. |
Stored Credential transaction (Conditional)
Note
All the fields are applicable for GSC, however COF_REFERENCE field applicable for UGP as well. Refer to Stored Credential transaction for the sample request and response.
| Field | Type | Value | Comments |
|---|---|---|---|
| COF_REFERENCE | Character | Maximum length is 50. | The Stored Credential Signup Reference UUID (Universally Unique IDentifier) is the reference for the signup request returned for approved stored credential signup transactions. This will be used for the subsequent Stored Credential Charge transaction if returned by the host. This field is also applicable to UGP. SCMCI field is returned from the processor on an Initial transaction (Store Credentials) and the value will be sent in COF_REFERENCE field in POS. |
| PROCESSOR_TRANS_ID | Character | Maximum length is 128. | The transaction ID used by the processor for the transaction which may be required in a later refund or reversal transaction. This may be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| COF_ISSUER_AUTH_RESULT | Character | Maximum length is 50. | Issuer authorization result. This may be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| COF_ACQ_AUTH_RESULT | Character | Maximum length is 50. | Acquirer authorization result. This may be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| COF_ACQ_REFERENCE_DATA | Character | Maximum length is 200. | That Acquirer Reference Data that may represent the acquirer transaction identifier. This will be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| COF_SCHEME_REFERENCE_DATA | Character | Maximum length is 200. | The Scheme Reference Data sent by the acquirer in the authorization response message and sent in a subsequent authorization request messages associated with the same transaction. This may be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| ACQUIRER_DATETIME | Character | Maximum length is 30. | The date returned in the authorization response message. This will be used for the subsequent Stored Credential Charge transaction if returned by the host. |
| COF_SETTLEMENT_DATE | Character | Maximum length is 30. | The date that reflects either the desired Merchant settlement date or the actual settlement date depending on where the transaction request is within the payment lifecycle. This may be used for the subsequent Stored Credential Charge transaction if returned by the host. |
Dynamic Currency Conversion (DCC) Response Fields (Conditional)
| Field | Type | Value | Description |
|---|---|---|---|
| DCC_IND | Numeric |
|
DCC Indicator. |
| DCC_EXCHANGE_RATE | Floating point number | Ex: 1.7461 | Exchange rate for converting local currency to foreign currency. |
| DCC_ALPHA_CURR_CODE | Character | Ex: SGD | Currency code of the foreign transaction. |
| DCC_DATETIME | Date | Indicates the date and time, when the DCC conversion took place. | |
| DCC_TIMEZONE | Character | Time zone for the DCC_DATETIME, that will be provided in the device by the application or Merchants. | |
| DCC_TRAN_AMOUNT | Floating point number | Ex: 24.45 | Converted amount |
Example
Following is an example of response packet
<RESPONSE>
<ACCT_NUM>400555******0019</ACCT_NUM>
<APPROVED_AMOUNT>5.35</APPROVED_AMOUNT>
<AUTH_CODE>000047</AUTH_CODE>
<CARD_EXP_MONTH>12</CARD_EXP_MONTH>
<CARD_EXP_YEAR>20</CARD_EXP_YEAR>
<CTROUTD>426</CTROUTD>
<INTRN_SEQ_NUM>5013839</INTRN_SEQ_NUM>
<LPTOKEN>13781</LPTOKEN>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<ACCOUNT_TYPE>SAVINGS</ACCOUNT_TYPE>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<RESPONSE_TEXT>CAPTURED: AUTH/TKT 000047</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_DATE>2016.09.20</TRANS_DATE>
<TRANS_SEQ_NUM>1</TRANS_SEQ_NUM>
<TRANS_TIME>09:16:25</TRANS_TIME>
<TRAN_LANG_CODE>en</TRAN_LANG_CODE>
**<TROUTD>5013839</TROUTD>**
</RESPONSE>
Capture Sample with other Transaction Features
Partial Authorization
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<COUNTER>1</COUNTER>
<MAC>………..</MAC>
<MAC_LABEL>REG_2</MAC_LABEL>
<TRANS_AMOUNT>4.26</TRANS_AMOUNT>
<ENCRYPT>TRUE</ENCRYPT>
</TRANSACTION>
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>CAPTURED : 000 : AP</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRANS_SEQ_NUM>60</TRANS_SEQ_NUM>
<INTRN_SEQ_NUM>5726881</INTRN_SEQ_NUM>
<TROUTD>3839</TROUTD>
<CTROUTD>303</CTROUTD>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<ACCT_NUM>************8291</ACCT_NUM>
<AUTH_CODE>098822</AUTH_CODE>
<APPROVED_AMOUNT>2.00</APPROVED_AMOUNT>
<DIFF_AMOUNT_DUE>0.00</DIFF_AMOUNT_DUE>
<CARDHOLDER>VISA TEST</CARDHOLDER>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>635912345549651203</VSP_TRXID>
<ORIG_TRANS_AMOUNT>2.00</ORIG_TRANS_AMOUNT>
<RECEIPT_DATA>
Check Processing
Following is an example of request packet
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>14.00</TRANS_AMOUNT>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<PAYMENT_TYPE>CHECK_SALE</PAYMENT_TYPE>
<MICR>t123456780t 10987654321o 2233</MICR>
<DL_STATE>TX</DL_STATE>
<DL_NUMBER>44445555</DL_NUMBER>
<CHECK_TYPE>0</CHECK_TYPE>
<FORCE_FLAG>FALSE</FORCE_FLAG>
<ENCRYPT>TRUE</ENCRYPT>
</TRANSACTION>
Following is an example of response packet
<AUTH_CODE>1122</AUTH_CODE>
<CHECK_NUM>2233</CHECK_NUM>
<CTROUTD>814</CTROUTD>
<INTRN_SEQ_NUM>14000833988</INTRN_SEQ_NUM>
<REFERENCE>123456</REFERENCE>
<RESPONSE_TEXT>CAPTURED: 95 </RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<RETURN_CHECK_FEE>25.00</RETURN_CHECK_FEE>
<RETURN_CHECK_NOTE>Return Check Note Test Text </RETURN_CHECK_NOTE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRACE_NUM>1400040000000004001951</TRACE_NUM>
<TRANS_AMOUNT>14.00</TRANS_AMOUNT>
<TRANS_DATETIME>08/28/2020 07:06:19</TRANS_DATETIME>
<TRANS_SEQ_NUM>147</TRANS_SEQ_NUM>
<TROUTD>14000833988</TROUTD>
<VSP_TRXID>0</VSP_TRXID>
<VSP_CODE>910</VSP_CODE>
<VSP_RESULTDESC>VSP NOT APPLICABLE</VSP_RESULTDESC>
POS-Defined Tender
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>SUCCESS</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<POS_TENDER1_DATA>545454******1111</POS_TENDER1_DATA>
</RESPONSE>
EMV
Following is an example of response packet
<RESPONSE>
<RESPONSE_TEXT>CAPTURED : A : AP</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TROUTD>5013839</TROUTD>
<CTROUTD>539</CTROUTD>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<ACCT_NUM>************0119</ACCT_NUM>
<AUTH_CODE>006235</AUTH_CODE>
<APPROVED_AMOUNT>12.00</APPROVED_AMOUNT>
<DIFF_AMOUNT_DUE>0.00</DIFF_AMOUNT_DUE>
<TRANS_SEQ_NUM>60</TRANS_SEQ_NUM>
<INTRN_SEQ_NUM>5726881</INTRN_SEQ_NUM>
<CARDHOLDER>DI Test Card</CARDHOLDER>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>635961234544864930</VSP_TRXID>
<ORIG_TRANS_AMOUNT>12.00</ORIG_TRANS_AMOUNT>
<EMV_TAG_4F>A0000000031010</EMV_TAG_4F>
<EMV_TAG_50>Visa Credit</EMV_TAG_50>
<EMV_TAG_82>1800</EMV_TAG_82>
<EMV_TAG_84>A0000000031010</EMV_TAG_84>
<EMV_TAG_8A>00</EMV_TAG_8A>
<EMV_TAG_9A>160415</EMV_TAG_9A>
<EMV_TAG_9B>6800</EMV_TAG_9B>
<EMV_TAG_9C>00</EMV_TAG_9C>
<EMV_TAG_5F20>DI Test Card</EMV_TAG_5F20>
<EMV_TAG_5F2A>0840</EMV_TAG_5F2A>
<EMV_TAG_5F34>01</EMV_TAG_5F34>
<EMV_TAG_9F02>000000001200</EMV_TAG_9F02>
<EMV_TAG_9F03>000000000000</EMV_TAG_9F03>
<EMV_TAG_9F07>FF00</EMV_TAG_9F07>
<EMV_TAG_9F08>0096</EMV_TAG_9F08>
<EMV_TAG_9F0D>B850AC8800</EMV_TAG_9F0D>
<EMV_TAG_9F0E>0000000000</EMV_TAG_9F0E>
<EMV_TAG_9F0F>B8709C9800</EMV_TAG_9F0F>
<EMV_TAG_9F10>06010A0360A000</EMV_TAG_9F10>
<EMV_TAG_9F12>Visa Credit</EMV_TAG_9F12>
<EMV_TAG_9F1A>0840</EMV_TAG_9F1A>
<EMV_TAG_9F26>40727A5697D04BCA</EMV_TAG_9F26>
<EMV_TAG_9F27>40</EMV_TAG_9F27>
<EMV_TAG_9F33>E0F8C8</EMV_TAG_9F33>
<EMV_TAG_9F34>5E0000</EMV_TAG_9F34>
<EMV_TAG_9F35>22</EMV_TAG_9F35>
<EMV_TAG_9F36>000D</EMV_TAG_9F36>
<EMV_TAG_9F37>3C10922D</EMV_TAG_9F37>
<EMV_TAG_9F40>F000F0A001</EMV_TAG_9F40>
<EMV_TAG_9F41>00000004</EMV_TAG_9F41>
<EMV_TAG_9FA081>80</EMV_TAG_9FA081>
</RESPONSE>
PITSTOP Solution
Following is an example of response packet
Note
For PITSTOP solution if external PIN Pad is not connected, then the application will return below response.
<RESPONSE>
<RESPONSE_TEXT>PINPAD Not Connected</RESPONSE_TEXT>
<RESULT>ERROR</RESULT>
<RESULT_CODE>59067</RESULT_CODE>
<TERMINATION_STATUS>FAILURE</TERMINATION_STATUS>
<COUNTER>15</COUNTER>
</RESPONSE>
Transaction using APM
Refer to Integration with APMs for more examples and details on transaction using APM.
Following is an example of request packet - Payment Type not Specified
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<COUNTER>...</COUNTER>
<MAC>...</MAC>
<MAC_LABEL>...</MAC_LABEL>
<TRANS_AMOUNT>5.00</TRANS_AMOUNT>
</TRANSACTION>
Following is an example of request packet - Payment Type Specified - as APM
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<PAYMENT_TYPE>PAYPAL</PAYMENT_TYPE>
<COUNTER>...</COUNTER>
<MAC>...</MAC>
<MAC_LABEL>...</MAC_LABEL>
<TRANS_AMOUNT>5.00</TRANS_AMOUNT>
</TRANSACTION>
Following is an example of response packet - Approved for Payment Type Specified – as APM
<RESPONSE>
<APPROVED_AMOUNT>1000.00</APPROVED_AMOUNT>
<AUTH_CODE>1423261445929360</AUTH_CODE>
<APM_TRAN>1</APM_TRAN>
<CTROUTD>1423261445929360</CTROUTD>
<INVOICE>2</INVOICE>
<MERCHID>RCTST0000042337</MERCHID>
<PAYMENT_TYPE>PAYPAL</PAYMENT_TYPE>
<RESPONSE_TEXT>APPROVED</RESPONSE_TEXT>
<RESULT>APPROVED</RESULT>
<RESULT_CODE>5</RESULT_CODE>
<TERMID>00000004</TERMID>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>1000.00</TRANS_AMOUNT>
<RECEIPT_DATA>
<RECEIPT>
<TEXTLINE> VERIFONE SCA </TEXTLINE>
<TEXTLINE> 11700 Great Oaks Way </TEXTLINE>
<TEXTLINE> Suite 210 </TEXTLINE>
<TEXTLINE> Alpharetta, GA 30022 </TEXTLINE>
<TEXTLINE/>
<TEXTLINE/>
<TEXTLINE> 07/04/2001:59:26 </TEXTLINE>
<TEXTLINE/>
<TEXTLINE> Merchant ID: RCTST0000042337 </TEXTLINE>
<TEXTLINE> Term ID: 00000004 </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> SALE </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> Appr Code: 1423261445929360 </TEXTLINE>
<TEXTLINE> Payment Type: PAYPAL </TEXTLINE>
<TEXTLINE> Invoice: 2 </TEXTLINE>
<TEXTLINE> Response: APPROVED </TEXTLINE>
<TEXTLINE />
<TEXTLINE> Total: USD $ 1,000.00 </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> NO SIGNATURE REQUIRED </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> Merchant Copy </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
</RECEIPT>
<RECEIPT>
<TEXTLINE> VERIFONE SCA </TEXTLINE>
<TEXTLINE> 11700 Great Oaks Way </TEXTLINE>
<TEXTLINE> Suite 210 </TEXTLINE>
<TEXTLINE> Alpharetta, GA 30022 </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> 07/04/20 01:59:27 </TEXTLINE>
<TEXTLINE />
<TEXTLINE> Merchant ID: RCTST0000042337 </TEXTLINE>
<TEXTLINE> Term ID: 00000004 </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> SALE </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> Appr Code: 1423261445929360 </TEXTLINE>
<TEXTLINE> Payment Type: PAYPAL </TEXTLINE>
<TEXTLINE> Invoice: 2 </TEXTLINE>
<TEXTLINE> Response: APPROVED </TEXTLINE>
<TEXTLINE />
<TEXTLINE>Total: USD $ 1,000.00</TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE> THANK YOU </TEXTLINE>
<TEXTLINE />
<TEXTLINE> Customer Copy </TEXTLINE>
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
<TEXTLINE />
</RECEIPT>
</RECEIPT_DATA>
<CP_MERCH_RECEIPT_DATA>
<CPAPP_1>DATE: 2020-07-04
TIME: 01:58:33
TERMINAL ID: 783257
INVOICE: 2
PAYPAL Payment
TRANSACTION ID: 2020 0704 2200 1457 7505 0104 1299
PARTNER TRANSACTION ID: 1423 2614 4592 9360
AMOUNT (USD): 1000.00
SUCCESS
NO SIGNATURE REQUIRED
</CPAPP_1>
</CP_MERCH_RECEIPT_DATA>
<CP_CUST_RECEIPT_DATA>
<CPAPP_1>DATE: 2020-07-04
TIME: 01:58:33
TERMINAL ID: 783257
INVOICE: 2
PAYPAL Payment
TRANSACTION ID: 2020 0704 2200 1457 7505 0104 1299
PARTNER TRANSACTION ID: 1423 2614 4592 9360
AMOUNT (USD): 1000.00
SUCCESS
NO SIGNATURE REQUIRED
I AGREE TO PAY THE ABOVE TOTAL AMOUNT
ACCORDING TO PAYPAL AGREEMENT
</CPAPP_1>
</CP_CUST_RECEIPT_DATA>
<COUNTER>3</COUNTER>
</RESPONSE>
Following is an example of response packet - Cancelled for Payment Type Specified – as APM
<RESPONSE>
<INVOICE>2</INVOICE>
<MERCHID>RCTST0000042337</MERCHID>
<RESPONSE_TEXT>Cancelled by Customer</RESPONSE_TEXT>
<RESULT>CANCELLED</RESULT>
<RESULT_CODE>59001</RESULT_CODE>
<TERMID>00000004</TERMID>
<TERMINATION_STATUS>FAILURE</TERMINATION_STATUS>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<COUNTER>2</COUNTER>
</RESPONSE>
Following is an example of response packet - Declined for Payment Type Specified – as APM
<RESPONSE>
<INVOICE>123456</INVOICE>
<MERCHID>RCTST0000042337</MERCHID>
<PAYMENT_TYPE>PAYPAL</PAYMENT_TYPE>
<APM_TRAN>1</APM_TRAN>
<RESPONSE_TEXT>DECLINED</RESPONSE_TEXT>
<RESULT>DECLINED</RESULT>
<RESULT_CODE>6</RESULT_CODE>
<TERMID>00000004</TERMID>
<TERMINATION_STATUS>FAILURE</TERMINATION_STATUS>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>11.00</TRANS_AMOUNT>
<COUNTER>6</COUNTER>
</RESPONSE>
Capture Card Early Return
Following is an example of request packet - First leg
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>10.00</TRANS_AMOUNT>
<CAPTURECARD_EARLYRETURN>TRUE</CAPTURECARD_EARLYRETURN>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<FORCE_FLAG>FALSE</FORCE_FLAG>
<MAC_LABEL>P_EJIOKG</MAC_LABEL>
<COUNTER>6</COUNTER>
<MAC>VoUZoGxHixlSl4js4LkwuaWRH9nXZKMe9eZRJa/4AL8=</MAC>
</TRANSACTION>
Following is an example of response packet - First leg
<RESPONSE>
<RESPONSE_TEXT>CAPTURE EARLY CARD NOTIFICATION</RESPONSE_TEXT>
<RESULT>OK</RESULT>
<RESULT_CODE>-1</RESULT_CODE>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<COUNTER>6</COUNTER>
<ACCT_NUM>514631******0035</ACCT_NUM>
<TRANS_AMOUNT>10.00</TRANS_AMOUNT>
<CARD_EXP_MONTH>**</CARD_EXP_MONTH>
<CARD_EXP_YEAR>**</CARD_EXP_YEAR>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PAYMENT_MEDIA>MASTERCARD</PAYMENT_MEDIA>
<CARD_ENTRY_MODE>Swiped</CARD_ENTRY_MODE>
<INVOICE>123456</INVOICE>
</RESPONSE>
Following is an example of request packet - Second leg
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>10.00</TRANS_AMOUNT>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<FORCE_FLAG>FALSE</FORCE_FLAG>
<MAC_LABEL>P_EJIOKG</MAC_LABEL>
<COUNTER>7</COUNTER>
<MAC>QhONVhb0Awe9JarPELPs0XaWBQhkeGRX2QK87zKEZY0=</MAC>
</TRANSACTION>
Following is an example of response packet - Second leg
<RESPONSE>
<ACCT_NUM>514631******0035</ACCT_NUM>
<COMMAND>CAPTURE</COMMAND>
<APPROVED_AMOUNT>10.00</APPROVED_AMOUNT>
<AUTHNWNAME>MASTERCARD</AUTHNWNAME>
<AUTHNWID>03</AUTHNWID>
<AUTH_CODE>OK0400</AUTH_CODE>
<BANK_USERDATA>MC</BANK_USERDATA>
<BATCH_TRACE_ID>2e8b2f62-3850-46f8-af9f-591b0ac24efa</BATCH_TRACE_ID>
<CARD_ABBRV>MC</CARD_ABBRV>
<CARD_ENTRY_MODE>Swiped</CARD_ENTRY_MODE>
<CARD_EXP_MONTH>**</CARD_EXP_MONTH>
<CARD_EXP_YEAR>**</CARD_EXP_YEAR>
<CARD_TOKEN>5146************</CARD_TOKEN>
<CTROUTD>75060</CTROUTD>
<INVOICE>123456</INVOICE>
<DCC_IND>2</DCC_IND>
<INTRN_SEQ_NUM>4016100317</INTRN_SEQ_NUM>
<MERCHID>005059233998</MERCHID>
<PAYMENT_MEDIA>MC</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<REFERENCE>000000000017</REFERENCE>
<RESPONSE_TEXT>APPROVAL - 000 </RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<TERMID>1126076</TERMID>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TRACE_CODE>100317</TRACE_CODE>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>10.00</TRANS_AMOUNT>
<TRANS_DATE>2022.07.12</TRANS_DATE>
<TRANS_SEQ_NUM>17</TRANS_SEQ_NUM>
<TRAN_LANG_CODE>en</TRAN_LANG_CODE>
<TRANS_TIME>02:37:29</TRANS_TIME>
<TROUTD>4016100317</TROUTD>
<VSP_CODE>100</VSP_CODE>
<VSP_RESULTDESC>Success</VSP_RESULTDESC>
<VSP_TRXID>637932046506101325</VSP_TRXID>
<COUNTER>7</COUNTER>
</RESPONSE>
Stored Credential Transaction
Following is an example of Request packet - First leg (Sign up)
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<SCMCI_INDICATOR>1</SCMCI_INDICATOR>
<INSTALLMENT>Y</INSTALLMENT>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<FORCE_FLAG>FALSE</FORCE_FLAG>
</TRANSACTION>
Following is an example of Response packet - First leg (Sign up)
<RESPONSE>
<ACCT_NUM>544400******2205</ACCT_NUM>
<ACQUIRER_DATETIME>2023-11-18T23:31:32Z</ACQUIRER_DATETIME>
<COF_ACQ_REFERENCE_DATA>MTAwHDE3MzE1MxwxOTMxNTAcHDEwMBwcQTAwMDE5MzE1MDExMTgcHBwzMzIyMTcxNzMxNTMcMzIyMDAwMDAxMTAwMDAwMRwc</COF_ACQ_REFERENCE_DATA>
<COMMAND>CAPTURE</COMMAND>
<APPROVED_AMOUNT>1.00</APPROVED_AMOUNT>
<AUTH_CODE>193150</AUTH_CODE>
<BANK_USERDATA>MASTERCARD</BANK_USERDATA>
<BATCH_TRACE_ID>1d708a81-1a30-455f-8e0c-9022f4937166</BATCH_TRACE_ID>
<CARDHOLDER>TEST-VOID/TEST</CARDHOLDER>
<CARD_ABBRV>MC</CARD_ABBRV>
<CARD_ENTRY_MODE>Swiped</CARD_ENTRY_MODE>
<CARD_EXP_MONTH>12</CARD_EXP_MONTH>
<CARD_EXP_YEAR>24</CARD_EXP_YEAR>
<CARD_TOKEN>aw97xuLMACC82sj8</CARD_TOKEN>
<CTROUTD>1d708a81-1a30-455f-8e0c-9022f4937166</CTROUTD>
<INVOICE>123456</INVOICE>
<HOST_RESPCODE>00</HOST_RESPCODE>
<MERCHID>700000013698</MERCHID>
<PAYMENT_MEDIA>MASTERCARD</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<REFERENCE>332217173153</REFERENCE>
<RESPONSE_TEXT>Approved</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>5</RESULT_CODE>
<COF_REFERENCE>44b23c8e-a51b-40d6-9c3c-167ce64dad58</COF_REFERENCE>
<TERMID>001</TERMID>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TOKEN_SOURCE>INTERNAL</TOKEN_SOURCE>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>1.00</TRANS_AMOUNT>
<TRANS_DATE>2023.11.18</TRANS_DATE>
<TRAN_LANG_CODE>en</TRAN_LANG_CODE>
<TRANS_TIME>17:31:53</TRANS_TIME>
<TRANS_CURRENCY_CODE>0840</TRANS_CURRENCY_CODE>
<COUNTER>8</COUNTER>
<RESPONSE>
Following is an example of Request packet - Second leg (Charge)
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>15.00</TRANS_AMOUNT>
<CARD_EXP_MONTH>12</CARD_EXP_MONTH>
<CARD_EXP_YEAR>24</CARD_EXP_YEAR>
<CARD_TOKEN>aw97xuLMACC82sj8</CARD_TOKEN>
<TOKEN_SOURCE>INTERNAL</TOKEN_SOURCE>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<BANK_USERDATA>MASTERCARD</BANK_USERDATA>
<COF_ACQ_RESP_DATETIME>2023-11-18T23:31:32Z</COF_ACQ_RESP_DATETIME>
<COF_ACQ_REFERENCE_DATA>MTAwHDE3MzE1MxwxOTMxNTAcHDEwMBwcQTAwMDE5MzE1MDExMTgcHBwzMzIyMTcxNzMxNTMcMzIyMDAwMDAxMTAwMDAwMRwc</COF_ACQ_REFERENCE_DATA>
<COF_REFERENCE>44b23c8e-a51b-40d6-9c3c-167ce64dad58</COF_REFERENCE>
<COF_AUTH_CODE>193150</COF_AUTH_CODE>
<SCMCI_INDICATOR>3</SCMCI_INDICATOR>
<RECURRING>Y</RECURRING>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<FORCE_FLAG>FALSE</FORCE_FLAG>
</TRANSACTION>
Following is an example of Response packet - Second leg (Charge)
<RESPONSE>
<ACQUIRER_DATETIME>2023-11-18T23:37:02Z</ACQUIRER_DATETIME>
<COF_ACQ_REFERENCE_DATA>MTUwMBwxNzM3MjEcMTkzMTc0HBwxNTAwHBxBMDAwMTkzMTc0MTExOBwcHDMzMjIxNzE3MzcyMRwzMjIwMDAwMDExMDAwMDAyHBw=</COF_ACQ_REFERENCE_DATA>
<COMMAND>CAPTURE</COMMAND>
<APPROVED_AMOUNT>15.00</APPROVED_AMOUNT>
<AUTH_CODE>193174</AUTH_CODE>
<BANK_USERDATA>MASTERCARD</BANK_USERDATA>
<BATCH_TRACE_ID>fe81c934-913a-481c-9b34-cdbdd80f63b7</BATCH_TRACE_ID>
<CARD_ABBRV>MC</CARD_ABBRV>
<CARD_EXP_MONTH>12</CARD_EXP_MONTH>
<CARD_EXP_YEAR>24</CARD_EXP_YEAR>
<CARD_TOKEN>aw97xuLMACC82sj8</CARD_TOKEN>
<CTROUTD>fe81c934-913a-481c-9b34-cdbdd80f63b7</CTROUTD>
<INVOICE>123456</INVOICE>
<HOST_RESPCODE>00</HOST_RESPCODE>
<MERCHID>700000013698</MERCHID>
<PAYMENT_MEDIA>MASTERCARD</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<REFERENCE>332217173721</REFERENCE>
<RESPONSE_TEXT>Approved</RESPONSE_TEXT>
<RESULT>CAPTURED</RESULT>
<RESULT_CODE>5</RESULT_CODE>
<TERMID>001</TERMID>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TOKEN_SOURCE>INTERNAL</TOKEN_SOURCE>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>15.00</TRANS_AMOUNT>
<TRANS_DATE>2023.11.18</TRANS_DATE>
<TRANS_TIME>17:37:21</TRANS_TIME>
<TRANS_CURRENCY_CODE>0840</TRANS_CURRENCY_CODE>
<RESPONSE>
Pay with Points - Sale Request
Following is an example of Request packet
<TRANSACTION>
<FUNCTION_TYPE>PAYMENT</FUNCTION_TYPE>
<COMMAND>CAPTURE</COMMAND>
<TRANS_AMOUNT>63.00</TRANS_AMOUNT>
<MANUAL_ENTRY>FALSE</MANUAL_ENTRY>
<FORCE_FLAG>FALSE</FORCE_FLAG>
</TRANSACTION>
Pay with Points - Sale Response
Following is an example of Response packet
<RESPONSE>
<ACCT_NUM>444522******0007</ACCT_NUM>
<COMMAND>CAPTURE</COMMAND>
<APPROVED_AMOUNT>63.00</APPROVED_AMOUNT>
<AUTH_CODE>969933</AUTH_CODE>
<AUTH_RESP_CODE>91</AUTH_RESP_CODE>
<BANK_USERDATA>VISA</BANK_USERDATA>
<BATCH_TRACE_ID>4f011f91-307c-4dcc-892b-e77c3676c406</BATCH_TRACE_ID>
<CARD_ABBRV>VI</CARD_ABBRV>
<CARD_ENTRY_MODE>Swiped</CARD_ENTRY_MODE>
<CARD_EXP_MONTH>**</CARD_EXP_MONTH>
<CARD_EXP_YEAR>**</CARD_EXP_YEAR>
<CARD_TOKEN>4445************</CARD_TOKEN>
<CTROUTD>118963</CTROUTD>
<INVOICE>262</INVOICE>
<DIFF_AMOUNT_DUE>0.00</DIFF_AMOUNT_DUE>
<INTRN_SEQ_NUM>4023721500</INTRN_SEQ_NUM>
<MERCHID>000091156455</MERCHID>
<ORIG_TRANS_AMOUNT>63.00</ORIG_TRANS_AMOUNT>
<PAYMENT_MEDIA>VISA</PAYMENT_MEDIA>
<PAYMENT_TYPE>CREDIT</PAYMENT_TYPE>
<PAR>43215678901234567890123456789</PAR>
<REFERENCE>00105591</REFERENCE>
<RESPONSE_CODE>91</RESPONSE_CODE>
<RESPONSE_TEXT>APPROVED</RESPONSE_TEXT>
<RESULT>APPROVED</RESULT>
<RESULT_CODE>4</RESULT_CODE>
<REWARD_OPT_IN>1</REWARD_OPT_IN>
<REWARD_ID>RD0000020911</REWARD_ID>
<REWARD_DISCOUNT_AMOUNT>10.00</REWARD_DISCOUNT_AMOUNT>
<REWARD_LOYALTY_TRANS_ID>16590993700</REWARD_LOYALTY_TRANS_ID>
<REWARD_PROMOTION_ID>RD000002091</REWARD_PROMOTION_ID>
<REWARD_PROMPT_TEXT>Thank you for redeeming 2000 ScoreCard Rewards points today.</REWARD_PROMPT_TEXT>
<TERMID>002</TERMID>
<TERMINATION_STATUS>SUCCESS</TERMINATION_STATUS>
<TOKEN_SOURCE>TA</TOKEN_SOURCE>
<TRAINING_MODE>OFF</TRAINING_MODE>
<TRANS_AMOUNT>63.00</TRANS_AMOUNT>
<TRANS_DATE>2024.05.08</TRANS_DATE>
<TRANS_SEQ_NUM>83070</TRANS_SEQ_NUM>
<TRAN_LANG_CODE>EN</TRAN_LANG_CODE>
<TRANS_TIME>05:49:17</TRANS_TIME>
<TROUTD>4023721500</TROUTD>
<COUNTER>177</COUNTER>
</RESPONSE>
Rate this article:
