List Deposits | Chariot

curl -G https://api.givechariot.com/v1/deposits \
     -H "Authorization: Bearer <token>" \
     -d payment_source_id=payment_source_01j8rs605a4gctmbm58d87mvsj \
     -d source_id=source_01m12tn300eh20gdqscje7s5jw

{
  "results": [
    {
      "id": "deposit_01j8rs605a4gctmbm58d87mvsj",
      "status": "complete",
      "transfer": {
        "amount": 10000,
        "currency": "USD",
        "financial_account_id": "fa_01j8rs605a4gctmbm58d87mvsj",
        "description": "Disbursement to nonprofit",
        "bank_created_at": "2020-01-31T23:59:59Z",
        "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",
          "created_at": "2020-01-31T23:00:00Z",
          "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",
          "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"
        }
      },
      "created_at": "2020-01-31T23:59:59Z",
      "updated_at": "2020-01-31T23:59:59Z",
      "source_id": "source_01m12tn300eh20gdqscje7s5jw",
      "deposit_address_id": "deposit_address_01m12tn300eh20gdqscje7s5jw",
      "settled_at": "2020-01-31T23:59:59Z",
      "returned_at": "2020-01-31T23:59:59Z",
      "properties": [
        {
          "property_id": "prop_01j8rs605a4gctmbm58d87mvsj",
          "value": {
            "type": "text",
            "text_value": "string",
            "enum_value_id": "string",
            "user_value_id": "string",
            "boolean_value": true,
            "date_value": "2024-01-15T09:30:00Z",
            "empty": true
          }
        }
      ],
      "payment_source_id": "payment_source_01kew60ks7w0epkvp2bgqxrt8z",
      "bank_created_at": "2020-01-31T23:59:59Z"
    }
  ],
  "next_page_token": "string"
}

List deposits for your account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

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

page_tokenstringOptional

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

source_idstringOptional

The identifier of the source that sent the deposits. Comma-separated list of source IDs.

payment_source_idstringOptionalDeprecated

Deprecated. Use source_id. Comma-separated list of payment source IDs.

statusenumOptional

Filter deposits by status.

Allowed values:

settled_at.afterdatetimeOptional

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

settled_at.beforedatetimeOptional

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

Response headers

X-Request-IdstringOptional

The unique identifier for the request

Response

The response for Deposits.list

resultslist of objectsOptional

next_page_tokenstringOptional

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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error