Webhook Service

View legacy merchant webhook configuration

Returns a merchant's webhook configuration. For a tutorial about configuring and using webhooks, see Configuring legacy webhooks in Guides.

<!-- theme: info -->

📘 Note

For the current workflow, see the View webhook URLs by ID and type endpoint instead.

<!-- theme: warning -->

⚠️ Try It

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

<div style="display:none;">

Request parameters

  • id

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
</div>
get/webhook/v3/config/{id}

Path parameters

idstring required
Example:000999

The merchant ID or the payout account ID.

Response

Success

merchantIdMerchantId — unresolved $ref
payoutAccountIdPayoutAccountId — unresolved $ref
webhooksWebhooks — unresolved $ref
dateCreatedstring

The date and time the configuration was created, formatted as an ISO-8601 date expressed in UTC.

dateLastModifiedstring

The date and time the configuration was last modified, formatted as an ISO-8601 date expressed in UTC.

Changes