Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

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. Increase automatically deposits a check mailed to a Lockbox Recipient into the recipient's Account. A check mailed to a Lockbox Address must be deposited or ignored with the Action an Inbound Mail Item endpoint.

post/simulations/inbound_mail_items

Request body

amountinteger required

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

contents_file_idstring

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

lockbox_address_idstring

The identifier of the Lockbox Address to simulate inbound mail to. Exactly one lockbox identifier parameter must be provided.

lockbox_recipient_idstring

The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one lockbox identifier parameter must be provided.

Example request

{
  "amount": 1000,
  "lockbox_recipient_id": "lockbox_3xt21ok13q19advds4t5"
}

Response

Inbound Mail Item

created_atstring date-time required

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

file_idstring required

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

idstring required

The Inbound Mail Item identifier.

lockbox_address_idstring required

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

lockbox_recipient_idstring nullable required

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.

recipient_namestring nullable required

The recipient name as written on the mail item.

rejection_reason'no_matching_lockbox' | 'no_check' | 'lockbox_not_active' | 'lockbox_address_not_active' | 'lockbox_recipient_not_active' nullable required

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

status'pending' | 'processed' | 'rejected' required

If the mail item has been processed.

type'inbound_mail_item' required

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

Example response

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