> For the complete documentation index, see [llms.txt](https://docs.payengine.co/merchant-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payengine.co/merchant-api-reference/transactions/void-credit-authorization.md).

# Void Credit Authorization

<mark style="color:green;">`POST`</mark> `https://<Platform-host>/api/payment/void`

Request

#### Request Body

| Name                                 | Type   | Description                                     |
| ------------------------------------ | ------ | ----------------------------------------------- |
| id<mark style="color:red;">\*</mark> | string | Transaction ID (Authorization transaction)      |
| description                          | String | Transaction description. Character limit is 255 |

{% tabs %}
{% tab title="200 " %}
{% tabs %}
{% tab title="Field Definitions" %}

<table><thead><tr><th width="248">Field Name</th><th width="153">Type</th><th>Description</th><th>Required?</th></tr></thead><tbody><tr><td>ID</td><td>string</td><td>Platform system ID for the void request</td><td>Required</td></tr><tr><td>TransactionID</td><td>String</td><td>Unique transaction ID</td><td>Required</td></tr><tr><td>MerchantID</td><td>string</td><td>Merchant ID</td><td>Required</td></tr><tr><td>Description</td><td>string</td><td>Transaction description</td><td>Optional</td></tr><tr><td>VoidResponse.status</td><td>string</td><td>Transaction execution status.<br>Allowed values PASS | FAIL</td><td>Required</td></tr><tr><td>VoidResponse.responseCode</td><td>string</td><td><a href="/pages/3NDgEDKcaGwsNSCCiyeh">The code representing the status of the processed request</a></td><td>Required</td></tr><tr><td>VoidResponse.responseMessage</td><td>string</td><td>The corresponding message for the response code</td><td>Required</td></tr><tr><td>VoidResponse.authCode</td><td>string</td><td>Authorization code received for the transaction</td><td>Optional</td></tr><tr><td>VoidResponse.hostReferenceNumber</td><td>string</td><td>A unique reference number by the acquiring processor for each transaction</td><td>Optional</td></tr><tr><td>VoidResponse.hostResponseCode</td><td>string</td><td><a href="/pages/ysDmKvm1q1EkhoaZhGLf">Response code indicating the status of the authorization request</a></td><td>Optional</td></tr><tr><td>VoidResponse.taskID</td><td>string</td><td>Task identification number from acquiring processor</td><td>Required</td></tr><tr><td>VoidResponse.transactionID</td><td>string</td><td>Transaction Identifier</td><td>Optional</td></tr><tr><td>VoidResponse.transactionTimestamp</td><td>string</td><td>Transaction timestamp in merchant's timezone</td><td>Required</td></tr><tr><td>VoidResponse.transactionAmount</td><td>string</td><td>Total amount requested in this transaction</td><td>Optional</td></tr><tr><td>VoidResponse.processedAmount</td><td>string</td><td>Total amount processed in this transaction</td><td>Optional</td></tr><tr><td>VoidResponse.totalAmount</td><td>string</td><td>Total amount of this transaction</td><td>Optional</td></tr><tr><td>VoidResponse.cardHolderVerificationCode</td><td>string</td><td><a href="https://docs.payengine.co/payengine-api-reference/error-and-response-codes/cvv-verification-codes">CVV verification code</a></td><td>Optional</td></tr><tr><td>VoidResponse.cardType</td><td>string</td><td>Card Type - visa, mastercard, american express, discover, dinersclub, ebt</td><td>Required</td></tr><tr><td>VoidResponse.maskedCardNumber</td><td>string</td><td>The truncated card number displaying the last four digits</td><td>Required</td></tr><tr><td>VoidResponse.customerReceipt</td><td>string</td><td>Printable customer receipt</td><td>Required</td></tr><tr><td>VoidResponse.merchantReceipt</td><td>string</td><td>Printable merchant receipt</td><td>Required</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

### Sample Request / Response

{% tabs %}
{% tab title="Request" %}

#### Example Request

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

{% endtab %}

{% tab title="Response" %}

#### Example Response

```javascript
{
    "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"
        }
    }
}
```

{% endtab %}
{% endtabs %}