v4

OpenAPI 3.1.02026-08-012402353.8 MB

List Check Deposits

get/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 Check Deposits to those belonging to the specified Account.

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.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

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": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "amount": 1000,
      "back_image_file_id": "file_26khfk98mzfz90a11oqx",
      "created_at": "2020-01-31T23:59:59Z",
      "deposit_acceptance": {
        "account_number": "987654321",
        "amount": 1000,
        "auxiliary_on_us": "101",
        "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
        "currency": "USD",
        "routing_number": "101050001",
        "serial_number": null
      },
      "deposit_adjustments": [],
      "deposit_rejection": null,
      "deposit_return": null,
      "deposit_submission": {
        "back_file_id": "file_frhw4s443nh7noss55kq",
        "front_file_id": "file_j7ed9mrve741m6yui9ju",
        "submitted_at": "2020-02-01T00:59:59+00:00"
      },
      "description": null,
      "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
      "id": "check_deposit_f06n9gpg7sxn8t19lfc1",
      "idempotency_key": null,
      "inbound_funds_hold": null,
      "inbound_mail_item_id": null,
      "lockbox_recipient_id": null,
      "status": "submitted",
      "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
      "type": "check_deposit"
    }
  ],
  "next_cursor": "v57w5d"
}