INincrease

List Checkbooks

Changed on
get/checkbooks

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.

account_number_idstring

Filter Checkbooks to those attached to the specified Account Number.

status.instring[]

Filter Checkbooks for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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

Checkbook 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_number_id": "account_number_v18nkfqm6afpsrvy82b2",
      "created_at": "2020-01-31T23:59:59Z",
      "id": "checkbook_7iudxhxum6vlkcjxmi8y",
      "idempotency_key": null,
      "mailing_address": {
        "city": "New York",
        "line1": "33 Liberty Street",
        "line2": null,
        "name": "Ian Crease",
        "postal_code": "10045",
        "state": "NY"
      },
      "payer": [
        {
          "contents": "National Phonograph Company"
        },
        {
          "contents": "33 Liberty Street"
        },
        {
          "contents": "New York, NY 10045"
        }
      ],
      "return_address": {
        "city": "San Francisco",
        "line1": "244 Kearny St",
        "line2": "Floor 8",
        "name": "Undeliverable Mail",
        "postal_code": "94108",
        "state": "CA"
      },
      "status": "mailed",
      "style": "three_ring_binder",
      "tracking_updates": [
        {
          "category": "in_transit",
          "country": "US",
          "created_at": "2020-01-31T23:59:59Z",
          "postal_code": "10045"
        },
        {
          "category": "delivered",
          "country": "US",
          "created_at": "2020-01-31T23:59:59Z",
          "postal_code": "10045"
        }
      ],
      "type": "checkbook"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes