Private API Reference

Checkbook Checks

A Checkbook Check is a single check within a Checkbook.

The Checkbook Check object

{
  "check_number": 1,
  "checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "checkbook_check_klgh3z50guf6jcnfhibb",
  "status": "pending_deposit",
  "type": "checkbook_check"
}

Attributes

check_number

integer

The check number printed on the check.

checkbook_id

string

The identifier of the Checkbook the check belongs to.

More about Checkbooks.

created_at

string

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

string

The Checkbook Check’s identifier.

status

enum

The status of the Checkbook Check.

type

string

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

List Checkbook Checks

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

Returns a list response :

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

Parameters

checkbook_id

string

Filter Checkbook Checks to those belonging to the specified Checkbook.

account_number_id

string

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

More about Account Numbers.

check_number

integer

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

More parameters

Retrieve a Checkbook Check

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

Parameters

checkbook_check_id

string

Required

The identifier of the Checkbook Check.

Stop a Checkbook Check

Stop a Checkbook Check. A stopped check cannot be deposited.

curl -X "POST" \
  --url "${INCREASE_URL}/checkbook_checks/checkbook_check_klgh3z50guf6jcnfhibb/stop" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

checkbook_check_id

string

Required

The identifier of the Checkbook Check to stop.