Sign in

v4

OpenAPI 3.1.02026-08-012402353.8 MB

Sandbox: Submit a Check Deposit

Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.

post/simulations/check_deposits/{check_deposit_id}/submit

Path parameters

check_deposit_idstring required

The identifier of the Check Deposit you wish to submit.

Request body

Example request

{}

Response

Check Deposit

account_idstring required

The Account the check was deposited into.

amountinteger required

The deposited amount in USD cents.

back_image_file_idstring nullable required

The ID for the File containing the image of the back of the check.

created_atstring date-time required

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

descriptionstring nullable required

The description of the Check Deposit, for display purposes only.

front_image_file_idstring required

The ID for the File containing the image of the front of the check.

idstring required

The deposit's identifier.

idempotency_keystring nullable required

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.

inbound_mail_item_idstring nullable required

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.

lockbox_recipient_idstring nullable required

If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it.

status'pending' | 'submitted' | 'rejected' | 'returned' required

The status of the Check Deposit.

transaction_idstring nullable required

The ID for the Transaction created by the deposit.

type'check_deposit' required

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

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 1000,
  "back_image_file_id": "file_26khfk98mzfz90a11oqx",
  "created_at": "2020-01-31T23:59:59Z",
  "deposit_acceptance": {
    "account_number": "987654321",
    "amount": 1000,
    "auxiliary_on_us": "101",
    "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
    "currency": "USD",
    "routing_number": "101050001",
    "serial_number": null
  },
  "deposit_adjustments": [],
  "deposit_rejection": null,
  "deposit_return": null,
  "deposit_submission": {
    "back_file_id": "file_frhw4s443nh7noss55kq",
    "front_file_id": "file_j7ed9mrve741m6yui9ju",
    "submitted_at": "2020-02-01T00:59:59+00:00"
  },
  "description": null,
  "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "check_deposit_f06n9gpg7sxn8t19lfc1",
  "idempotency_key": null,
  "inbound_funds_hold": null,
  "inbound_mail_item_id": null,
  "lockbox_recipient_id": null,
  "status": "submitted",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "check_deposit"
}