Private API Reference

Physical Checks

Physical Checks are checks that Increase prints and mails on your behalf. They are for printing only, and meant to be used for mailing checks not associated with an Increase account.

Events

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

The Physical Check object

{
  "amount": 1000,
  "attachment_file_id": null,
  "check_number": "10002394",
  "check_voucher_image_file_id": null,
  "created_at": "2020-01-31T23:59:59Z",
  "id": "physical_check_i56pprjux9awuqti5zay",
  "idempotency_key": null,
  "mailing": null,
  "mailing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "name": "Ian Crease",
    "phone": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "memo": "Invoice 29582",
  "note": null,
  "pay_to_the_order_of": "Ian Crease",
  "payer": [
    {
      "line": "National Phonograph Company"
    },
    {
      "line": "33 Liberty Street"
    },
    {
      "line": "New York, NY 10045"
    }
  ],
  "return_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "name": "National Phonograph Company",
    "phone": null,
    "postal_code": "10045",
    "state": "NY"
  },
  "shipping_method": "usps_first_class",
  "signature": {
    "image_file_id": null,
    "text": "No signature required"
  },
  "source_account_number": "987654321",
  "source_routing_number": "101050001",
  "status": "pending_mailing",
  "submission": null,
  "tracking_updates": [],
  "type": "physical_check",
  "valid_until_date": null
}

Attributes

amount

integer

The check amount in USD cents.

attachment_file_id

string

Nullable

The ID of the file for the check attachment.

More about Files.

check_number

string

The check number printed on the check.

check_voucher_image_file_id

string

Nullable

The ID of the file for the check voucher image.

More about Files.

created_at

string

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

string

The Physical Check’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

dictionary

Nullable

If the check has been mailed, this will contain details of the shipment.

mailing_address

dictionary

The mailing address for the check.

memo

string

Nullable

The descriptor printed on the memo field of the check.

note

string

Nullable

The note printed on the trifold centered sheet with the check.

pay_to_the_order_of

string

The name printed on the check in the “Pay To The Order Of” line.

payer

array

The payer information printed on the check.

return_address

dictionary

The return address printed on the check.

shipping_method

enum

The shipping method for the check.

signature

dictionary

The signature that will appear on the check.

source_account_number

string

The account number printed on the check.

source_routing_number

string

The routing number printed on the check.

status

enum

The lifecycle status of the Physical Check.

submission

dictionary

Nullable

After the check is submitted to our check printer, this will contain supplemental details.

tracking_updates

array

Tracking updates relating to the check’s delivery.

type

string

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

valid_until_date

string

Nullable

The date until which the check is valid.

List Physical Checks

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

Returns a list response :

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

Parameters

status.in

array of strings

Filter Physical Checks 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

cursor

string

limit

integer

Create a Physical Check

curl -X "POST" \
  --url "${INCREASE_URL}/physical_checks" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 1000,
    "check_number": "10002394",
    "mailing_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "name": "Ian Crease",
      "postal_code": "10045",
      "state": "NY"
    },
    "memo": "Invoice 29582",
    "pay_to_the_order_of": "Ian Crease",
    "payer": [
      {
        "line": "National Phonograph Company"
      },
      {
        "line": "33 Liberty Street"
      },
      {
        "line": "New York, NY 10045"
      }
    ],
    "return_address": {
      "city": "New York",
      "line1": "33 Liberty Street",
      "name": "National Phonograph Company",
      "postal_code": "10045",
      "state": "NY"
    },
    "source_account_number": "987654321",
    "source_routing_number": "101050001"
  }'

Parameters

amount

integer

Required

The check amount in USD cents.

attachment_file_id

string

The ID of a File to be attached to the check. This must have purpose: check_attachment.

More about Files.

check_number

string

Required

The check number to print on the check. This should not contain leading zeroes.

Between 1 and 10 characters,

check_voucher_image_file_id

string

The ID of a File to be used as the check voucher image. This must have purpose: check_voucher_image.

More about Files.

mailing_address

dictionary

Required

Details for where the check will be mailed.

memo

string

Required

The descriptor that will be printed on the memo field on the check.

Between 1 and 100 characters,

note

string

The descriptor that will be printed on the letter included with the check.

Between 1 and 1200 characters,

pay_to_the_order_of

string

Required

The name that will be printed on the check in the ‘Pay To The Order Of’ line.

Between 1 and 35 characters,

payer

array

Required

The payer of the check. This will be printed on the top-left portion of the check.

program_id

string

The identifier of the Program to create this Physical Check for. If omitted, defaults to the first Program in the group.

More about Programs.

return_address

dictionary

Required

The return address to be printed on the check.

shipping_method

enum

How to ship the check. Defaults to USPS First Class.

signature

dictionary

The signature that will appear on the check. If not provided, the check will be printed with ‘No Signature Required’. At most one of text and image_file_id may be provided.

source_account_number

string

Required

The account number to print on the check.

Between 1 and 17 characters

source_routing_number

string

Required

The routing number to print on the check.

Exactly 9 characters,

valid_until_date

string

If provided, the check will be valid on or before this date.

Retrieve a Physical Check

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

Parameters

physical_check_id

string

Required

The identifier of the Physical Check.