Skip to main content
POST
Register a URL to receive events (secret shown once)

Authorizations

Authorization
string
header
required

Your secret key: sk_test_... or sk_live_...

Headers

Idempotency-Key
string

Your unique key for this request; retries reuse it.

Required string length: 1 - 255

Body

application/json
url
string<uri>
required
Maximum string length: 2048
events
enum<string>[]
Minimum array length: 1
Available options:
payin.succeeded,
payin.failed,
payin.settled,
payout.succeeded,
payout.failed,
payout_recipient.approved,
payout_recipient.rejected

Response

Success

id
string
required
url
string
required
events
string[]
required
secret_hint
string
required
enabled
boolean
required
mode
enum<string>
required
Available options:
test,
live
created_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
secret
string
required