Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

API key issued during merchant onboarding.

Headers

Idempotency-Key
string

Optional client-supplied key. Identical key + identical body within 24h replays the original response. Identical key + different body returns 409 idempotency_conflict. The hash is over raw bytes — clients retrying must send the byte-identical body; a re-serialised JSON payload will produce a different hash and a 409. Strongly recommended for retry-safe clients.

Pattern: ^[A-Za-z0-9_\-]{8,255}$

Body

application/json

CreateWebhookEndpointDto

url
string<url>
required
event_categories
enum<string>[]
required
Minimum array length: 1
Available options:
onramp,
offramp,
conversion,
transfer,
deposit,
kyc

Response

Webhook endpoint created

status
enum<boolean>
required
Available options:
true
Example:

true

message
string
required

Human-readable summary

Example:

"Webhook endpoint created"

code
enum<string>
required
Available options:
ok
Example:

"ok"

data
object
required
meta
object
required