API Reference — Increase

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 1000,
  "back_image_file_id": null,
  "created_at": "2020-01-31T23:59:59Z",
  "deposit_acceptance": null,
  "deposit_rejection": null,
  "deposit_return": null,
  "deposit_submission": null,
  "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_id": null,
  "status": "submitted",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "check_deposit"
}

Attributes

account_id

string

The Account the check was deposited into.

amount

integer

The deposited amount in USD cents.

back_image_file_id

string

Nullable

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

created_at

string

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

deposit_acceptance

dictionary

Nullable

If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.

deposit_rejection

dictionary

Nullable

If your deposit is rejected by Increase, this will contain details as to why it was rejected.

deposit_return

dictionary

Nullable

If your deposit is returned, this will contain details as to why it was returned.

deposit_submission

dictionary

Nullable

After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.

description

string

Nullable

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

front_image_file_id

string

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

string

The deposit's identifier.

idempotency_key

string

Nullable

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_funds_hold

dictionary

Nullable

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

inbound_mail_item_id

string

Nullable

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

lockbox_id

string

Nullable

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

status

enum

The status of the Check Deposit.

transaction_id

string

Nullable

The ID for the Transaction created by the deposit.

type

string

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

List Check Deposits

curl \
  --url "${INCREASE_URL}/check_deposits?account_id=account_in71c4amph0vgo2qllky" \
  -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.

account_id

string

Filter Check Deposits to those belonging to the specified Account.

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.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum

Create a Check Deposit

curl -X "POST" \
  --url "${INCREASE_URL}/check_deposits" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "amount": 1000,
    "back_image_file_id": "file_26khfk98mzfz90a11oqx",
    "description": "Vendor payment",
    "front_image_file_id": "file_hkv175ovmc2tb2v2zbrm"
  }'

Parameters

account_id

string

Required

The identifier for the Account to deposit the check in.

amount

integer

Required

The deposit amount in USD cents.

back_image_file_id

string

Required

The File containing the check's back image.

description

string

The description you choose to give the Check Deposit, for display purposes only.

200 character maximum

front_image_file_id

string

Required

The File containing the check's front image.

Retrieve a Check Deposit

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

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit to retrieve.

Sandbox: Reject a Check Deposit

Simulates the rejection of a Check Deposit by Increase due to factors like poor image quality. This Check Deposit must first have a status of pending.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/reject" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to reject.

Sandbox: Return a Check Deposit

Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/return" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to return.

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.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/submit" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

check_deposit_id

string

Required

The identifier of the Check Deposit you wish to submit.