> 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/webhooks/available-webhooks.md). # Available Webhooks Platform platform uses webhooks to automatically notify your application when a specific event occurs. The following are the webhook event categories: * **Transaction Processing:** This includes webhooks for different types of transactions. A webhook event is triggered after a transaction is completed. * **Batch:** This involves the generation of a webhook when a settlement batch is created. As part of settlement batch generation, transactions are submitted to the processor for settlement. * **Payouts:** This involves the generation of a webhook once funds are settled by the processor. Following are all the webhook events available for the above listed event categories {% tabs %} {% tab title="Transactions" %} #### **PAYMENT\_AUTH** Triggered when an authorization transaction is successfully completed (Refer [here](/merchant-api-reference/transactions/credit-card-authorization-v2.md) for details on initiating an authorization transaction). ```javascript { "event_uid": "9fff410f1903817978471c90e677b814", "event": "PAYMENT_AUTH", "data": { "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i", "sales_tax": "10", "gratuity": "10.00", "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "payment_id": "cd9f4405-a5c9-40a1-999d-7587f34e7b42", "description": "Payment for the services", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "currencyCode": "USD", "order_number": "Order124", "auth_response": { "status": "PASS", "taskID": "93461014", "authCode": "248293", "cardType": "visa", "totalAmount": "110.00", "responseCode": "A0000", "transactionID": "47649279", "partialPayment": false, "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 05:57 PM \\n CREDIT - SALE \\n Entry Mode : KEYED \\n Transaction ID: 47649279 \\n Invoice Number: Order124 \\nDescription: Payment for the service\\n s \\n SUBTOTAL: USD $100.00 \\n SALES TAX: USD $10.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 05:57 PM \\n CREDIT - SALE \\n Entry Mode : KEYED \\n Transaction ID: 47649279 \\n Invoice Number: Order124 \\nDescription: Payment for the service\\n s \\n SUBTOTAL: USD $100.00 \\n SALES TAX: USD $10.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", "processedAmount": "110.00", "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "transactionAmount": "110.00", "hostReferenceNumber": "673084425015", "transactionTimestamp": "2025-04-02T17:57:20", "addressVerificationCode": "X", "cardHolderVerificationCode": "N" }, "customer_name": "John Doe", "transaction_id": "5f805b55-a7e0-4ce0-83d7-a6503b04be4b", "internalTransactionID": "987654321" } } ``` #### **PAYMENT\_AUTH\_FAILED** Triggered when the authorization transaction fails ```javascript { "event_uid": "50a3a7e37a2fdfa7c2b66279c8e725e8", "event": "PAYMENT_AUTH_FAILED", "data": { "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i", "salesTax": "1", "gratuity": "10.00", "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "ip_address": "123.111.21.2", "payment_id": "e3de0c0a-c5ae-4d02-ae20-9d5c57624c62", "Description": "Description of transaction", "merchant_id": "605b3f20-7ded-48a8-a4cb-b3e2330581b2", "orderNumber": "12345678910", "currencyCode": "USD", "auth_response": { "status": "FAIL", "taskID": "0", "authCode": "", "cardType": "visa", "lastName": "name", "firstName": "card", "totalAmount": "100.99", "responseCode": "3", "transactionID": "0", "partialPayment": false, "customerReceipt": " Merchant \\n , \\n \\n \\n 2025-04-02 11:17 AM \\n AUTH \\n Card # 411111xxxxxx1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 0 \\n Invoice Number: 12345678910 \\nDescription: Description of transact\\n ion \\n SUBTOTAL: USD $99.99 \\n SALES TAX: USD $1.00 \\n TOTAL: USD $100.99 \\n \\n \\n NO SIGNATURE REQUIRED \\n FAILED \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Customer Copy \\n", "merchantReceipt": " Merchant \\n , \\n \\n \\n 2025-04-02 11:17 AM \\n AUTH \\n Card # 411111xxxxxx1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 0 \\n Invoice Number: 12345678910 \\nDescription: Description of transact\\n ion \\n SUBTOTAL: USD $99.99 \\n SALES TAX: USD $1.00 \\n TOTAL: USD $100.99 \\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 FAILED \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n \\n Merchant Copy \\n", "processedAmount": 0, "responseMessage": "Authentication Failed", "hostResponseCode": "300", "maskedCardNumber": "411111xxxxxx1111", "transactionAmount": "100.99", "hostReferenceNumber": "0", "transactionTimestamp": "2025-04-02T18:17:11.612Z", "addressVerificationCode": "", "cardHolderVerificationCode": "" }, "transaction_id": "b25df89a-a6fe-4b33-ba33-7d25da38543d", "fraudMonitorSessionId": "FRAUD456", "internalTransactionID": "987654321" } } ``` #### **PAYMENT\_VOIDED** Triggered when an authorization transaction is voided. (Refer [here](/merchant-api-reference/transactions/void-credit-authorization.md) for details on initiating void transaction). ```javascript { "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", "taskID": "83398216", "authCode": "705182", "cardType": "visa", "responseCode": "A0000", "voidedAmount": "110.00", "transactionID": "35117098", "partialPayment": false, "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", "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "transactionAmount": "110.00", "hostReferenceNumber": "846873152984", "transactionTimestamp": "2025-04-02T18:13:22" }, "transaction_id": "165a95aa-06bd-4f3e-848e-5f0a5d86c78b", "internalTransactionID": "987654321" } } ``` **PAYMENT\_VOID\_FAILED** Triggered when an attempt to void a payment fails, indicating that the transaction cancellation could not be completed. ```javascript { "event_uid": "4d304a4ed5a4e338b4753ab832efd9c0", "event": "PAYMENT_VOIDED_FAILED", "data": { "account_id": "bb3bc2a6-b5c7-4369-be9c-18455c63c228", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "payment_id": "bcd8c963-bf63-40f0-b3f7-673cb4d3c493", "description": "Void the payment for the services", "merchant_id": "13116974-76b9-41ec-9c95-53db51c89363", "void_response": { "status": "FAIL", "responseCode": "D2005", "responseMessage": "Invalid Card", "partialPayment": false }, "transaction_id": "efa04765-b876-46b9-8c0e-39f30d27eb73", "internalTransactionID": "987654321" } } ``` #### **PAYMENT\_CAPTURED** Triggered when a payment authorization is successfully captured (Refer [here](/merchant-api-reference/transactions/credit-card-capture.md) for details on initiating a capture transaction) ```javascript { "event_uid": "df146813e8523c1cd5afbda038486120", "event": "PAYMENT_CAPTURED", "data": { "metadata": { "email": "test@test.com", "customerId": "123" }, "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "payment_id": "2a0e8a3b-7703-4d31-a8cd-c714fed4dedf", "description": "Description of transaction", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "transaction_id": "ca8c6e03-1699-4528-bb0c-5894e87ecf47", "capture_response": { "status": "PASS", "taskID": "95103204", "authCode": "323072", "cardType": "visa", "totalAmount": "1.00", "responseCode": "A0000", "transactionID": "67868150", "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 06:26 PM \\n CREDIT - SALE \\n Card # 1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 67868150 \\n Description: Test Capture \\n SUBTOTAL: 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", "merchantReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 06:26 PM \\n CREDIT - SALE \\n Card # 1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 67868150 \\n Description: Test Capture \\n SUBTOTAL: 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", "processedAmount": "110.00", "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "transactionAmount": "110.00", "hostReferenceNumber": "325806055923", "transactionTimestamp": "2025-04-02T18:26:38" }, "internalTransactionID": "987654321" } } ``` #### **PAYMENT\_CAPTURE\_FAILED** Triggered when a capture transaction fails ```javascript { "event_uid": "351a600abdf53b7eba009d93f0bde3e5", "event": "PAYMENT_CAPTURE_FAILED", "data": { "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "aa2ba70f-3e45-4830-a8ed-f14d30efd4be", "payment_id": "61c862b1-183d-4857-9bdb-3e5a72c9968a", "description": "Payment for product", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "transaction_id": "a5bde62f-a8a1-4497-9a4d-e53f35b9e519", "capture_response": { "status": "FAIL", "responseCode": "D2001", "responseMessage": "Refer to Issuer" }, "internalTransactionID": "987654321" } } ``` #### **PAYMENT\_SALE** Triggered when a sale transaction is successfully processed (Refer [here](/merchant-api-reference/transactions/credit-card-sale.md) for details on initiating a sale transaction). ```javascript { "event_uid": "d2e9f63779ad668603a51b563ec68b6f", "event": "PAYMENT_SALE", "data": { "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i", "metadata": { "email": "test@test.com", "customerId": "123" }, "sales_tax": "10", "gratuity": "10.00", "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "payment_id": "62430b78-3049-4d25-9637-b78f3ea16709", "description": "Payment for the services", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "currencyCode": "USD", "order_number": "Order124", "customer_name": "John Doe", "sale_response": { "status": "PASS", "taskID": "90687488", "authCode": "165201", "cardType": "visa", "totalAmount": "110.00", "responseCode": "A0000", "transactionID": "69832290", "partialPayment": false, "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 05:49 PM \\n CREDIT - SALE \\n Entry Mode : KEYED \\n Transaction ID: 69832290 \\n Invoice Number: Order124 \\nDescription: Payment for the service\\n s \\n SUBTOTAL: USD $100.00 \\n SALES TAX: USD $10.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 05:49 PM \\n CREDIT - SALE \\n Entry Mode : KEYED \\n Transaction ID: 69832290 \\n Invoice Number: Order124 \\nDescription: Payment for the service\\n s \\n SUBTOTAL: USD $100.00 \\n SALES TAX: USD $10.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", "processedAmount": "110.00", "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "transactionAmount": "110.00" "hostReferenceNumber": "990551169365", "transactionTimestamp": "2025-04-02T17:49:08", "addressVerificationCode": "X", "cardHolderVerificationCode": "N" }, "transaction_id": "8760a4f8-51fd-46eb-a3b4-32f08e05e487", "internal_transaction_id": "987654321", "device": { "id":"a42627a7-1368-4f2d-b22e-f78f2d216d3e", "type":"pax", "name":"Shaun's Mobile", "model":"S24", "serial_number":"1234de30e5fcfcbb7819c18e264ce4000dd0", "sdk_version":"1.0.0", "manufacturer": "Pax", "app_version": "1.0.0 (1)", "os": "android", "os_version": "14" } } } ``` #### **PAYMENT\_FAILED** Triggered for any sale request failure. For example if you trigger a TTP transaction and it is cancelled at the device you will receive this webhook or if card is declined while while processing this webhook is triggered. ```javascript { "event_uid": "38c2d4501abfa5d2e78e36965ca78e81", "event": "PAYMENT_FAILED", "data": { "deviceId": "0bd3484a-f81e-4970-9084-a5a4d1066dd7", "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i", "metadata": { "payer": "23224" }, "device_id": "0bd3484a-f81e-4970-9084-a5a4d1066dd7", "sales_tax": "0.1", "gratuity": "10.00", "account_id": "3cab79a6-31bd-43e6-9a0c-e5870b18fa38", "gateway_id": "12df2dd6-d4fe-4845-ad50-ebdeaf1dd5ac", "payment_id": "47c71fd5-b47b-4da3-829e-912a989fd35e", "description": "Device Sale", "merchant_id": "b0ad3bfe-c7a1-4def-9840-6c8f2570d2ce", "currencyCode": "USD", "order_number": "12345678910", "customer_name": "Mary Jane", "sale_response": { "status": "FAIL", "taskID": "", "authCode": "", "cardType": "other", "totalAmount": "110.10", "responseCode": "3", "transactionID": "", "partialPayment": true, "customerReceipt": "\n\nDevelocorp, Inc.\n3005 Mesa Verde Dr\nBurbank, CA 91504\n818-730-1662\n\nCREDIT CARD\n\n\nSUBTOTAL: USD $0.00\nSALES TAX: USD $0.10\n---------------------------------------------------------------\nTOTAL TAX:USD $0.10\nTOTAL:USD $0.10\n\n ************null\nDATE & TIME:04-22-25 04:41:36\nREC #: \nINVOICE #: 12345678910\nTYPE: SALE\nREFERENCE ID: 987654321\nDESCRIPTION: Device Sale\n\nTOTAL: USD $0.10\nDECLINED\nNO SIGNATURE REQUIRED\nRefunds permitted as necessary. Not guaranteed.\nTHANK YOU\nCardholder Copy\nRetain this copy for statement verification.\n\n\n\n\n\n\n\n", "merchantReceipt": "\n\nDevelocorp, Inc.\n3005 Mesa Verde Dr\nBurbank, CA 91504\n818-730-1662\n\nCREDIT CARD\n\n\nSUBTOTAL: USD $0.00\nSALES TAX: USD $0.10\n---------------------------------------------------------------\nTOTAL TAX:USD $0.10\nTOTAL:USD $0.10\n\n ************null\nDATE & TIME:04-22-25 04:41:36\nREC #: \nINVOICE #: 12345678910\nTYPE: SALE\nREFERENCE ID: 987654321\nDESCRIPTION: Device Sale\n\nTOTAL: USD $0.10\nDECLINED\nX_______________________\nMary Jane\nI AGREE TO PAY ABOVE TOTAL AMOUNT IN ACCORDANCE WITH CARD ISSUER's AGREEMENT (MERCHANT AGREEMENT IF CREDIT VOUCHER)\nRefunds permitted as necessary. Not guaranteed.\nTHANK YOU\nMerchant Copy\nRetain this copy for statement verification.\n\n\n\n\n\n\n\n", "processedAmount": "0.00", "responseMessage": "Invalid poi device id REFID:273524439", "hostResponseCode": "300", "maskedCardNumber": "", "bank_routing_number":"121122676", // present for ACH transaction "masked_bank_account":"9020", // present for ACH transaction "providedSalesTax": true, "transactionAmount": "110.10" "hostReferenceNumber": "", "transactionTimestamp": "2025-04-22T23:41:36.891Z", "addressVerificationCode": "", "cardHolderVerificationCode": "" }, "transaction_id": "ffe40983-833a-418c-9ce7-750457a9abb2", "internalTransactionID": "987654321", "device": { "id":"a42627a7-1368-4f2d-b22e-f78f2d216d3e", "type":"pax", "name":"Shaun's Mobile", "model":"S24", "serial_number":"1234de30e5fcfcbb7819c18e264ce4000dd0", "sdk_version":"1.0.0", "manufacturer": "Pax", "app_version": "1.0.0 (1)", "os": "android", "os_version": "14" } } } ``` **PAYMENT\_REFUNDED** Triggered when a capture and sale transaction is successfully refunded. (Refer [here](/merchant-api-reference/transactions/refund.md) for details on initiating a refund transaction). ```javascript { "event_uid": "d774ae2550b7288a135dfa025b8b4605", "event": "PAYMENT_REFUNDED", "data": { "token": "card_sandbox_8Aq30HAc8TLFUFvTjqwo556i", "reason": "Discount issued", "metadata": { "email": "test@test.com", "customerId": "123" }, "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "order_number": "150t65898", "transaction_id": "829856bf-e04b-4c57-a092-2a46798859c4", "return_response": { "status": "PASS", "taskID": "54543964", "authCode": "941825", "cardType": "visa", "orderNumber": "79928879", "responseCode": "A0000", "transactionID": "40808945", "returnedAmount": "110.40", "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 06:59 PM \\n REFUND \\n Card # 1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 40808945 \\n SUBTOTAL: USD $16.40 \\n TOTAL: USD $16.40 \\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:59 PM \\n REFUND \\n Card # 1111 \\n Card Type: VISA \\n Entry Mode : KEYED \\n Transaction ID: 40808945 \\n SUBTOTAL: USD $16.40 \\n TOTAL: USD $16.40 \\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", "processedAmount": "110.40", "gratuity": "10.00, "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "externalReferenceID": "79928879", "hostReferenceNumber": "817267004532", "transactionTimestamp": "2025-04-02T18:59:34" }, "internalTransactionID": "987654321", "original_transaction_id": "fb49209e-c0d6-45dd-9045-014e0cfeb356", "device": { "id":"a42627a7-1368-4f2d-b22e-f78f2d216d3e", "type":"pax", "name":"Shaun's Mobile", "model":"S24", "serial_number":"1234de30e5fcfcbb7819c18e264ce4000dd0", "sdk_version":"1.0.0", "manufacturer": "Pax", "app_version": "1.0.0 (1)", "os": "android", "os_version": "14" } } } ``` #### PAYMENT\_ACH Triggered when an ACH payment is processed succesfully. (Refer [here](/merchant-api-reference/transactions/ach-sale.md) for details on initiating an ACH Sale transaction). ```javascript { "event_uid": "ebcb043c76820147048847ae098ff29f", "event": "PAYMENT_ACH", "data": { "token": "ba_sandbox_pjkaTwqPT9VbXAkW8PJRyIvD", "metadata": { "customerId": "123", "email" : "test@test.com" }, "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "payment_id": "026ef76b-b058-4e8a-968a-8ea5053b8f41", "description": "Payment for the services",, "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "ach_response": { "status": "PASS", "taskID": "14947358", "totalAmount": "150.00", "responseCode": "A0000", "transactionID": "14697466", "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-02 06:49 PM \\n ACH - SALE \\n Entry Mode : KEYED \\n Transaction ID: 14697466 \\n Invoice Number: 150t65898 \\n SUBTOTAL: USD $150.00 \\n TOTAL: USD $150.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:49 PM \\n ACH - SALE \\n Entry Mode : KEYED \\n Transaction ID: 14697466 \\n Invoice Number: 150t65898 \\n SUBTOTAL: USD $150.00 \\n TOTAL: USD $150.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", "processedAmount": "150.00", "responseMessage": "Success", "transactionAmount": "150.00", "hostReferenceNumber": "679105875316", "transactionTimestamp": "2025-04-02T18:49:47", "bank_routing_number":"121122676", "masked_bank_account":"9020" }, "order_number": "150t65898", "transaction_id": "0b8ff792-04a5-44c2-b28d-62236668ffb2", "internalTransactionID": "987654321" } } ``` **PAYMENT\_ACH\_REFUNDED** Triggered when an ACH sale transaction is refunded. ```javascript { "event_uid": "0fc67b590832bd588bd02cb1ed3520ec", "event": "PAYMENT_ACH_REFUNDED", "data": { "token": "ba_sandbox_nR9s5Ai6eQhlDaaC4llCCVVF", "account_id": "fa3ac0a8-0cda-4e38-ba9d-357b0f0bd844", "gateway_id": "aa2ba70f-3e45-4830-a8ed-f14d30efd4be", "payment_id": "40f7ea73-1106-4c17-b528-89c2ba95ff0e", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "transaction_id": "22d16d27-7290-4606-8adc-3efa130d986b", "return_response": { "status": "PASS", "taskID": "33320695", "authCode": "575021", "responseCode": "A0000", "transactionID": "82101942", "returnedAmount": "300.00", "customerReceipt": " Sandbox US Merchant \\n 200 Epcot Center Dr \\n Orlando, FL 32836 \\n 800-490-8514 \\n \\n \\n 2025-04-29 06:24 PM \\n REFUND \\n Entry Mode : KEYED \\n Transaction ID: 82101942 \\n SUBTOTAL: USD $300.00 \\n TOTAL: USD $300.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-29 06:24 PM \\n REFUND \\n Entry Mode : KEYED \\n Transaction ID: 82101942 \\n SUBTOTAL: USD $300.00 \\n TOTAL: USD $300.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", "processedAmount": "300.00", "responseMessage": "Success", "hostResponseCode": "00", "hostReferenceNumber": "690385106869", "transactionTimestamp": "2025-04-29T18:24:49", "bank_routing_number":"121122676", "masked_bank_account":"9020" }, "original_transaction_id": "ebfd1537-d411-488f-a5a1-e7f58b1a9bd2" } } ``` #### ADJUSTMENT\_RECEIVED Triggered when settlement files are processed and any kind of adjustment to the payout is made by processor. ```json { "event_uid": "3219ebc7e112790b88c3b619a4223967", "event": "ADJUSTMENT_RECEIVED", "data": { "merchant_id": "e90c1de6-4e87-4c9e-bcbc-c535d6e349ec", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "merchant_name": "Sample Merchant", "transaction_id": "415d9e62-1725-41e3-a6c0-1b7cc3153398", "transaction_amount": "100.00", "auth_code": "DSC633" } } ``` #### **OFFLINE\_SALE** Triggered when an offline sale request is successfully completed. ```json { "event_uid": "cc82699e42b6d60aeca16c4e5712b0ab", "event": "OFFLINE_SALE", "data": { "metadata": { "email": "test@test.com", "customerId": "123" }, "account_id": "fdd24695-1298-496f-b997-89733fc17413", "payment_id": "898abb2e-e389-417a-8b5c-75db4077aa4c", "description": "Payment for the services", "merchant_id": "e6705370-fccc-4bfb-9fb4-0e8a0a0cf426", "internalTransactionID": "987654321", "transaction_id": "941f9361-7a90-4375-99c4-cd7a9794aba6", "offline_sale_response": { "status": "PASS", "currencyCode": "USD", "paymentMethod": "Offline - cash", "transactionType": "Offline Sale Approved", "transactionAmount": "10.00", "transactionTimestamp": "2025-03-31T03:10:00.000Z" } } } ``` #### **TRANSACTION\_STATUS\_CHANGED** Triggered when transaction status is changed after processing. It is applicable to mainly ACH transaction where after initial authorization the funding failed ```javascript { "event_uid": "4d304a4ed5a4e338b4753ab832efd9c0", "event": "TRANSACTION_STATUS_CHANGED", "data": { "account_id": "bb3bc2a6-b5c7-4369-be9c-18455c63c228", "payment_id": "bcd8c963-bf63-40f0-b3f7-673cb4d3c493", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "description": "Payment for the services", "merchant_id": "13116974-76b9-41ec-9c95-53db51c89363", "sale_response": { "status": "PASS", "taskID": "97593488", "authCode": "692081", "cardType": "visa", "totalAmount": "75.48", "responseCode": "A0000", "transactionID": "93256089", "customerReceipt": "", "merchantReceipt": "", "processedAmount": "75.48", "responseMessage": "Success", "hostResponseCode": "00", "maskedCardNumber": "1111", "transactionAmount": "75.48", "hostReferenceNumber": "937213156263", "transactionTimestamp": "2022-02-04T20:59:24", "addressVerificationCode": "Z", "cardTransactionIdentifier": "123456789012345", "cardHolderVerificationCode": "N" }, "transaction_id": "efa04765-b876-46b9-8c0e-39f30d27eb73", "internalTransactionID": "987654321" } } ``` {% endtab %} {% tab title="Batch" %} #### BATCH\_GENERATED When the payment batch is generated, below webhook event is sent. ```javascript { "event_uid": "073bce9da8c54ec4f93179f87afa04d1", "event": "BATCH_GENERATED", "data": { "id": "636e0215-3c4e-4773-bdcd-0d6c1e9ffa0c", "gateway_id": "1f3e0f67-d560-494c-bb1a-97558a462cc5", "becsReport": { "totalCharges": "0.00", "totalRefunds": "0.00", "numberOfCharges": 0, "numberOfRefunds": 0 }, "voidAmount": "2.80", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "approvedAmount": "0.00" } } ``` {% endtab %} {% tab title="Payout" %} ### PAYOUT\_GENERATED When the payout is generated, below webhook event is sent ```javascript { "event_uid": "e6ef6f05fddf9261383bfa2255789eb6", "event": "PAYOUT_GENERATED", "data": { "id": "f8949bde-6d42-4600-acbd-4f428271e0e3", "merchant_id": "1e4e6029-2cc9-4b2c-87c1-7a4b2af6d6c6", "fee_amount": "-0.07", "funding_amount": "-2.73", "adjustment_amount": "0.00", "chargeback_amount": "0.00", "debit_amount": "-2.80", "payout_date": "2025-04-30T19:01:50.657Z" } } ``` {% endtab %} {% endtabs %}