The Deposit Object

Full schema for the Deposit resource.

idstringRequiredRead-only

The unique identifier for the deposit.

statusenumRequired

The status of the deposit.

Allowed values:

transferobjectRequired

The transfer that carried the funds.

created_atdatetimeRequiredRead-only

The date and time when the deposit was created.

updated_atdatetimeRequiredRead-only

The date and time when the deposit was last updated.

source_idstringOptional

The identifier of the Source that sent this deposit.

deposit_address_idstring or nullOptionalRead-only

The identifier of the Deposit Address that received the funds. Null when the funds didn't arrive through a deposit address, such as a mailed check.

settled_atdatetimeOptionalRead-only

The date and time when the deposit was settled.

returned_atdatetimeOptionalRead-only

The date and time when the deposit was returned.

propertieslist of objectsOptional

A list of properties assigned to the deposit.

payment_source_idstringOptionalDeprecated

Deprecated. Use source_id.

bank_created_atdatetimeOptionalRead-onlyDeprecated

Deprecated. Use transfer.bank_created_at.

Response

{
  "id": "deposit_01j8rs605a4gctmbm58d87mvsj",
  "status": "complete",
  "transfer": {
    "amount": 25000,
    "currency": "USD",
    "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
    "description": "FIDELITY CHARITABLE GRANT",
    "bank_created_at": "2026-09-25T14:00:00Z",
    "inbound_ach_transfer": {
      "standard_entry_class_code": "CCD",
      "company_entry_description": "GRANTPMT",
      "originator_routing_number": "021000021",
      "originator_company_name": "Fidelity Charitable",
      "trace_number": "021000021234567",
      "effective_date": "2026-09-25T00:00:00Z",
      "status": "accepted",
      "company_discretionary_data": "GRANT-2026-001"
    }
  },
  "created_at": "2026-09-25T14:00:00Z",
  "updated_at": "2026-09-25T18:00:00Z",
  "source_id": "source_01m12tn300eh20gdqscje7s5jw",
  "deposit_address_id": "deposit_address_01m12tn300eh20gdqscje7s5jw",
  "settled_at": "2026-09-25T18:00:00Z",
  "properties": []
}