Object

The deposit object

One deposit received by a standing deposit account.

Fields

idstringrequired

Starts with dep_.

objectstringrequired

deposit_account_idstringrequired

Starts with da_.

transfer_idstringrequired

The on-ramp transfer this deposit created.

Starts with trf_.

statestringrequired

Transfers of every kind share these states. Which states a kind uses, and how it moves between them:

user_to_user: pending → completed; or pending → in_review → completed or failed; pending → canceled only before posting.
conversion: pending → completed, or pending → failed (quote expired, stock or treasury too low). Settles in one ledger transaction, so it is final in the response.
onramp: awaiting_funds → funds_received → completed. Exceptions: in_review (after funds arrive), returned (funds sent back to the sender, final), canceled (from awaiting_funds, final), failed.
offramp: pending → payout_submitted → completed. Exceptions: in_review (before submission), undeliverable and returned (rail rejected the payout; both move on to refunded), refunded (source wallet credited back, final), failed (refused before the wallet was debited, final).

Final states: completed, failed, canceled, returned (on-ramp), refunded. Each change emits transfer.state_changed.

One of pending, awaiting_funds, funds_received, in_review, payout_submitted, completed, failed, canceled, returned, undeliverable, refunded.

amount_receivedstringrequired

Non-negative decimal string. Precision is limited per asset or currency (see Route).

currencystringrequired

Lower-case ISO 4217 fiat currency code.

feesarray of object

ratestring

amount_creditedstring

Non-negative decimal string. Precision is limited per asset or currency (see Route).

rail_referencestring

return_reasonobject | null

Why the deposit was returned to the sender.

return_reason.codestringrequired

return_reason.messagestringrequired

created_attimestamprequired

Example

{
  "id": "dep_01JA8ZK9YT4W9F2D0C7B6A5Z4Y",
  "object": "deposit",
  "deposit_account_id": "da_01JA8ZF5TP0R5B8Z6Y3X2W1V0T",
  "transfer_id": "trf_01JA8ZD7RM8P3Z6X4W1V0T9S8R",
  "state": "completed",
  "amount_received": "100.00",
  "currency": "zar",
  "fees": [],
  "rate": "1",
  "amount_credited": "100.00",
  "rail_reference": "ABSA-20261016-55120",
  "return_reason": null,
  "created_at": "2026-10-16T09:30:00Z"
}