{
"type": "funds.deposit_returned",
"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"
},
"reason": "account_details_mismatch"
}Funds deposit returned
A deposit was returned to its source.
{
"type": "funds.deposit_returned",
"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"
},
"reason": "account_details_mismatch"
}Authorizations
Your public API key. Identifies the partner making the request.
HMAC signature over the request, computed with your private key.
Monotonically increasing nonce included in the request signature.
Body
Payload shared by deposit lifecycle events. Amount and fee availability follows the source data and is not tied to the lifecycle event type.
Public deposit transaction id.
Public id of the user whose deposit changed.
Public account id associated with the deposit.
Event type discriminator.
funds.deposit_returned Partner-safe reason why the deposit was returned.
account_details_mismatch, limit_exceeded, duplicate, account_restricted, other Total deposit amount, inclusive of the fee. Present when PWS can resolve both the source value and its asset.
Show child attributes
Show child attributes
Fee charged for the deposit. Present only when the source provides both the fee value and its asset and PWS can resolve the asset. An explicitly provided zero fee is included; PWS does not infer a missing fee or its asset.
Show child attributes
Show child attributes
RFC3339 UTC time the transition was observed. Omitted when unavailable.
Response
Return any 2xx status to acknowledge receipt.