Inbound Mail Items

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address.

Events

Your application can listen to webhooks about this resource. The events about Inbound Mail Items will have the categories "inbound_mail_item.created" or "inbound_mail_item.updated" .

The Inbound Mail Item object

{
  "checks": [
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc",
      "status": "deposited"
    },
    {
      "amount": 1750,
      "back_file_id": "file_makxrc67oh9l6sg7w9yc",
      "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
      "front_file_id": "file_makxrc67oh9l6sg7w9yc",
      "status": "deposited"
    }
  ],
  "created_at": "2020-01-31T23:59:59Z",
  "file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "inbound_mail_item_q6rrg7mmqpplx80zceev",
  "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
  "lockbox_recipient_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.

More about Files.

string

The Inbound Mail Item identifier.

lockbox_address_id

string

The identifier for the Lockbox Address that received this mail item.

More about Lockbox Addresses.

lockbox_recipient_id

string

Nullable

The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null.

More about Lockbox Recipients.

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

Returns a list response :

{
  "data": [
    { /* Inbound Mail Item object */ },
    { /* Inbound Mail Item object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

lockbox_recipient_id

string

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

More about Lockbox Recipients.

lockbox_address_id

string

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

More about Lockbox Addresses.

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

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.

More about Inbound Mail Items.

Action an Inbound Mail Item

curl -X "POST" \
  --url "${INCREASE_URL}/inbound_mail_items/inbound_mail_item_q6rrg7mmqpplx80zceev/action" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "checks": [
      {
        "account_id": "account_in71c4amph0vgo2qllky",
        "action": "deposit"
      },
      {
        "action": "ignore"
      }
    ]
  }'

Parameters

inbound_mail_item_id

string

Required

The identifier of the Inbound Mail Item to action.

More about Inbound Mail Items.

checks

array

Required

The actions to perform on the Inbound Mail Item.

Sandbox: Create an Inbound Mail Item

Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox Recipients, as if someone had mailed a physical check.

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_recipient_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.

More about Files.

lockbox_address_id

string

The identifier of the Lockbox Address to simulate inbound mail to.

More about Lockbox Addresses.

lockbox_recipient_id

string

The identifier of the Lockbox Recipient to simulate inbound mail to.

More about Lockbox Recipients.