Webhook Events
Complete reference of all webhook events sent by Inkress and their payload structures.
Event Structure
All webhook events follow a consistent structure:
{
"event": "resource.action",
"facilitator": "Inkress",
"resource_name": {
// Resource data
}
}Order Events
Events related to one-time payments and orders.
orders.paid
Success
Triggered when an order is successfully paid.
{
"event": "orders.paid",
"order": {
"id": 2345,
"status": "paid",
"total": 14000,
"reference": "53837|42iyvtv",
"currency": "JMD",
"lines": [],
"customer": {
"id": 4829,
"email": "customer@example.com",
"first_name": "John",
"last_name": "Doe"
},
"uid": "278282jbsh-595e-4011-b808-2872872",
"updated_at": "2025-12-27T18:39:07.670135Z",
"meta_data": null,
"created_at": "2025-12-27T18:39:07.670135Z",
"payment_details": {
"provider": "fac",
"brand": "MasterCard",
"last4": "1821"
}
},
"facilitator": "Inkress"
}orders.created
Triggered when a new order is created.
orders.failed
Triggered when a payment attempt fails.
orders.refunded
Triggered when an order is refunded.
Subscription Events
Events related to recurring billing and subscriptions.
subscriptions.created
Created
Triggered when a new subscription is created.
{
"event": "subscriptions.created",
"facilitator": "Inkress",
"subscription": {
"id": "sub_1234567890",
"customer_id": "cus_1234567890",
"plan_id": "plan_1234567890",
"status": "active",
"current_period_start": "2023-01-01T00:00:00Z",
"current_period_end": "2023-02-01T00:00:00Z",
"cancel_at_period_end": false
}
}subscriptions.created
subscriptions.trial_ended
subscriptions.activated
subscriptions.payment_failed
subscriptions.payment_success
subscriptions.cancelled
subscriptions.trial_ending
subscriptions.adhoc_charge
Payout Events
Events related to merchant payouts (Financial Requests).
financial_requests.requested
Pending
Triggered when a payout is requested.
{
"event": "financial_requests.requested",
"financial_request": {
"id": 2233,
"status": "pending",
"total": 1400,
"currency": "JMD",
"source_account": {
"name": "Inkress Wallet",
"currency_code": "JMD"
},
"destination_account": {
"name": "Scotiabank",
"currency_code": "JMD",
"bank_name": "Scotiabank",
"account_number": "******7618",
"branch_name": "Half Way Tree",
"account_holder_name": "John Doe",
"account_type": "Chequing"
},
"uid": "18272872-595e-4011-b808-28728hbussbuyy628g"
},
"facilitator": "Inkress"
}financial_requests.processing
financial_requests.processed
financial_requests.failed
financial_requests.rejected
Payment Link Events
payment_links.visited
Analytics
Triggered when a customer visits a payment link.
{
"event": "payment_links.visited",
"payment_link": {
"id": 2233,
"currency": "JMD",
"title": "Payment Link",
"description": "hello world",
"status": "active",
"usage_limit": 999,
"total": 4000,
"data": {
// Custom data
},
"customer": {
"name": "Scotiabank",
"id": "28728",
"first_name": "Altou",
"last_name": "Brown",
"email": "alro@gmail.com"
},
"uid": "18272872-595e-4011-b808-28728hbussbuyy628g"
},
"facilitator": "Inkress"
}