Void Credit Authorization

Void an existing credit card authorization before capture

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

Request Body

Name
Type
Description

id*

string

Transaction ID (Authorization transaction)

Field Name
Type
Description
Required?

id

string

Platform payment ID for the void request

Required

transaction_id

string

Unique transaction ID

Required

gateway_id

string

ID of the gateway through which the transaction is processed

Optional

merchant_id

string

Merchant ID

Required

description

string

Transaction description sent in the original Auth or Sale transaction

Optional

token

string

Card token provided in the original sale or auth request

Required

internal_transaction_id

string

Internal Transaction ID provided in the original sale or auth request

Optional

void_response.status

string

Transaction execution status. Allowed values PASS | FAIL

Required

void_response.response_code

string

The code representing the status of the processed request

Required

void_response.response_message

string

The corresponding message for the response code

Required

void_response.auth_code

string

Authorization code received for the transaction

Optional

void_response.host_reference_number

string

A unique reference number by the acquiring processor for each transaction

Optional

void_response.host_response_code

string

Response code indicating the status of the authorization request

Optional

void_response.task_id

string

Task identification number from acquiring processor

Required

void_response.transaction_id

string

Transaction Identifier

Optional

void_response.transaction_timestamp

string

Transaction timestamp in merchant's timezone

Required

void_response.voided_amount

string

Amount voided

Required

void_response.transaction_amount

string

Total amount requested in the original Auth or Sale transaction

Optional

void_response.card_holder_verification_code

string

CVV verification code

Optional

void_response.card_type

string

Card Type

Required

void_response.masked_card_number

string

The truncated card number displaying the last four digits

Required

void_response.masked_card_number

string

The truncated card number displaying the last four digits

Required

void_response.customer_receipt

string

Printable customer receipt

Required

void_response.merchant_receipt

string

Printable merchant receipt

Required

Sample Request / Response

Example Request

{
    "id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8"
}

Webhook event: PAYMENT_VOIDED

Webhook Payload Example

{
    "event_uid": "95952444f9acee53ce26b6095b20059a",
    "event": "PAYMENT_VOIDED",
    "data": {
        "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844",
        "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
        "payment_id": "b755760f-7ac7-4b6c-ac10-8225b4a6f5c9",
        "description": "Payment for the services",
        "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "order_number": "Order124",
        "void_response": {
            "status": "PASS",
            "task_id": "83398216",
            "auth_code": "705182",
            "card_type": "visa",
            "response_code": "A0000",
            "voided_amount": "110.00",
            "transaction_id": "35117098",
            "customer_receipt": "        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",
            "merchant_receipt": "        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",
            "response_message": "Success",
            "host_response_code": "00",
            "masked_card_number": "1111",
            "transaction_amount": "110.00",
            "host_reference_number": "846873152984",
            "transaction_timestamp": "2025-04-02T18:13:22"
        },
        "transaction_id": "165a95aa-06bd-4f3e-848e-5f0a5d86c78b",
        "internal_transaction_id": "987654321"
    }
}
PreviousCredit Card Authorization V2NextCredit Card Capture

Last updated