POST
/
webhooks

Headers

ApiKey
string
required

Your api key. To create a key, please get into our dashboard. If you don't have access to it, please reach the Support team.

MerchantId
string
required

Your merchant ID. This information is available in our dashboard. If you don't have access to it, please reach the Support team.

Environment
enum<string>
required

Allow you to choose between the sandbox mode to perform some tests or the live mode for real world transactions.

Available options:
live,
sandbox

Body

application/json
url
string
required

Fully qualified url, starting with https://, of the webhook endpoint.

events
enum<string>[]
required

The list of events to enable for this endpoint.

Available options:
receipt.created,
sms.created,
sms.sent,
sms.received,
sms.failed,
transfer.created,
transfer.processing,
transfer.succeeded,
transfer.failed,
transfer_irt.created,
transfer_irt.processing,
transfer_irt.succeeded,
transfer_irt.failed,
payment_intent.created,
payment_intent.processing,
payment_intent.succeeded,
payment_intent.action_required,
payment_intent.payment_failed,
payment.created,
payment.pending,
payment.succeeded,
payment.action_required,
payment.failed,
provisioning.created,
provisioning.succeeded,
provisioning.failed,
transaction.payment_collected,
transaction.deposit,
provider.wave
description
string

An optional description of what the webhook is used for.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Response

201 - application/json
id
string
required

Unique identifier for the Webhook

createdAt
string
required

Datetime in UTC timezone at which this object was created. Follows the Datetime ISO.

updatedAt
string
required

Datetime in UTC timezone at which this object was updated. Follows the Datetime ISO.

mode
enum<string>
required

Mode in which this Webhook exists. The sandbox mode can be used during the integration phase and is available as soon as the merchant account is created. No real transactions are made in this mode. The live mode has to be used to make real transactions.

Available options:
live,
sandbox
events
string[]
required

The list of events to enable for this endpoint.

metadata
object
required

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

status
enum<string>
required

The webhook status

Available options:
enabled,
disabled
url
string
required

Fully qualified url of the webhook endpoint.

description
string

An optional description of what the webhook is used for.

secret
string

The endpoint’s secret, used to generate webhook signatures. Only returned at creation.

Get all webhooksGet a webhook