Skip to main content
POST
Register a webhook endpoint

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

Unique key to prevent duplicate creation or execution.

Required string length: 8 - 128

Body

application/json
url
string<uri>
required
events
enum<string>[]
required
Minimum array length: 1

Enum extensível: ignore tipos desconhecidos.

Available options:
remittance.created,
remittance.on_hold,
remittance.rejected,
remittance.fx_contracted,
remittance.fx_failed,
remittance.funding_confirmed,
remittance.funding_failed,
remittance.payout_processing,
remittance.payout_completed,
remittance.payout_failed,
remittance.funds_held_brl,
remittance.payout_returned,
settlement.created,
settlement.closed,
settlement.due,
settlement.overdue,
settlement.completed,
sender.status_changed,
sender.compliance_level_changed,
beneficiary.status_changed,
credit_line.threshold_reached,
inventory.created,
inventory.status_changed
description
string

Response

Webhook created

webhookId
string
url
string<uri>
events
enum<string>[]

Enum extensível: ignore tipos desconhecidos.

Available options:
remittance.created,
remittance.on_hold,
remittance.rejected,
remittance.fx_contracted,
remittance.fx_failed,
remittance.funding_confirmed,
remittance.funding_failed,
remittance.payout_processing,
remittance.payout_completed,
remittance.payout_failed,
remittance.funds_held_brl,
remittance.payout_returned,
settlement.created,
settlement.closed,
settlement.due,
settlement.overdue,
settlement.completed,
sender.status_changed,
sender.compliance_level_changed,
beneficiary.status_changed,
credit_line.threshold_reached,
inventory.created,
inventory.status_changed
status
enum<string>
Available options:
ACTIVE,
DISABLED