Skip to main content
POST

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body used to trigger a test Payments webhook event.

You need to specify the event type. You can optionally include the override_data property to customize the payload. The provided fields must match the webhook event data structure for the specified event type.

event_type
enum<string>
required

The event type. To learn the trigger condition of each event type, refer to Webhook event types and event data.

Available options:
wallets.transaction.created,
wallets.transaction.updated,
wallets.transaction.failed,
wallets.transaction.succeeded,
wallets.mpc.tss_request.created,
wallets.mpc.tss_request.updated,
wallets.mpc.tss_request.failed,
wallets.mpc.tss_request.succeeded,
wallets.addresses.created,
wallets.created,
wallets.updated,
wallets.token_listing.failed,
wallets.token_listing.succeeded,
mpc_vaults.created,
mpc_vaults.updated,
mpc_vaults.deleted,
organizations.updated,
fee_station.transaction.created,
fee_station.transaction.updated,
fee_station.transaction.failed,
fee_station.transaction.succeeded,
fee_station.fiat_transaction.created,
wallet.token.enabled,
wallet.chain.enabled,
wallet.mpc.balance.updated,
wallet.web3.balance.updated,
wallet.token.disabled,
wallet.chain.disabled,
token.suspended.deposit,
token.suspended.withdraw,
payment.transaction.created,
payment.transaction.late,
payment.transaction.completed,
payment.transaction.held,
payment.transaction.failed,
payment.account.balance.updated,
payment.status.updated,
payment.order.status.updated,
payment.refund.status.updated,
payment.settlement.status.updated,
payment.payout.status.updated,
payment.bank_withdrawal.status.updated,
payment.address.updated,
payment.subscription.status.updated,
payment.charge.status.updated,
payment.bulk_send.status.updated,
payment.bulk_send.item.status.updated,
payment.transaction.external.created,
payment.transaction.external.completed,
payment.transaction.settlement_network.created,
payment.transaction.settlement_network.completed,
compliance.disposition.status.updated,
compliance.kyt.screenings.status.updated,
compliance.kya.screenings.status.updated
Example:

"wallets.transaction.created"

override_data
object

An optional object to customize the webhook event payload. Include only the fields you want to override.

The provided fields must match the webhook event data structure for the specified event type. For the full event data structure, refer to the data.data property in the response of List all webhook events.

If this property is omitted, a default payload is returned.

Example:

Response

The request was successful.

triggered
boolean

Whether a test webhook event was successfully triggered.

  • true: The test webhook event was successfully triggered.
  • false: The test webhook event could not be triggered.
Example:

true