API Reference — Increase

{
  "accepted_at": "2020-01-31T23:59:59Z",
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "adjustments": [],
  "amount": 1000,
  "back_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "bank_of_first_deposit_routing_number": "101050001",
  "check_number": "123",
  "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5",
  "created_at": "2020-01-31T23:59:59Z",
  "currency": "USD",
  "declined_at": null,
  "declined_transaction_id": null,
  "deposit_return": null,
  "front_image_file_id": "file_makxrc67oh9l6sg7w9yc",
  "id": "inbound_check_deposit_zoshvqybq0cjjm31mra",
  "payee_name_analysis": "name_matches",
  "status": "accepted",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "inbound_check_deposit"
}

Attributes

accepted_at

string

Nullable

If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.

account_id

string

The Account the check is being deposited against.

account_number_id

string

Nullable

The Account Number the check is being deposited against.

adjustments

array

If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.

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.

bank_of_first_deposit_routing_number

string

Nullable

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.

check_number

string

Nullable

The check number printed on the check being deposited.

check_transfer_id

string

Nullable

If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.

created_at

string

The ISO 8601 date and time at which the deposit was attempted.

currency

enum

The ISO 4217 code for the deposit.

declined_at

string

Nullable

If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.

declined_transaction_id

string

Nullable

If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.

deposit_return

dictionary

Nullable

If you requested a return of this deposit, this will contain details of the return.

front_image_file_id

string

Nullable

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

string

The deposit's identifier.

payee_name_analysis

enum

Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.

status

enum

The status of the Inbound Check Deposit.

transaction_id

string

Nullable

If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.

type

string

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

List Inbound Check Deposits

curl \
  --url "${INCREASE_URL}/inbound_check_deposits" \
  -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 Inbound Check Deposits to those belonging to the specified Account.

check_transfer_id

string

Filter Inbound Check Deposits to those belonging to the specified Check Transfer.

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.

Retrieve an Inbound Check Deposit

curl \
  --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

inbound_check_deposit_id

string

Required

The identifier of the Inbound Check Deposit to get details for.

Decline an Inbound Check Deposit

curl -X "POST" \
  --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra/decline" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

inbound_check_deposit_id

string

Required

The identifier of the Inbound Check Deposit to decline.

Return an Inbound Check Deposit

curl -X "POST" \
  --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra/return" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "reason": "altered_or_fictitious"
  }'

Parameters

inbound_check_deposit_id

string

Required

The identifier of the Inbound Check Deposit to return.

reason

enum

Required

The reason to return the Inbound Check Deposit.

Sandbox: Create an Inbound Check Deposit

Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/inbound_check_deposits" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
    "amount": 1000,
    "check_number": "1234567890"
  }'

Parameters

account_number_id

string

Required

The identifier of the Account Number the Inbound Check Deposit will be against.

amount

integer

Required

The check amount in cents.

check_number

string

Required

The check number on the check to be deposited.

10 character maximum