HomeSupport
Search
⌃K
Links

Webhooks

Webhook is a construct used by an application to notify other applications that an event occurred. More precisely, webhook is a user-defined HTTP callback.

Available events

By default Nearpay webhooks can be triggered by the following events:
Event Name
Description
Triggered when a device disconnected from a terminal.
Triggered when a new transaction got confirmed.
Triggered when a terminal got reconciled.
When an admin got revoked from the dashboard.
Triggered when a device connected to a terminal.
When a new admin is added in the dashboard
Triggered when a user got unassigned from a terminal.
Triggered when a transaction got rejected.
Triggered when the terminal updated
Triggered when a Public key got regerated from the dashboard.
Triggered when a new supported sdk added.
Triggered when a new app added from the dashboard.
Triggered when a new transaction got approved.
Triggered when a new admin assigned to a merchant.
Triggered when a merchent admin get revoked.
Triggered when your api key updated.
Triggered when a user assigned to a terminal.
Triggered when a new merchant created.
When a supported SDK removed.
Triggered when a transaction got reversed.
Triggered when new terminal registered.
when a new releasee upgraded from the dashboard.

Payloads

terminal.device.disconnected

{
"id": "0502b3f0-d00d-49c5-8feb-73a986687521",
"tid": "0100001000000010",
"name": null,
"user": {
"id": "1470cc83-e803-40df-9ccb-fb33496b040d"
},
"client": {
"id": "6d92404e-d5ff-4fcd-8590-548a54657450"
},
"device": {
"id": "1fa8ab88-b776-48d3-b2ce-0bda359b99b5"
},
"merchant": {
"id": "a33d09d3-3a8e-4680-86c2-bc91713b7b79"
},
"created_at": "2023-02-15T09:46:30.700Z",
"updated_at": "2023-02-19T13:18:41.344Z"
}

transaction.confirmed

{
"id": "64b8041a-6814-4ccc-8030-ac67a7def03e",
"pan": "5069 68** **** 3592",
"tid": "0100001000000010",
"type": "purchase",
"qr_code": "https://staging.nearpay.io/ui/receipt/64b8041a-6814-4ccc-8030-ac67a7def03e",
"currency": {
"arabic": "ر.س",
"english": "SAR"
},
"end_date": "19/02/2023",
"end_time": "16:30:36",
"merchant": {
"id": "100000000000001",
"name": {
"arabic": "123455",
"english": "NearPay-Test Terminal INMA"
},
"address": {
"arabic": "4321",
"english": "KAFD"
},
"category_code": "0763"
},
"kernel_id": "2d",
"created_at": "2023-02-19T13:30:36.744Z",
"entry_mode": "CONTACTLESS",
"pan_suffix": "",
"start_date": "19/02/2023",
"start_time": "16:30:36",
"updated_at": "2023-02-19T13:30:36.744Z",
"action_code": "100",
"card_scheme": {
"id": "P1",
"name": {
"arabic": "مدى",
"english": "mada"
}
},
"is_approved": false,
"is_refunded": false,
"is_reversed": false,
"amount_other": {
"label": {
"arabic": "مبلغ النقد",
"english": "NAQD AMOUNT"
},
"value": "0.00"
},
"approval_code": {
"label": {
"arabic": "رمز الموافقة",
"english": "Approval Code"
},
"value": "958196"
},
"status_message": {
"arabic": "تم رفض العملية من البنك المصدر للبطاقة",
"english": "DECLINED BY ISSUING BANK"
},
"thanks_message": {
"arabic": "شكرا لاستخدامكم مدى",
"english": "Thank you for using mada"
},
"card_expiration": "24/05",
"receipt_line_one": {
"arabic": "",
"english": ""
},
"receipt_line_two": {
"arabic": "",
"english": ""
},
"transaction_type": {
"id": "00",
"name": {
"arabic": "شراء",
"english": "PURCHASE"
}
},
"transaction_uuid": "03dbe255-055f-4705-b774-195fb876e9b6",
"amount_authorized": {
"label": {
"arabic": "مبلغ الشراء",
"english": "PURCHASE AMOUNT"
},
"value": "51.00"
},
"card_scheme_sponsor": "INMA",
"verification_method": {
"arabic": "لا يتطلب التحقق",
"english": "NO VERIFICATION REQUIRED"
},
"save_receipt_message": {
"arabic": "يرجى الاحتفاظ بالفاتورة",
"english": "please retain receipt"
},
"application_cryptogram": "F41B10D33A8ABBF3",
"application_identifier": "A0000002281010",
"payment_account_reference": "",
"system_trace_audit_number": "000044",
"retrieval_reference_number": "000000008506",
"cryptogram_information_data": "80",
"pos_software_version_number": "1.0.0",
"terminal_verification_result": "0080008000",
"transaction_state_information": "0000",
"cardholader_verfication_result": "3F0000"
}

terminal.reconciled

{
"id": "2d04c490-99dc-46c9-939e-5a0f30663910",
"date": "19/02/2023",
"time": "16:28:21",
"details": {
"total": {
"count": 3,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.05"
},
"refund": {
"count": 0,
"label": {
"arabic": "المستردة",
"english": "Refund"
},
"total": "0.00"
},
"purchase": {
"count": 2,
"label": {
"arabic": "الشراء",
"english": "Purchase"
},
"total": "0.09"
},
"refund_reversal": {
"count": 0,
"label": {
"arabic": "المستردة المعكوسة",
"english": "Refund Reversal"
},
"total": "0.00"
},
"purchase_reversal": {
"count": 1,
"label": {
"arabic": "الشراء المعكوسة",
"english": "Purchase Reversal"
},
"total": "0.04"
}
},
"qr_code": "https://staging.nearpay.io/ui/reconciliation_receipt/2d04c490-99dc-46c9-939e-5a0f30663910",
"schemes": [
{
"pos": {
"debit": {
"count": 2,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.09"
},
"total": {
"count": 3,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.05"
},
"credit": {
"count": 1,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.04"
}
},
"host": {
"debit": {
"count": 2,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.09"
},
"total": {
"count": 3,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.05"
},
"credit": {
"count": 1,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.04"
}
},
"name": {
"label": {
"arabic": "مدى",
"english": "mada"
},
"value": "P1"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"arabic": "فيزا",
"english": "Visa"
},
"value": "VC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"arabic": "ماستر كارد",
"english": "MasterCard"
},
"value": "MC"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"arabic": "امريكان اكسبرس",
"english": "American Express"
},
"value": "AX"
},
"is_balanced": true
},
{
"pos": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"host": {
"debit": {
"count": 0,
"label": {
"arabic": "مدين",
"english": "Debit"
},
"total": "0.00"
},
"total": {
"count": 0,
"label": {
"arabic": "المجموع",
"english": "Total"
},
"total": "0.00"
},
"credit": {
"count": 0,
"label": {
"arabic": "دائن",
"english": "Credit"
},
"total": "0.00"
}
},
"name": {
"label": {
"arabic": "الشبكة الخليجية",
"english": "GCCNET"
},
"value": "GN"
},
"is_balanced": true
}
],
"user_id": "a33d09d3-3a8e-4680-86c2-bc91713b7b79",
"currency": {
"arabic": "ر.س",
"english": "SAR"
},
"end_date": "19/02/2023",
"end_time": "16:28:21",
"merchant": {
"id": "100000000000001",
"name": {
"arabic": "123455",
"english": "NearPay-Test Terminal INMA"
},
"address": {
"arabic": "4321",
"english": "KAFD"
},
"category_code": "0763"
},
"terminal": {
"id": "54dc65b5-0c94-4889-b85b-1eee5e746925"
},
"client_id": "6d92404e-d5ff-4fcd-8590-548a54657450",
"device_id": "1fa8ab88-b776-48d3-b2ce-0bda359b99b5",
"created_at": "2023-02-19T13:28:21.715Z",
"start_date": "19/02/2023",
"start_time": "16:28:21",
"updated_at": "2023-02-19T13:28:21.715Z",
"is_balanced": {
"label": {
"arabic": "الموازنة إكتملت",
"english": "RECONCILIATION COMPLETED"
},
"value": true
},
"merchant_id": "a33d09d3-3a8e-4680-86c2-bc91713b7b79",
"reconciliation": {
"id": "2d04c490-99dc-46c9-939e-5a0f30663910"
},
"card_scheme_sponsor_id": "",
"card_acceptor_terminal_id": "0100001000000010",
"system_trace_audit_number": "000043",
"pos_software_version_number": "1.0.0"
}

client.admin.revoked

{
"id": "4a8142f1-33d7-4bef-991b-1abf8fdebf4d",
"name": "John Doe",
"email": "[email protected]",
"mobile": "+966512345678"
}

terminal.device.connected

{
"id": "0502b3f0-d00d-49c5-8feb-73a986687521",
"tid": "0100001000000010",
"name": null,
"user": {
"id": "1470cc83-e803-40df-9ccb-fb33496b040d"
},
"client": {
"id": "6d92404e-d5ff-4fcd-8590-548a54657450"
},
"device": {
"id": "1fa8ab88-b776-48d3-b2ce-0bda359b99b5"
},
"merchant": {
"id": "a33d09d3-3a8e-4680-86c2-bc91713b7b79"
},
"created_at": "2023-02-15T09:46:30.700Z",
"updated_at": "2023-02-19T13:18:41.344Z"
}

client.admin.created

{
"id": "4a8142f1-33d7-4bef-991b-1abf8fdebf4d",
"name": "John Doe",
"email": "[email protected]",
"mobile": "+966512345678"
}

terminal.user.unassigned

{
"id": "0502b3f0-d00d-49c5-8feb-73a986687521",
"tid": "0100001000000010",
"name": null,
"user": {
"id": "1470cc83-e803-40df-9ccb-fb33496b040d"
},
"client": {
"id": "6d92404e-d5ff-4fcd-8590-548a54657450"
},
"device": {},
"merchant": {
"id": "a33d09d3-3a8e-4680-86c2-bc91713b7b79"
},
"created_at": "2023-02-15T09:46:30.700Z",
"updated_at": "2023-02-19T13:16:26.884Z"
}

transaction.rejected

{
"id": "64b8041a-6814-4ccc-8030-ac67a7def03e",
"pan": "5069 68** **** 3592",
"tid": "0100001000000010",
"qr_code": "https://staging.nearpay.io/ui/receipt/64b8041a-6814-4ccc-8030-ac67a7def03e",
"currency": {
"arabic": "ر.س",
"english": "SAR"
},
"end_date": "19/02/2023",
"end_time": "16:30:36",
"merchant": {
"id": "100000000000001",
"name": {
"arabic": "123455",
"english": "NearPay-Test Terminal INMA"
},
"address": {
"arabic": "4321",
"english": "KAFD"
},
"category_code": "0763"
},
"kernel_id": "2d",
"entry_mode": "CONTACTLESS",
"pan_suffix": "",
"start_date": "19/02/2023",
"start_time": "16:30:36",
"action_code": "100",
"card_scheme": {
"id": "P1",
"name": {
"arabic": "مدى",
"english": "mada"
}
},
"is_approved": false,
"is_refunded": false,
"is_reversed": false,
"transaction": {
"id": "8506"
},
"amount_other": {
"label": {
"arabic": "مبلغ النقد",
"english": "NAQD AMOUNT"
},
"value": "0.00"
},
"approval_code": {
"label": {
"arabic": "رمز الموافقة",
"english": "Approval Code"
},
"value": "958196"
},
"status_message": {
"arabic": "تم رفض العملية من البنك المصدر للبطاقة",
"english": "DECLINED BY ISSUING BANK"
},
"thanks_message": {
"arabic": "شكرا لاستخدامكم مدى",
"english": "Thank you for using mada"
},
"card_expiration": "24/05",
"receipt_line_one": {
"arabic": "",
"english": ""
},
"receipt_line_two": {
"arabic": "",
"english": ""
},
"transaction_type": {
"id": "00",
"name": {
"arabic": "شراء",
"english": "PURCHASE"
}
},
"transaction_uuid": "03dbe255-055f-4705-b774-195fb876e9b6",
"amount_authorized": {
"label": {
"arabic": "مبلغ الشراء",
"english": "PURCHASE AMOUNT"
},
"value": "51.00"
},
"card_scheme_sponsor": "INMA",
"verification_method": {
"arabic": "لا يتطلب التحقق",
"english": "NO VERIFICATION REQUIRED"
},
"save_receipt_message": {
"arabic": "يرجى الاحتفاظ بالفاتورة",
"english": "please retain receipt"
},
"application_cryptogram": "F41B10D33A8ABBF3",
"application_identifier": "A0000002281010",
"customer_reference_number": null,
"payment_account_reference": "",
"system_trace_audit_number": "000044",
"retrieval_reference_number": "000000008506",
"cryptogram_information_data": "80",
"pos_software_version_number": "1.0.0",
"terminal_verification_result": "0080008000",
"transaction_state_information": "0000",
"cardholader_verfication_result": "3F0000"
}

terminal.updated.configurations

{
"id": "fcb46b39-16f4-4869-a3d4-7ee3db593082",
"is_completed": true
}

client.public-key.regenerated

{
"id": "d9b724b5-b958-4716-b39f-ef9376c5269a",
}

app.supported.sdk.added

{
"id": "6bf053eb-603e-4449-9aa1-d4a434e799d8",
"name": "demo.app.com",
"app_name": "Demo App",
"added_sdk": {
"id": "1dfd17cf-4afb-43de-a725-60229b52e322",
"name": "sdk version",
"version": 22,
"created_at": "2022-12-27T16:02:18.481Z",
"updated_at": "2022-12-27T16:02:18.481Z"
},
"created_at": "2023-02-19T12:44:19.007Z",
"updated_at": "2023-02-19T12:44:19.007Z"
}

app.created

{
"id": "6bf053eb-603e-4449-9aa1-d4a434e799d8",
"name": "demo.app.com",
"client": {
"id": "d9b724b5-b958-4716-b39f-ef9376c5269a"
},
"app_name": "Demo app",
"created_at": "2023-02-19T12:44:19.007Z",
"updated_at": "2023-02-19T12:44:19.007Z"
}

merchant.revoked.admin

{
"id": "b1c04795-2826-4c3b-92a3-534ab9806aaa",
"name": "John Doe",
"email": "[email protected]",
"mobile": "+966512345678"
​

client.api-key.regenerated

{
"id": "d9b724b5-b958-4716-b39f-ef9376c5269a"
}

transaction.approved

{
"id": "64b8041a-6814-4ccc-8030-ac67a7def03e",
"pan": "5069 68** **** 3592",
"tid": "0100001000000010",
"type": "purchase",
"qr_code": "https://staging.nearpay.io/ui/receipt/64b8041a-6814-4ccc-8030-ac67a7def03e",
"currency": {
"arabic": "ر.س",
"english": "SAR"
},
"end_date": "19/02/2023",
"end_time": "16:30:36",
"merchant": {
"id": "100000000000001",
"name": {
"arabic": "123455",
"english": "NearPay-Test Terminal INMA"
},
"address": {
"arabic": "4321",
"english": "KAFD"
},
"category_code": "0763"
},
"kernel_id": "2d",
"created_at": "2023-02-19T13:30:36.744Z",
"entry_mode": "CONTACTLESS",
"pan_suffix": "",
"start_date": "19/02/2023",
"start_time": "16:30:36",
"updated_at": "2023-02-19T13:30:36.744Z",
"action_code": "100",
"card_scheme": {
"id": "P1",
"name": {
"arabic": "مدى",
"english": "mada"
}
},
"is_approved": false,
"is_refunded": false,
"is_reversed": false,
"amount_other": {
"label": {