Void Credit Authorization

Void an existing credit card authorization before capture

POST https://<PayEngine-host>/api/payment/void

Request

Request Body

Name	Type	Description
id*	string	Transaction ID (Authorization transaction)
description	String	Transaction description. Character limit is 255

200

Field Definitions

Field Name	Type	Description	Required?
ID	string	PayEngine system ID for the void request	Required
TransactionID	String	Unique transaction ID	Required
MerchantID	string	Merchant ID	Required
Description	string	Transaction description	Optional
VoidResponse.status	string	Transaction execution status. Allowed values PASS | FAIL	Required
VoidResponse.responseCode	string	The code representing the status of the processed request	Required
VoidResponse.responseMessage	string	The corresponding message for the response code	Required
VoidResponse.authCode	string	Authorization code received for the transaction	Optional
VoidResponse.hostReferenceNumber	string	A unique reference number by the acquiring processor for each transaction	Optional
VoidResponse.hostResponseCode	string	Response code indicating the status of the authorization request	Optional
VoidResponse.taskID	string	Task identification number from acquiring processor	Required
VoidResponse.transactionID	string	Transaction Identifier	Optional
VoidResponse.transactionTimestamp	string	Transaction timestamp in merchant's timezone	Required
VoidResponse.transactionAmount	string	Total amount requested in this transaction	Optional
VoidResponse.processedAmount	string	Total amount processed in this transaction	Optional
VoidResponse.totalAmount	string	Total amount of this transaction	Optional
VoidResponse.cardHolderVerificationCode	string	CVV verification code	Optional
VoidResponse.cardType	string	Card Type - visa, mastercard, american express, discover, dinersclub, ebt	Required
VoidResponse.maskedCardNumber	string	The truncated card number displaying the last four digits	Required
VoidResponse.customerReceipt	string	Printable customer receipt	Required
VoidResponse.merchantReceipt	string	Printable merchant receipt	Required

Sample Request / Response

Request

Example Request

{
    "id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
    "description": "Payment for the service"
}

Response

Example Response

{
    "data": {
        "ID": "b755760f-7ac7-4b6c-ac10-8225b4a6f5c9",
        "MerchantID": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "TransactionID": "165a95aa-06bd-4f3e-848e-5f0a5d86c78b",
        "Description": "Payment for the services",
        "internalTransactionID": "987654321",
        "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "order_number": "Order124",
        "VoidResponse": {
            "status": "PASS",
            "responseCode": "A0000",
            "responseMessage": "Success",
            "authCode": "705182",
            "hostResponseCode": "00",
            "hostReferenceNumber": "846873152984",
            "taskID": "83398216",
            "transactionID": "35117098",
            "transactionTimestamp": "2025-04-02T18:13:22",
            "voidedAmount": "110.00",
            "transactionAmount": "110.00",
            "cardType": "visa",
            "maskedCardNumber": "1111",
            "customerReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:13 PM         \\n                VOID                \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 35117098      \\n       SUBTOTAL: USD $110.00        \\n         TOTAL: USD $110.00         \\n                 \\n                 \\n       NO SIGNATURE REQUIRED        \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Customer Copy            \\n",
            "merchantReceipt": "        Sandbox US Merchant         \\n        200 Epcot Center Dr         \\n         Orlando, FL 32836          \\n            800-490-8514            \\n                 \\n                 \\n        2025-04-02 06:13 PM         \\n                VOID                \\n            Card # 1111             \\n          Card Type: VISA           \\n         Entry Mode : KEYED         \\n      Transaction ID: 35117098      \\n       SUBTOTAL: USD $110.00        \\n         TOTAL: USD $110.00         \\n                 \\n                 \\n      X_______________________      \\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN\\n ACCORDANCE WITH CARD ISSUER's AGREE\\nMENT (MERCHANT AGREEMENT IF CREDIT V\\n              OUCHER)               \\n     KEEP COPY FOR YOUR RECORDS     \\n               \\n \\n                \\n              APPROVED              \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n                 \\n           Merchant Copy            \\n"
        }
    }
}