Skip to main content
WEBHOOK

Body

application/json

Payload delivered for the funds.deposit_returned webhook event.

type
string
required

Webhook event identifier.

Allowed value: "funds.deposit_returned"
transaction_id
string
required

Opaque funding transaction reference.

user_id
string
required

Globally unique public identifier for a user.

Required string length: 14 - 42
account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42
reason
enum<string>
required

Partner-safe reason why the deposit was returned.

Available options:
account_details_mismatch,
limit_exceeded,
duplicate,
account_restricted,
other
amount
FundsDepositAssetAmount · object

Deposit amount. Absent when it cannot be resolved to a public asset and decimal value.

fee
FundsDepositAssetAmount · object

Deposit fee, including a zero fee. Absent when fee data is unavailable or cannot be resolved.

observed_at
string<date-time>

Time at which the deposit transition was observed.

Response

2XX

Delivery endpoint accepted the webhook.