Create legacy merchant webhooks

Configures webhooks using the legacy workflow, including the URLs a merchant's webhooks are sent to and the event types which trigger webhooks.

If you need to 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.

For a tutorial about configuring and using webhooks, see Configuring webhooks in Guides.

πŸ“˜

Note

For the current workflow, see the Register webhook URLs endpoint instead.

⚠️

Try It

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

Request parameters

  • merchantId
  • payoutAccountId
  • webhooks
  • webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED
  • webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED.url
  • webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER
  • webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER.url
  • webhooks.CARD_DATA_UPDATED
  • webhooks.CARD_DATA_UPDATED.url
  • webhooks.CARD_SAVED
  • webhooks.CARD_SAVED.url
  • webhooks.ECHECK_SAVED
  • webhooks.ECHECK_SAVED.url
  • webhooks.SUBSCRIPTION_DETAILS
  • webhooks.SUBSCRIPTION_DETAILS.url
  • webhooks.TRANSACTION_AUTHORIZED
  • webhooks.TRANSACTION_AUTHORIZED.url
  • webhooks.TRANSACTION_CAPTURED
  • webhooks.TRANSACTION_CAPTURED.url
  • webhooks.TRANSACTION_PENDING
  • webhooks.TRANSACTION_PENDING.url
  • webhooks.TRANSACTION_REFUNDED
  • webhooks.TRANSACTION_REFUNDED.url
  • webhooks.TRANSACTION_SETTLED
  • webhooks.TRANSACTION_SETTLED.url
  • webhooks.TRANSACTION_VOIDED
  • webhooks.TRANSACTION_VOIDED.url
  • webhooks.PAYOUT
  • webhooks.PAYOUT.url
  • webhooks.SPENDBACK
  • webhooks.SPENDBACK.url

Response parameters

  • merchantId
  • payoutAccountId
  • webhooks
  • webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED
  • webhooks.ACCOUNT_UPDATER_ACCOUNT_CLOSED.url
  • webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER
  • webhooks.ACCOUNT_UPDATER_CONTACT_CARDHOLDER.url
  • webhooks.CARD_DATA_UPDATED
  • webhooks.CARD_DATA_UPDATED.url
  • webhooks.CARD_SAVED
  • webhooks.CARD_SAVED.url
  • webhooks.ECHECK_SAVED
  • webhooks.ECHECK_SAVED.url
  • webhooks.SUBSCRIPTION_DETAILS
  • webhooks.SUBSCRIPTION_DETAILS.url
  • webhooks.TRANSACTION_AUTHORIZED
  • webhooks.TRANSACTION_AUTHORIZED.url
  • webhooks.TRANSACTION_CAPTURED
  • webhooks.TRANSACTION_CAPTURED.url
  • webhooks.TRANSACTION_PENDING
  • webhooks.TRANSACTION_PENDING.url
  • webhooks.TRANSACTION_REFUNDED
  • webhooks.TRANSACTION_REFUNDED.url
  • webhooks.TRANSACTION_SETTLED
  • webhooks.TRANSACTION_SETTLED.url
  • webhooks.TRANSACTION_VOIDED
  • webhooks.TRANSACTION_VOIDED.url
  • webhooks.PAYOUT
  • webhooks.PAYOUT.url
  • webhooks.SPENDBACK
  • webhooks.SPENDBACK.url
  • dateCreated
  • dateLastModified
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!