Webhook Examples
Webhook Overview
Our API can push real‑time notifications to your application every time a transaction is created, updated, or otherwise changes state. These event callbacks---webhooks---eliminate the need for constant polling and let you trigger downstream business logic (e.g., ledger updates, email receipts, or risk checks) the moment they happen.
How it works 🚀
Receive When a qualifying event occurs, we send a signed
POSTrequest containing a JSON payload like the samples shown below.Acknowledge Return an HTTP
2xxstatus within 10 seconds. Any non‑2xx code triggers an automatic retry with exponential back‑off (up to 24 hours).Verify (recommended) Use the
X‑Signatureheader to validate the payload's HMAC‑SHA256 signature against your webhook secret.
Need a sandbox? Point your endpoint to
https://webhook.site/...(or any catcher) to inspect payloads while you build.
The sections that follow contain de‑identified sample payloads for each transaction type---purchase authorizations, reloads, ATM withdrawals, balance inquiries, and more. Copy them into your tests or monitoring tools to simulate live traffic and ensure your integration is production‑ready.
Purchase (Internet / Phone Authorization) — PP80DS
{
"MessageType": "Transaction",
"Amount": "114013",
"ApprovalCode": "377907",
"CalculatedFeeAmount": "",
"CardNumber": "6970",
"CardStatus": "ACT",
"TimeStamp": "2025-04-18 14:55:28",
"PostTransactionCardBalance": "0",
"PostTransactionHoldsBalance": "114013",
"TerminalAddress": "BIOPLUS SP PHARMACYINDIA",
"TerminalCity": "INDIANAPOLIS",
"TerminalCountry": "US",
"TerminalID": "0001",
"TerminalNameLocation": "",
"TerminalOwner": "Sample Pharmacy",
"TransactionCode": "PP80DS",
"TransactionDescription": "Purchase (Internet / Phone Authorization)",
"TransactionId": "967297ae-e208-4268-a0ea-e1bea1d1b75d",
"TransactionOrigin": "POS",
"UniqueRequestId": "",
"MCC": "5912",
"RetailPackId": "1000000001",
"IssuerName": "HealthCo Rx",
"ProductType": "Virtual Rx Sample Plan",
"ISOFullMessage": "ISO0260…(truncated)",
"AdditionalDataCode": "",
"AdditionalDataCodeDesc": "",
"AdditionalFeeOperation": "Credit",
"AdditionalFee": "0",
"BusinessProcessId": "29342e21:19649b139bd:-4f4c"
}
Authorization — PP00DS
Balance Inquiry — XP31DS
VRX Reload — XP20DS
VRX Unload — XP25DS
ATM Withdrawal — AP01DS
Last updated