> For the complete documentation index, see [llms.txt](https://docs.payengine.co/payengine-api-v2.5/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/payengine-api-v2.5/transactions/authorizationv2.md).

# Credit Card Authorization V2

## In the V2 Auth we add support for 3DS and some improvements.

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

#### Request Body

<table><thead><tr><th width="286">Name</th><th width="106">Type</th><th>Description</th></tr></thead><tbody><tr><td>merchant_id<mark style="color:red;">*</mark></td><td>string</td><td>Merchant ID</td></tr><tr><td>transaction_monitoring_bypass</td><td>boolean</td><td>Optional flag to explicitly skip transaction monitoring rules.</td></tr><tr><td>data.transaction_amount<mark style="color:red;">*</mark></td><td>string</td><td>Max Length=12<br>Allowed characters: 0-9 and .(dot)<br><br>Note: this value always reflects the total dollar amount for example 1.00 and 1 both will be considered $1.00 and 0.10 will be 10 cents.<br></td></tr><tr><td>data.pre_settlement_fee_charge</td><td>string</td><td><p>An optional fee amount to be deducted from the transaction before settlement. This fee is processed at the processor level and reduces the net amount settled to the merchant. The value must be a positive number and cannot exceed the total transaction amount.<br><br>Applicable in scenarios where the merchant needs to collect fees separately or adjust the settlement amount.<br><br></p><p><em>Constraints</em>:</p><ul><li>Must be a positive decimal number.</li><li>Cannot be greater than the <code>transactionAmount</code>.</li><li>If set to zero or omitted, no pre-settlement fee will be deducted.</li></ul><p><em>Example</em>:</p><ul><li><strong>Transaction Amount</strong>: $100.00</li><li><strong><code>preSettlementFeeCharge</code></strong>: $5.00</li><li><strong>Net Settlement to Merchant</strong>: $95.00 (after deducting the $5.00 fee)</li></ul><p><em>Note</em>: The customer will still be charged the full transaction amount of $100.00, but the merchant will receive $95.00 due to the $5.00 pre-settlement fee deduction.</p></td></tr><tr><td>data.post_settlement_fee_charge</td><td>string</td><td><p>An optional fee amount to be deducted after the transaction has been settled at the processor level but before the net amount is paid out to the merchant. This fee adjusts the final payout to the merchant while maintaining the full transaction amount charged to the customer.<br><br>Note:</p><ul><li>Use this parameter for fees such as processing charges, administrative fees, or adjustments that need to be applied after settlement but before the payout to the merchant.</li><li>Applicable for scenarios where deductions are required post-transaction processing.</li></ul><p><em>Constraints</em>:</p><ul><li>Must be a positive decimal number.</li><li>Cannot exceed the total <code>transactionAmount</code>.</li><li>If omitted or set to zero, no post-settlement fee will be deducted.</li></ul><p><em>Example</em>:</p><ul><li><strong>Transaction Amount</strong>: $100.00</li><li><strong>Settlement Amount</strong>: $100.00 (full amount settled)</li><li><strong><code>postSettlementFeeCharge</code></strong>: $7.50</li><li><strong>Net Payout to Merchant</strong>: $92.50 (after deducting the $7.50 fee)</li></ul><p><em>Note</em>: The customer will still see a charge of $100.00 for the transaction. The deduction is applied only to the merchant's payout after the settlement.</p></td></tr><tr><td><mark style="color:blue;">data.shipping_amount</mark></td><td>string</td><td>Shipping amount to be included in the transaction amount.<br>Default is 0.00<br><strong>Note</strong>: This field is required for Level III data</td></tr><tr><td>data.card_token<mark style="color:red;">*</mark></td><td>string</td><td>Card token generated by <a href="/pages/YN9W4Ldyth3zlYUEy6qa">Platform secure field API</a></td></tr><tr><td>data.internal_transaction_id</td><td>string</td><td>An internal ID from integrating system. Will be returned in the response and associated refunds if provided.</td></tr><tr><td>data.currency_code</td><td>string</td><td><a href="/pages/IWuzbQA5mk1yAih65rxM">ISO Currency Code</a> if not provided it defaults to US Dollar (USD)</td></tr><tr><td><mark style="color:blue;">data.order_number</mark></td><td>string</td><td>Order number specified in billing statement of the cardholder.<br>Alphanumeric (a-z A-Z 0-9) maximum 20 characters.</td></tr><tr><td><mark style="color:blue;">data.order_id</mark></td><td>string</td><td>Identifier assigned by the merchant</td></tr><tr><td>data.customer_name</td><td>string</td><td>If a name other than the card holder's name is required to be shown on the transaction list, it is important to note that this alternative name will not serve as the card holder's name during card authorization.</td></tr><tr><td>data.items</td><td>array</td><td>List of items sold</td></tr><tr><td><mark style="color:blue;">data.items[].name</mark></td><td>string</td><td>Name of the item</td></tr><tr><td><mark style="color:blue;">data.items[].quantity</mark></td><td>string</td><td>Item quantity, default is 1</td></tr><tr><td><mark style="color:blue;">data.items[].product_code</mark></td><td>string</td><td><p>Description code of the item</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].description</mark></td><td>string</td><td><p>Item descriptions</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].commodity.code</mark></td><td>string</td><td><p>International description code of the individual good or service being supplied.</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].unitof_measure</mark></td><td>string</td><td><p>Unit of measurement Default: Each</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].unit_of_cost</mark></td><td>string</td><td><p>Unit cost of item</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].tax_rate</mark></td><td>string</td><td><p>Percentage representing the value-added tax applied Default: 0.00</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].tax_amount</mark></td><td>string</td><td><p>Amount on sales tax on specific item. It is included in the <code>transactionAmount.</code>Default: 0.00</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.items[].total_amount</mark></td><td>string</td><td><p>Total order amount for this item/s</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.sales_tax</mark></td><td>string</td><td>Tax amount in the <code>transactionAmount</code></td></tr><tr><td>data.other_tax[]</td><td>array</td><td>Contains additional tax details applied to the transaction.</td></tr><tr><td>data.other_tax[].name</td><td>string</td><td>Name of the tax (e.g. CRV).<br><br><strong>Note</strong>: It is required if data.other_tax[].amount is provided</td></tr><tr><td>data.other_tax[].amount</td><td>string</td><td>Value of the tax applied and it is included in the transaction amount<br><strong>Note</strong>: It is required if data.other_tax[].name is provided</td></tr><tr><td>data.fraud_monitor_session_id</td><td>String</td><td>Fraud monitor session ID. Obtain by using Platform's fraud prevention javascript library.</td></tr><tr><td>attempt_3d_secure</td><td>boolean</td><td><p>Indicate whether this transaction should attempt 3D Secure or not. It's false by default.<br></p><p><strong>Note</strong>: As per Visa 3DS mandate, cardholder's email or phone number is mandatory. If attempt3DSecure is true and card type is visa and liability shift required by partner = yes and email/phone is <strong>not</strong> present then the transaction will fail due to cardholder email/phone not being present</p></td></tr><tr><td>browser_info</td><td>string</td><td>Required if <code>attempt3DSecure</code> is set to true</td></tr><tr><td>data.description</td><td>String</td><td>Transaction Description. Character limit is 255</td></tr><tr><td>data.additonal_data</td><td>object</td><td>Optional data. Currently, it is specific to certain use case for accounting integration</td></tr><tr><td>data.metadata</td><td>object</td><td>Add any additional metadata by passing a json object</td></tr><tr><td>data.ip_address</td><td>String</td><td>IP address of cardholder</td></tr><tr><td>data.gateway_id</td><td>string</td><td>Gateway ID (optional, if multigateway mode enabled)</td></tr><tr><td><mark style="color:blue;">data.shipping_country</mark></td><td>string</td><td><p>Shipping Country e.g. US Default will be Merchant's country</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.ship_from_postal</mark></td><td>string</td><td><p>Postal/ZIP code of the address from where purchased goods are being shipped, defaults to merchant profile postal code.</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.shipping_postal</mark></td><td>string</td><td><p>Postal/ZIP code of the address where purchased goods will be delivered. This field can be identical to the 'shipFromPostal' if the customer is present and takes immediate possession of the goods.</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr><tr><td><mark style="color:blue;">data.commodity_code</mark></td><td>string</td><td><p>4 character international description code of the overall goods or services being supplied</p><p><strong>Note</strong>: This field is required for Level III data</p></td></tr></tbody></table>

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

<table><thead><tr><th width="324.1978759765625">Field Name</th><th width="106.1298828125">Type</th><th width="260.2099609375">Description</th><th>Required?</th></tr></thead><tbody><tr><td>id</td><td>string</td><td>Platform payment ID for the auth request</td><td>Required</td></tr><tr><td>transaction_id</td><td>String</td><td>Unique transaction ID for this request</td><td>Required</td></tr><tr><td>merchant_id</td><td>string</td><td>Merchant ID provided in the request</td><td>Required</td></tr><tr><td>gateway_id</td><td>string</td><td>ID of the gateway through which the transaction is processed</td><td>Optional</td></tr><tr><td>description</td><td>string</td><td>Transaction Description</td><td>Optional</td></tr><tr><td>order_number</td><td>string</td><td>Order number value provided in the request</td><td>Optional</td></tr><tr><td>customer_name</td><td>string</td><td>Customer name provided in the request</td><td>Optional</td></tr><tr><td>token</td><td>string</td><td>Card token provided in the request that is used to process this authorization</td><td>Optional</td></tr><tr><td>currency_code</td><td>string</td><td>ISO Currency code provided in the request<br><br><strong>Note</strong>: Only returned if originally provided in the request</td><td>Optional</td></tr><tr><td>internal_transaction_id</td><td>string</td><td>Internal Transaction ID provided in the request</td><td>Optional</td></tr><tr><td>three_ds_action_required</td><td>string</td><td>True / False. True if 3DS is attempted</td><td>Optional</td></tr><tr><td>three_ds_type</td><td>string</td><td>Type of 3DS attempted. Allowed values frictionless | challenge | attempted</td><td>Optional</td></tr><tr><td>three_ds_status</td><td>string</td><td>3DS attempt status. Allowed values succeeded | failed</td><td>Optional</td></tr><tr><td>auth_response.status</td><td>string</td><td>Transaction execution status.<br>Allowed values PASS | FAIL | PENDING_3DSAUTH</td><td>Required</td></tr><tr><td>auth_response.response_code</td><td>string</td><td><a href="/pages/3svuRYXMTJ1St1Zhun0p">The code representing the status of the processed request</a></td><td>Required</td></tr><tr><td>auth_response.response_message</td><td>string</td><td>The corresponding message for the response code</td><td>Required</td></tr><tr><td>auth_response.auth_code</td><td>string</td><td>Authorization code received for the transaction</td><td>Optional</td></tr><tr><td>auth_response.host_reference_number</td><td>string</td><td>A unique reference number by the acquiring processor for each transaction</td><td>Optional</td></tr><tr><td>auth_response.host_response_code</td><td>string</td><td><a href="/pages/Jvv9mJQ96Xz9irQH3ll1">Response code indicating the status of the authorization request</a></td><td>Optional</td></tr><tr><td>auth_response.task_id</td><td>string</td><td>Task identification number from acquiring processor</td><td>Required</td></tr><tr><td>auth_response.transaction_id</td><td>string</td><td>Transaction Identifier</td><td>Optional</td></tr><tr><td>auth_response.transaction_timestamp</td><td>string</td><td>Transaction timestamp in merchant's timezone</td><td>Required</td></tr><tr><td>auth_response.transaction_amount</td><td>string</td><td>Total amount requested in this transaction</td><td>Optional</td></tr><tr><td>auth_response.processed_amount</td><td>string</td><td>Total amount processed in this transaction</td><td>Optional</td></tr><tr><td>auth_response.total_amount</td><td>string</td><td>Total amount of this transaction</td><td>Optional</td></tr><tr><td>auth_response.sales_tax</td><td>string</td><td>Sales tax</td><td>Optional</td></tr><tr><td>auth_response.address_verification_code</td><td>string</td><td><a href="/pages/J5Kmr5zaPCENHDS0lhKy">Address verification system response</a></td><td>Optional</td></tr><tr><td>auth_response.card_holder_verification_code</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>auth_response.card_type</td><td>string</td><td>Card Type - visa, mastercard, american express, discover, dinersclub, ebt</td><td>Required</td></tr><tr><td>auth_response.masked_card_number</td><td>string</td><td>The truncated card number displaying the last four digits</td><td>Required</td></tr><tr><td>auth_response.customer_receipt</td><td>string</td><td>Printable customer receipt</td><td>Required</td></tr><tr><td>auth_response.merchant_receipt</td><td>string</td><td>Printable merchant receipt</td><td>Required</td></tr><tr><td>auth_response.partial_payment</td><td>boolean</td><td>A boolean indicating if the transaction was partially authorized. If <code>true</code>, the processed amount is less than the requested amount</td><td>Required</td></tr><tr><td>metadata</td><td>object</td><td>Return all the metadata sent in the request</td><td>Optional</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endtab %}
{% endtabs %}

{% hint style="info" %}
When automatic [Network Tokenization](https://docs.payengine.co/developer-docs/tokenization/automatic-network-tokenization) is activated on your account, the transactions will be completed using card brand tokens and respective benefits wil apply.
{% endhint %}

### Sample Request / Response

{% tabs %}
{% tab title="Request Body" %}
**Example Request (via token)**

```json
{
    "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
    "data": {
        "transaction_amount": "1.00",
        "card_token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "description": "Description of transaction",
        "currency_code": "USD",
        "sales_tax": "1.00",
        "order_number": "12345678910",
        "internal_transaction_id": "987654321",
        "customer_name": "John Wick",
        "ip_address": "123.111.21.2",
        "metadata": {
            "customer_id": "123",
            "email" : "test@test.com"
        }
    }
}
```

**Example Request with Items**

```json
{
    "merchant_id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
    "attempt_3d_secure": true,
    "browser_info": "COLLECTED USING CLIENT BROWSER",    
    "data": {
        "transaction_amount": "200.20",
        "card_token": "card_sandbox_xxxx",
        "description": "Payment for the services",
        "items": [
          {
              "name": "Sample",
              "unit_cost": "95.00",
              "quantity": 2,
              "total_amount": "190.00" //included in the transaction amount
            }
         ],
         "sales_tax": "10.00",
         "other_tax": [
             {
                 "name": "CRV",
                 "amount": "0.20"
             }
         ],
        "metadata": {
            "customer_id": "123",
            "email" : "test@test.com"
        }
    }
}
```

**Example Request with 3DS**

```json
{
    "merchant_id": "a447b0b8-0dbb-4e07-bfc2-c35bba8d71e8",
    "attempt_3d_secure": true,
    "browser_info": "COLLECTED USING CLIENT BROWSER",    
    "data": {
        "transaction_amount": "110.00",
        "card_token": "card_sandbox_xxxx",
        "description": "Payment for the service",
        "order_number": "123"
        "metadata": {
            "customer_id": "123",
            "email" : "test@test.com"
        }
    }
}
```

{% endtab %}

{% tab title="Response Body" %}
**Example Response**

```json
{
    "data": {
        "id": "1621e453-6e6e-49ad-83e1-130755c9511b",
        "transaction_id": "97923171-47c9-4faf-9c1d-86ea84a028d2",
        "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
        "description": "Description of transaction",
        "internal_transaction_id": "987654321",
        "auth_response": {
            "status": "PASS",
            "response_code": "A0000",
            "response_message": "Success",
            "auth_code": "323327",
            "host_response_code": "00",
            "host_reference_number": "130862973947",
            "task_id": "99511277",
            "transaction_id": "44387374",
            "transaction_timestamp": "2025-04-02T18:08:21",
            "transaction_amount": "1.00",
            "processed_amount": "1.00",
            "total_amount": "1.00",
            "address_verification_code": "X",
            "card_holder_verification_code": "N",
            "card_type": "visa",
            "masked_card_number": "1111",
            "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:08 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 44387374      \\n    Invoice Number: 12345678910     \\nDescription: Description of transact\\n                ion                 \\n        SUBTOTAL: USD $0.00         \\n        SALES TAX: USD $1.00        \\n          TOTAL: USD $1.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:08 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 44387374      \\n    Invoice Number: 12345678910     \\nDescription: Description of transact\\n                ion                 \\n        SUBTOTAL: USD $0.00         \\n        SALES TAX: USD $1.00        \\n          TOTAL: USD $1.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",
            "partial_payment": false
        },
        "sales_tax": "1.00",
        "customer_name": "John Wick",
        "ip_address": "123.111.21.2",
        "order_number": "12345678910",
        "currency_code": "USD",
        "metadata": {
            "customer_id": "123",
            "email": "test@test.com"
        },
        "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i"
    }
}
```

**Example with Items**

```json
{
    "data": {
        "id": "78451f08-7b10-480f-b811-75014ddcaf53",
        "transaction_id": "4dd6b470-91d6-4ec4-b36b-cc4a96a2fd51",
        "merchant_id": "e6705370-fccc-4bfb-9fb4-0e8a0a0cf426",
        "description": "Payment for the services",
        "auth_response": {
            "status": "PASS",
            "response_code": "A0000",
            "response_message": "Success",
            "auth_code": "387263",
            "host_response_code": "00",
            "host_reference_number": "347535209284",
            "task_id": "18012509",
            "transaction_id": "85860483",
            "transaction_timestamp": "2025-03-31T07:02:00",
            "transaction_amount": "200.20",
            "processed_amount": "200.20",
            "total_amount": "200.20",
            "address_verification_code": "X",
            "card_holder_verification_code": "N",
            "card_type": "visa",
            "masked_card_number": "4242",
            "customer_receipt": "\n\nSandbox Merchant\n200 Epcot Center Dr\nOrlando, FL 32836\n800-490-8514\n\nCREDIT CARD\n\nSampleUSD $190.00\n2 @ $95.00\n\nSUBTOTAL: USD $190.00\nCRV:USD $0.20\n---------------------------------------------------------------\nTOTAL TAX:USD $0.20\nTOTAL (1 ITEM)USD $200.20\n\nVISA ************4242\nDATE & TIME:03-31-25 12:02:00\nREC #: \nTYPE: AUTH\nDESCRIPTION: Payment for the services\n\nTOTAL: USD $200.20\nDECLINED\nNO SIGNATURE REQUIRED\nTHANK YOU\nCardholder Copy\nRetain this copy for statement verification.\n\n\n\n\n\n\n\n",
            "merchant_receipt": "\n\nSandbox Merchant\n200 Epcot Center Dr\nOrlando, FL 32836\n800-490-8514\n\nCREDIT CARD\n\nSampleUSD $190.00\n2 @ $95.00\n\nSUBTOTAL: USD $190.00\nCRV:USD $0.20\n---------------------------------------------------------------\nTOTAL TAX:USD $0.20\nTOTAL (1 ITEM)USD $200.20\n\nVISA ************4242\nDATE & TIME:03-31-25 12:02:00\nREC #: \nTYPE: AUTH\nDESCRIPTION: Payment for the services\n\nTOTAL: USD $200.20\nDECLINED\nX_______________________\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN ACCORDANCE WITH CARD ISSUER's AGREEMENT (MERCHANT AGREEMENT IF CREDIT VOUCHER)\nTHANK YOU\nMerchant Copy\nRetain this copy for statement verification.\n\n\n\n\n\n\n\n",
            "partial_payment": false
        },
        "metadata": {
            "customer_id": "123",
            "email": "test@test.com"
        },
        "token": "card_sandbox_tE8BT9Betjsp7PV46IS9xb1c"
    }
}
```

**Example 3DS Response**

```json
{
    "data": {
        "id": "bf9a0bf0-34f6-48f6-8329-db0ea0fc2b03",
        "transaction_id": "93fb1936-9381-422a-a66d-32c2277bc5f7",
        "merchant_id": "8357832f-79c9-48fd-9647-d1dae251e434",
        "description": "Payment for the service",
        "token": "card_sandbox_sV1dcHZmTKCvw6dSCmw2dGC3",
        "order_number": "Order 123",
        "three_ds_action_required": false,
        "three_ds_type": "frictionless",
        "three_ds_status": "succeeded",
        "three_ds_data": "eyJ0IjoiNzBmYjEzMTgtZmI5MC00YTBlLWE1ZTgtM2U1ODc1YzE1ZTIxIiwiZSI6InNhbmRib3giLCJzIjoiMjAyMy0wNi0xMVQwNzo1NzowMC42NDlaIiwidGhyZWVEU1NlcnZlclRyYW5zSUQiOiIyNTZlOTUxMi1lNDNmLTRjZDUtOWFhNy0zOGU5MDZjZWU2MWUiLCJ0aHJlZURTTWV0aG9kVVJMIjoiaHR0cHM6Ly9hY3Muc2FuZGJveC4zZHNlY3VyZS5pby8zZHNtZXRob2QifQ",
        "auth_response": {
            "status": "PENDING_3DSAUTH"
        }
    }
}
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
For complete 3DS flow please refer to our [3D Secure developer guide.](https://docs.payengine.co/payengine-developer-docs/processing-payments/3d-secure)
{% endhint %}

{% hint style="info" %}
Webhook event: **PAYMENT\_AUTH**
{% endhint %}

#### Webhook Payload Example

```json
{
    "event_uid": "6d8f4292ec5bbc49d5b088948925a3cd",
    "event": "PAYMENT_AUTH",
    "data": {
        "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i",
        "metadata": {
            "email": "test@test.com",
            "customer_id": "123"
        },
        "sales_tax": "1.00",
        "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844",
        "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5",
        "ip_address": "123.111.21.2",
        "payment_id": "c968e08b-9307-4fd7-9692-771b3d79d916",
        "description": "Description of transaction",
        "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6",
        "order_number": "12345678910",
        "currency_code": "USD",
        "customer_name": "John Wick",
        "auth_response": {
            "status": "PASS",
            "task_id": "61126431",
            "auth_code": "993357",
            "card_type": "visa",
            "total_amount": "1.00",
            "response_code": "A0000",
            "transaction_id": "13008528",
            "partial_payment": false,
            "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:09 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 13008528      \\n    Invoice Number: 12345678910     \\nDescription: Description of transact\\n                ion                 \\n        SUBTOTAL: USD $0.00         \\n        SALES TAX: USD $1.00        \\n          TOTAL: USD $1.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:09 PM         \\n           CREDIT - SALE            \\n         Entry Mode : KEYED         \\n      Transaction ID: 13008528      \\n    Invoice Number: 12345678910     \\nDescription: Description of transact\\n                ion                 \\n        SUBTOTAL: USD $0.00         \\n        SALES TAX: USD $1.00        \\n          TOTAL: USD $1.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",
            "processed_amount": "1.00",
            "response_message": "Success",
            "host_response_code": "00",
            "masked_card_number": "1111",
            "transaction_amount": "1.00",
            "host_reference_number": "691121564407",
            "transaction_timestamp": "2025-04-02T18:09:05",
            "address_verification_code": "X",
            "card_holder_verification_code": "N"
        },
        "transaction_id": "689c6d9c-999f-4904-8129-a024dc413782",
        "internal_transaction_id": "987654321"
    }
}
```