v31

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-215985245.8 KB

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-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"
    }
  ]
}