API Reference — Increase

{
  "checks": [
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc"
    },
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc"
    }
  ],
  "created_at": "2020-01-31T23:59:59Z",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "inbound_mail_item_q6rrg7mmqpplx80zceev",
  "lockbox_id": "lockbox_3xt21ok13q19advds4t5",
  "recipient_name": "Ian Crease",
  "rejection_reason": null,
  "status": "processed",
  "type": "inbound_mail_item"
}

Attributes

checks

array

The checks in the mail item.

created_at

string

The ISO 8601 time at which the Inbound Mail Item was created.

file_id

string

The identifier for the File containing the scanned contents of the mail item.

string

The Inbound Mail Item identifier.

lockbox_id

string

Nullable

The identifier for the Lockbox that received this mail item. For mail items that could not be processed due to an invalid address, this will be null.

recipient_name

string

Nullable

The recipient name as written on the mail item.

rejection_reason

enum

Nullable

If the mail item has been rejected, why it was rejected.

status

enum

If the mail item has been processed.

type

string

A constant representing the object's type. For this resource it will always be inbound_mail_item.

List Inbound Mail Items

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

Parameters

cursor

string

Return the page of entries after this one.

limit

integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

lockbox_id

string

Filter Inbound Mail Items to ones sent to the provided Lockbox.

created_at.after

string

Return results after this ISO 8601 timestamp.

created_at.before

string

Return results before this ISO 8601 timestamp.

created_at.on_or_after

string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before

string

Return results on or before this ISO 8601 timestamp.

Retrieve an Inbound Mail Item

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

Parameters

inbound_mail_item_id

string

Required

The identifier of the Inbound Mail Item to retrieve.

Sandbox: Create an Inbound Mail Item

Simulates an inbound mail item to your account, as if someone had mailed a physical check to one of your account's Lockboxes.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_mail_items" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "amount": 1000,
    "lockbox_id": "lockbox_3xt21ok13q19advds4t5"
  }'

Parameters

amount

integer

Required

The amount of the check to be simulated, in cents.

contents_file_id

string

The file containing the PDF contents. If not present, a default check image file will be used.

lockbox_id

string

Required

The identifier of the Lockbox to simulate inbound mail to.