INincrease

List Checkbook Checks

Changed on
get/checkbook_checks

Request

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.

checkbook_idstring

Filter Checkbook Checks to those belonging to the specified Checkbook.

account_number_idstring

Filter Checkbook Checks to those drawn on the specified Account Number.

check_numberinteger

Filter Checkbook Checks to the one with the specified check number.

Response

Checkbook Check 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": [
    {
      "check_number": 1,
      "checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "checkbook_check_klgh3z50guf6jcnfhibb",
      "status": "pending_deposit",
      "type": "checkbook_check"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes