Private API Reference

Checkbooks

Checkbooks are sets of blank checks that Increase prints and mails on your behalf.

Events

Your application can listen to webhooks about this resource. The events about Checkbooks will have the categories "checkbook.created" or "checkbook.updated" .

The Checkbook object

{
  "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",
  "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"
}

Attributes

account_number_id

string

The identifier of the Account Number the Checkbook is attached to.

More about Account Numbers.

created_at

string

The ISO 8601 date and time at which the Checkbook was created.

string

The Checkbook’s identifier.

idempotency_key

string

Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

mailing_address

dictionary

The destination address that the Checkbook will be mailed to.

payer

array

The payer information printed on the top-left corner of each check.

return_address

dictionary

The address where the Checkbook will return to if there is a delivery issue.

status

enum

The lifecycle status of the Checkbook.

tracking_updates

array

Tracking updates relating to the Checkbook’s delivery.

type

string

A constant representing the object’s type. For this resource it will always be checkbook.

List Checkbooks

curl \
  --url "${INCREASE_URL}/checkbooks" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Checkbook object */ },
    { /* Checkbook object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_number_id

string

Filter Checkbooks to those attached to the specified Account Number.

More about Account Numbers.

status.in

array of strings

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_key

string

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.

Between 1 and 200 characters

More parameters

Create a Checkbook

curl -X "POST" \
  --url "${INCREASE_URL}/checkbooks" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "mailing_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "name": "Ian Crease",
      "postal_code": "10045",
      "state": "NY"
    },
    "payer": [
      {
        "contents": "National Phonograph Company"
      },
      {
        "contents": "33 Liberty Street"
      },
      {
        "contents": "New York, NY 10045"
      }
    ]
  }'

Parameters

account_number_id

string

Required

The identifier of the Account Number that the checks will draw from. The Account Number must be active and have inbound_check_status set to allowed.

More about Account Numbers.

mailing_address

dictionary

Required

The destination address that the Checkbook will be mailed to.

payer

array

Required

The payer of the checks. This will be printed on the top-left corner of each check. This should be an array of up to 4 elements, each of which represents a line of the payer.

Retrieve a Checkbook

curl \
  --url "${INCREASE_URL}/checkbooks/checkbook_7iudxhxum6vlkcjxmi8y" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

checkbook_id

string

Required

The identifier of the Checkbook.

Sandbox: Mail a Checkbook

Simulates the mailing of a Checkbook, which happens periodically throughout the day in production but can be sped up in sandbox. This Checkbook must have a status of pending_submission or pending_mailing.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/checkbooks/checkbook_7iudxhxum6vlkcjxmi8y/mail" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

checkbook_id

string

Required

The identifier of the Checkbook you wish to mail.