{
"type": "funds.deposit_held",
"transaction_id": "FRABCDEF123456",
"user_id": "AA55 N84G QOIR A67A",
"account_id": "WCQY T95Y CUL2 A7NX",
"amount": {
"asset": "USD",
"value": "100.00"
},
"fee": {
"asset": "USD",
"value": "0"
}
}Webhooks
Deposit held
A deposit is held pending review or additional checks.
WEBHOOK
funds.deposit_held
{
"type": "funds.deposit_held",
"transaction_id": "FRABCDEF123456",
"user_id": "AA55 N84G QOIR A67A",
"account_id": "WCQY T95Y CUL2 A7NX",
"amount": {
"asset": "USD",
"value": "100.00"
},
"fee": {
"asset": "USD",
"value": "0"
}
}Body
application/json
Payload delivered for the funds.deposit_held webhook event.
Webhook event identifier.
Allowed value:
"funds.deposit_held"Opaque funding transaction reference.
Globally unique public identifier for a user.
Required string length:
14 - 42Globally unique public identifier for an account.
Required string length:
14 - 42Deposit amount. Absent when it cannot be resolved to a public asset and decimal value.
Show child attributes
Show child attributes
Deposit fee, including a zero fee. Absent when fee data is unavailable or cannot be resolved.
Show child attributes
Show child attributes
Time at which the deposit transition was observed.
Response
2XX
Delivery endpoint accepted the webhook.