Wiki

Webhooks

You can use webhooks to get updates on transactions and orders faster.

To start, go to the Partner Panel - Settings - Callback URLs Add the Webhook URL in the appropriate field for both SANDBOX and PRODUCTION environments, where you can receive notifications.

Please try to use different URLs for different environments.

Once you add the Webhook URL, you'll start receiving notifications related to:

• Transactions - "event_type": "CHECKOUT_STATUS_CHANGED"
• Orders - "event_type": "ORDER_STATUS_CHANGED"

If you as a partner process your users' payments yourself, skip the Transactions section and go to the Orders section.

Transactions

(Only for partners using our payment system)

"event_type": "CHECKOUT_STATUS_CHANGED"

• CREATED - when payment URL created and provided to Partner in POST /orders (Click to open) responses
• SUCCESS - when the user's payment has been successfully captured
• FAILED - when an error occurred in the user's payment and the user was redirected to a error page

💻 Example:

Code
 
[
  {
    "transaction_id": "3QM7irIto19ZALc12DWDGh53",
    "event_type": "CHECKOUT_STATUS_CHANGED",
    "status": "CREATED",
    "products": [
      {
        "custom_id": "partnerCustomID",
        "unique_id": "9x6tfz9cgo",
        "name": "vignette-si-2a"
      }
    ]
  },
  {
    "transaction_id": "3QM7irIto19ZALc12DWDGh53",
    "event_type": "CHECKOUT_STATUS_CHANGED",
    "status": "SUCCESS",
    "products": [
      {
        "custom_id": "partnerCustomID",
        "unique_id": "9x6tfz9cgo",
        "name": "vignette-si-2a"
      }
    ]
  },
  {
    "transaction_id": "3QM7irIto19ZALc12DWDGh53",
    "event_type": "CHECKOUT_STATUS_CHANGED",
    "status": "FAILED",
    "products": [
      {
        "custom_id": "partnerCustomID",
        "unique_id": "9x6tfz9cgo",
        "name": "vignette-si-2a"
      }
    ]
  }
]

One transaction webhook can have information about multiple orders.

Code
 
[
  {
    "transaction_id": "3QM7irIto19ZALc12DWDGh53",
    "event_type": "CHECKOUT_STATUS_CHANGED",
    "status": "CREATED",
    "products": [
      {
        "custom_id": "partnerCustomID-1",
        "unique_id": "9x6tfz9cgo",
        "name": "vignette-si-2a"
      },
      {
        "custom_id": "partnerCustomID-2",
        "unique_id": "4x3tbz1iao",
        "name": "vignette-at-2a"
      }
    ]
  }
]

Orders

(For all partners)

"event_type": "ORDER_STATUS_CHANGED"

• CREATED - when the user's order is successfully paid and the order is considered such that it can be registered with the national provider.
• PENDING - when the user's order is successfully paid and the order has started authorization with the national provider.
• ACTIVE - when the user's order is successfully registered with the national provider.

💻 Example:

Code
 
[
  {
    "event_type": "ORDER_STATUS_CHANGED",
    "status": "CREATED",
    "product": {
      "custom_id": "partnerCustomID",
      "unique_id": "9x6tfz9cgo",
      "name": "vignette-si-2a"
    }
  },
  {
    "event_type": "ORDER_STATUS_CHANGED",
    "status": "PENDING",
    "product": {
      "custom_id": "partnerCustomID",
      "unique_id": "9x6tfz9cgo",
      "name": "vignette-si-2a"
    }
  },
  {
    "event_type": "ORDER_STATUS_CHANGED",
    "status": "ACTIVE",
    "product": {
      "custom_id": "partnerCustomID",
      "unique_id": "9x6tfz9cgo",
      "name": "vignette-si-2a"
    }
  }
]

If there were multiple orders in a transaction, the Partner will receive multiple webhooks. One order webhook provides information about only one order.