v39

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-017897360.9 KB

deposits

Get a Deposit

Get a deposit by its unique identifier.

get/v1/deposits/{id}

Path parameters

idstring required

The unique identifier for the deposit

Response

The deposit was retrieved

idstring required

The unique identifier for this object.

payment_source_idstring required

The unique identifier for the payment source that contains the money for the deposit.

settled_atstring date-time

The date and time when the deposit was settled.

returned_atstring date-time

The date and time when the deposit was returned.

status'pending' | 'complete' | 'failed' required

The status of the deposit.

created_atstring date-time required

The date and time when the deposit was created.

updated_atstring date-time required

The date and time when the deposit was last updated.

bank_created_atstring date-time

The date and time when the bank created the deposit.

Example response

{
  "id": "deposit_01j8rs605a4gctmbm58d87mvsj",
  "payment_source_id": "payment_source_01j8rs605a4gctmbm58d87mvsj",
  "settled_at": "2020-01-31T23:59:59Z",
  "returned_at": "2020-01-31T23:59:59Z",
  "status": "complete",
  "transfer": {
    "amount": 10000,
    "currency": "USD",
    "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
    "description": "Disbursement to nonprofit",
    "inbound_account_transfer": {
      "created_at": "2020-01-31T23:00:00Z"
    },
    "inbound_ach_transfer": {
      "standard_entry_class_code": "WEB",
      "company_entry_description": "GRANTPMT",
      "originator_routing_number": "1234567890",
      "originator_company_name": "Charity Good",
      "trace_number": "1234567890",
      "effective_date": "2020-01-31T23:00:00Z",
      "status": "accepted"
    },
    "check_deposit": {
      "auxiliary_on_us": "102",
      "routing_number": "101050001",
      "submitted_at": "2020-01-31T23:00:00Z",
      "status": "deposited"
    }
  },
  "properties": [
    {
      "property_id": "prop_01j8rs605a4gctmbm58d87mvsj",
      "value": {
        "type": "text"
      }
    }
  ],
  "created_at": "2020-01-31T23:59:59Z",
  "updated_at": "2020-01-31T23:59:59Z",
  "bank_created_at": "2020-01-31T23:59:59Z"
}