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.

Try It

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

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.

Request parameters

  • merchantId
  • webhookUrls
  • payoutAccountId
  • accountId

Response parameters

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

Next steps

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The Nexio merchant ID to register the webhook URL for. The ID parameter name to use is merchantId.

Either this parameter or payoutAccountId is required.

webhookUrls
array of strings
required

An array of all the webhooks to configure for the specified merchant ID, payout account ID, or account ID. The array submitted overwrites any existing array values.

Important: You must include any existing webhooks in this array, or they will be replaced. To get a list of existing webhooks, see the View webhook URLs by ID and type endpoint.

To remove all webhook URLs, send the request with an empty array.

webhookUrls*
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json