increase-test
POST/simulations/inbound_mail_items

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.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields
amountintegerrequired
The amount of the check to be simulated, in cents.
contents_file_idstringoptional
The file containing the PDF contents. If not present, a default check image file will be used.
lockbox_address_idstringoptional
The identifier of the Lockbox Address to simulate inbound mail to. Exactly one lockbox identifier parameter must be provided.
lockbox_recipient_idstringoptional
The identifier of the Lockbox Recipient to simulate inbound mail to. Exactly one lockbox identifier parameter must be provided.

3 status codes
200Inbound Mail Item
account_idstringrequired
The identifier for the Account that checks in this mail item are deposited into. For mail items that could not be routed to a Lockbox Recipient, this will be null.
checksarray<InboundMailItemCheck>required
The checks in the mail item.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created.
file_idstringrequired
The identifier for the File containing the scanned contents of the mail item.
idstringrequired
The Inbound Mail Item identifier.
lockbox_address_idstringrequired
The identifier for the Lockbox Address that received this mail item.
lockbox_recipient_idstringrequired
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_namestringrequired
The recipient name as written on the mail item.
rejection_reasonstringrequired
If the mail item has been rejected, why it was rejected.
Allowed:no_matching_lockboxno_checklockbox_not_activelockbox_address_not_activelockbox_recipient_not_active
statusstringrequired
If the mail item has been processed.
Allowed:pendingprocessedrejected
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_mail_item`.
Allowed:inbound_mail_item
4XXError
5XXError