deposits

List Deposits

List deposits for your account.

get/v1/deposits

Query parameters

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

page_tokenstring

The cursor to use for pagination. If not set, the first page of results will be returned.

payment_source_idstring

The unique identifier for the payment sources to filter deposits by. Comma separated list of payment source IDs.

settled_at.afterstring date-time

Return deposits with a settled date and time after the given date and time.

settled_at.beforestring date-time

Return deposits with a settled date and time before the given date and time.

Response

The response for Deposits.list

next_page_tokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Example response

{
  "results": [
    {
      "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-31T00:00:00Z",
          "status": "accepted",
          "company_discretionary_data": "GRANT-2024-001"
        },
        "ach_transfer": {
          "transfer_id": "ach_transfer_01j8rs605a4gctmbm58d87mvsj",
          "amount": 10000,
          "status": "initiated",
          "direction": "credit",
          "standard_entry_class_code": "corporate_credit_or_debit",
          "company_entry_description": "Disbursement to nonprofit",
          "trace_number": "012345678901234",
          "effective_date": "2020-01-31T00:00:00Z",
          "submitted_at": "2020-01-31T23:00:00Z",
          "settled_at": "2020-07-12 15:00:00.000",
          "rejected_at": "2020-07-12 15:00:00.000",
          "returned_at": "2020-07-12 15:00:00.000",
          "created_at": "2020-01-31T23:00:00Z",
          "updated_at": "2020-01-31T23:00:00Z"
        },
        "check_deposit": {
          "auxiliary_on_us": "102",
          "routing_number": "101050001",
          "submitted_at": "2020-01-31T23:00:00Z",
          "status": "deposited"
        },
        "inbound_real_time_payments_transfer": {
          "status": "confirmed",
          "debtor_name": "Charity Good",
          "debtor_routing_number": "1234567890",
          "debtor_account_number": "9876543210",
          "transaction_identification": "20240101ABC123",
          "remittance_information": "Grant payment",
          "confirmed_at": "2020-01-31T23:00:00Z"
        },
        "inbound_wire_transfer": {
          "status": "confirmed",
          "originator_name": "Charity Good",
          "originator_routing_number": "1234567890",
          "originator_account_number": "9876543210",
          "confirmed_at": "2020-01-31T23:00:00Z"
        }
      },
      "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"
    }
  ]
}

Changes

Changed in 6 of the 43 revisions of this API.20441

Sep 2, 20265adde36601ba4See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jun 29, 2026b87f7738d336820See the full diff
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status
  response-media-type-name-specialized
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026c65f43c5ad904See the full diff
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
Jun 25, 2026f89b4f376e9412See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
Jun 25, 202690671617b825124See the full diff
- ▲
  the response's property type changed from number to string for status
  response-property-type-changed
- ▲
  the response's property type changed from number to string for status
  response-property-type-changed
- ▲
  the response's property type changed from number to string for status
  response-property-type-changed
- ▲
  the response's property type changed from number to string for status
  response-property-type-changed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ▲
  removed the required property from the response with the status
  response-required-property-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 4, 2026c80907b865ec1See the full diff
- ○
  added the optional property // to the response with the status
  response-optional-property-added

Full history