🔗 Integrating With Your Webhook

🔔 Webhook Integration

🔔

Real-time Transaction Updates

Implement a webhook to receive real-time transaction updates by creating a POST API endpoint designed to accept transaction parameters. Include your API URL in the "webhookUrl" variable along with other required parameters as specified in the Hesabe developer portal.

📖 Refere more about Hesabe Payment Intergrations [ 🔗 Click Here ]

📋 Webhook Implementation Steps

🌐 API Endpoints

🌍 Environment	🔗 API URL
🧪 Sandbox / Test	https://sandbox.hesabe.com/checkout
🚀 Production / Live	https://api.hesabe.com/checkout

📋 Request Parameters

🏷️ Field	📋 Type	📝 Description
amount	Numeric	Amount in currency
currency	String	ISO currency code
responseUrl	String	Redirect URL on success
failureUrl	String	Redirect URL on failure
merchantCode	Numeric	Assigned by Hesabe
paymentType	Numeric	0 = Indirect, 1 = KNET, 2 = Visa/MasterCard, 7 = Amex, 9 = Apple Pay, 15 = Recurring / Subscription Method
version	String	API version (e.g., 2.0)
orderReferenceNumber	String	Your reference/order ID
variable1-5	String	Optional key-value pairs (Label__Value)
name	String	Customer name
mobile_number	Numeric (8)	Customer mobile (no country code)
email	String	Customer email
saveCard	Boolean	Save card for tokenization
cardId	String	Tokenized card ID
authorize	Boolean	Authorization-only transaction
webhookUrl	String	Your endpoint for receiving payment status

1Create POST API Endpoint

Create a POST API endpoint in your application to receive transaction parameters

2Add Webhook URL

Include your API URL in the "webhookUrl" variable when initiating payment requests

3Process Webhook Data

Handle incoming webhook data to update your system with transaction status

📄 Example Webhook Response

For testing purposes, you can refer to the example webhook response provided below:

{
   "blocks":[
      {
         "type":"header",
         "text":{
            "type":"plain_text",
            "text":"TRANSACTION SUCCESSFUL",
            "emoji":true
         }
      },
      {
         "type":"section",
         "fields":[
            {
               "type":"mrkdwn",
               "text":"*Date & Time:*\n2023-09-20T10:09:36"
            },
            {
               "type":"mrkdwn",
               "text":"*Transaction Token:*\n84221716951937729753667644493"
            }
         ]
      },
      {
         "type":"section",
         "fields":[
            {
               "type":"mrkdwn",
               "text":"*Order Reference Number:*\n1695193758"
            },
            {
               "type":"mrkdwn",
               "text":"*Service Type:*\nPayment Gateway"
            }
         ]
      },
      {
         "type":"section",
         "fields":[
            {
               "type":"mrkdwn",
               "text":"*Amount:*\nKWD 49"
            },
            {
               "type":"mrkdwn",
               "text":"*Payment Type:*\nKNET"
            }
         ]
      }
   ],
   "token":"84221716951937729753667644493",
   "amount":"49.000",
   "reference_number":"1695193758",
   "status":"SUCCESSFUL",
   "payment_type":"KNET",
   "service_type":"Payment Gateway",
   "datetime":"2023-09-20 10:09:36"
}

🔑 Key Response Fields

🏷️ Field Name	📝 Description	💡 Example Value
token	Unique transaction identifier returned by Hesabe	84221716951937729753667644493
amount	Transaction amount with decimal precision	49.000
reference_number	Merchant's order reference number	1695193758
status	Transaction status (SUCCESSFUL, FAILED, PENDING)	SUCCESSFUL
payment_type	Payment method used for the transaction	KNET
datetime	Transaction timestamp in YYYY-MM-DD HH:MM:SS format	2023-09-20 10:09:36

✅

Benefits of Webhook Integration

This webhook will enable your system to receive real-time transaction updates in a structured format, allowing for immediate processing, automatic order fulfillment, and instant notification of successful transactions.