Register webhook URLs

New webhook workflow

Registers webhooks for a specific merchant ID or payout account ID. These webhooks are callbacks for transactions, payouts, or spendbacks.

• Each webhook for a merchant ID receives the same information for all transaction events.
• Each webhook for a payout account ID receives the same information for all payout and spendback events.

You can create multiple webhooks for the same merchant ID or payout account ID. This is useful for situations where you have multiple workflows from a single event, such as when you need to send the information to two different internal departments but they need to do different things with the same information.

<!-- theme: warning -->

⚠️ Try It

To use the Try It feature for this endpoint, you must use the credentials for your Sandbox API user.

<!-- theme: warning -->

🛑 Important

Nexio supports only either the legacy webhooks or these new ones. Before configuring URLs for your webhooks, ensure that you do not have any URLs for legacy ones configured: View legacy merchant webhook configuration.

<div style="display:none;">

Request parameters

• merchantId
• webhookUrls
• payoutAccountId
• accountId

Response parameters

• merchantId
• payoutAccountId
• accountId
• webhookUrls
• dateCreated
• dateLastModified

</div>

Next steps

• If needed, whitelist the IP addresses that send the webhooks. You can find the list for both sandbox and production environments at https://ip-ranges.nex.io/ip-ranges.json.
• Retrieve a list of webhook URLs that are registered for a merchant ID or payout account ID.
• For a tutorial on how to register and use webhooks, see Webhooks in Guides.

For the legacy method for creating webhooks, see the Create legacy merchant webhooks endpoint.

{
  "merchantId": "000999",
  "payoutAccountId": "3927",
  "accountId": "27592004",
  "webhookUrls": [
    "https://your-ecommerce-website.example.com/transactionwebhook12345"
  ],
  "dateCreated": "2019-03-22T16:58:51.957Z",
  "dateLastModified": "2019-04-04T18:54:58.011Z"
}