Skip to main content
POST
Criar assinatura de webhook
Uma assinatura por URL. Depois de criar, valide a verificação de assinatura no sandbox antes de operar em produção.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required
Required string length: 1 - 255

Body

application/json
eventTypes
enum<string>[]
required

Tipos de evento que serão entregues — assine só o que sua integração consome.

Minimum array length: 1
Available options:
payment.created.v1,
payment.requires_action.v1,
payment.succeeded.v1,
payment.failed.v1,
refund.requested.v1,
refund.updated.v1,
refund.succeeded.v1,
payout.requested.v1,
payout.updated.v1,
dispute.opened.v1,
dispute.updated.v1,
merchant.kyc.updated.v1,
merchant.status.updated.v1
url
string<uri>
required

Endpoint HTTPS público (endereços privados são recusados).

Required string length: 8 - 2000

Response

Default Response

createdAt
string<date-time>
required
environment
enum<string>
required
Available options:
live,
test
eventTypes
enum<string>[]
required
Minimum array length: 1
Available options:
payment.created.v1,
payment.requires_action.v1,
payment.succeeded.v1,
payment.failed.v1,
refund.requested.v1,
refund.updated.v1,
refund.succeeded.v1,
payout.requested.v1,
payout.updated.v1,
dispute.opened.v1,
dispute.updated.v1,
merchant.kyc.updated.v1,
merchant.status.updated.v1
id
string<uuid>
required
status
enum<string>
required
Available options:
ACTIVE,
DISABLED,
ERROR,
PENDING
updatedAt
string<date-time>
required
url
string<uri>
required
Maximum string length: 2000