Website logo
⌘K
API TRXPS
API Reference
API Compatibility
Authentication
Requirements
Open API 3.0
Webhooks
Docs powered by Archbee

Webhooks

2min

As mentioned before, we will notify you if something interesting happens in your account. When an interesting event occurs, we create a new webhook and send it to you.

For example, when a payment succeeds, we create a Payment.created event; and when a checkout or a merchant has been updated we send you a Checkout.updated and Merchant.updated webhook. Please note, that many API requests may cause multiple events to be created.

For example, if a payment success we will send a Checkout.updated and Payment.created event.

Example System Call to your URL

All URLs will be called via POST

JS
{
    "event_type": "Payment.created",
    "event_id": "9547ae77-dd2a-5b81-b1c9-f902ce187d8d",
    "webhook_id": "webhook_j0WvxB71upLTUN9EYP1qs",
    "object_type": "Payment",
    "object_action": "created",
    "object": {
        /// Object data
    }
}





Our webhooks are signed. Please check the x-signature-hmac-v1 header - it's recommended to check signature for validity.

The Webhooks are signed with the following setting:

  • Algorithm: SHA256
  • Payload: Entire Payload (body)
  • Secret: Shared secret per URL



JS
  POST /your-webhook-url HTTP/1.1
  Host: yourserver.com
  x-signature-hmac-v1: 6754b105f95c0cd9c544701451df7ffeebcb4ff7f17b64f75239502b27b1d8ab
  Content-Type: application/json

  {
      "event_type": "Payment.created",
      "event_id": "9547ae77-dd2a-5b81-b1c9-f902ce187d8d",
      "webhook_id": "webhook_j0WvxB71upLTUN9EYP1qs",
      "object_type": "Payment",
      "object_action": "created",
      "object": {
          /// Object data
      }
  }










Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Open API 3.0
Docs powered by Archbee
TABLE OF CONTENTS
Example System Call to your URL
Docs powered by Archbee