Void
Last updated: 04-Dec-2024
This command voids a previous transaction. Often the authorization code is also reversed.
Note
When using First Data Rapid Connect processor, a Void cannot be issued 25 minutes after the original Sale transaction. When that amount of time has transpired, you must process the transaction as a Credit (Return). When using Vantiv processor in an SCA ‘direct to processor’ implementation, the CTROUTD is stored only for the day – after that amount of time has transpired, you must process the transaction as a Credit (Return) with the card token
Device UI Required: Yes - Conditional (Required for some PAYMENT_TYPES for some processors.)
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 | VOID | Command name |
| PAYMENT_TYPE | Required | List |
|
NOTE: PAYMENT_TYPE field is mandatory for card token based transactions. | ||
| CTROUTD | Required | Numeric | 1 | 16 | Transaction ID from the previous transaction that is being voided. Example: 028661052 | |
| COUNTER | Required | Numeric | 1 | 10 | COUNTER is used for a given MAC label. Each COUNTER should be higher than the last one. This is sed 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 |
Response Packet
| Field | Type | Value | Description |
|---|---|---|---|
| RESPONSE_TEXT | Character | Processor response text. Example: VOIDED | |
| RESULT | Character | This indicates the Result details, commonly VOIDED or DECLINED. | |
| RESULT_CODE | Numeric | Expected result codes: 7 or 6 | This indicates the result code. |
| TERMINATION_STATUS | Character | SUCCESS and 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 | |
| TRANS_SEQ_NUM | Numeric | Processor/Batch transaction sequence number (not meaningful for direct host integrations). Example: 000049 | |
| INTRN_SEQ_NUM | Numeric | PWC transaction ID (not meaningful for direct host integrations). Example: 000049 | |
| TROUTD | Numeric | STAN number. Example: 000049 | |
| CTROUTD | Numeric | Client-specific Transaction routing ID (this will match the CTROUTD of the original transaction that is voided). Example: 028661052 | |
| ACCT_NUM | Numeric | Masked account number. Example: 400555******0019 | |
| APPROVED_AMOUNT | Floating point number | Amount approved. Example: 5.00 | |
| PAYMENT_MEDIA | Character | Medium of payment, commonly VISA/MC/DISC/AMEX/DEBIT . Example: VISA | |
| PAYMENT_TYPE | Character | Type of payment. Example: CREDIT, GIFT | |
| AUTH_CODE | Character | Processor authorization number, returned by some processors. This is conditional. Example: 123123 | |
| AUTH_RESP_CODE | Character | Returned by some processors when the transaction is declined. The value is maximum of 19 bytes. Example: 0131 | |
| HOST_RESPCODE | Numeric | Host response code. This will be sent if included in the SSI response. Example: 000 | |
| REFERENCE | Character | Returned by some processors. Example: 100007265288 | |
| RECEIPT_DATA | Character | Refer to Receipt Data in Response section for more details on receipt data. | |
| TRANS_DATE | Character | Transaction date. Example: 2018.01.10 | |
| TRANS_TIME | Character | Transaction time. Example: 12:24:30 | |
| BATCH_TRACE_ID | Character | This is conditional. Batch Trace ID. Example: 12cc7b17-4b45-4344-b412-5432 |
Processor-Based Token (Conditional)
| Field | Type | Value(s) | Description |
|---|---|---|---|
| CARD_TOKEN | Character | Refer to MESSAGE FORMAT section for more details on Message Format, Responses from Point. Example: 7987654321098765 | |
| BANK_USERDATA | Character | Bank User Data, normally returned with CARD_TOKEN. NOTE: This is applicable for FDRC Engage only. Example: 01/00/02/Visa/ |
Rate this article:
