Sign in

List Inbound Check Deposits

get/inbound_check_deposits

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

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

account_idstring

Filter Inbound Check Deposits to those belonging to the specified Account.

check_transfer_idstring

Filter Inbound Check Deposits to those belonging to the specified Check Transfer.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

Response

Inbound Check Deposit List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "accepted_at": "2020-01-31T23:59:59Z",
      "account_id": "account_in71c4amph0vgo2qllky",
      "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "adjustments": [],
      "amount": 1000,
      "automatically_resolves_at": "2020-01-31T23:59:59Z",
      "back_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "bank_of_first_deposit_routing_number": "101050001",
      "check_number": "123",
      "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5",
      "created_at": "2020-01-31T23:59:59Z",
      "currency": "USD",
      "declined_at": null,
      "declined_transaction_id": null,
      "deposit_return": null,
      "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
      "payee_name_analysis": "name_matches",
      "status": "accepted",
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "inbound_check_deposit"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

Changed in 1 of the 17 revisions of this API.11

  • df2b1ead4c4911See the full diff
    • ▲

      for the query request parameter limit, default value 100 was added

      request-parameter-default-value-added

    • ○

      added the required property data/items/automatically_resolves_at to the response with the 200 status

      response-required-property-added