API Reference — Increase

Lockboxes are physical locations that can receive mail containing paper checks. Increase will automatically create a Check Deposit for checks received this way.

The Lockbox object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "address": {
    "city": "San Francisco",
    "line1": "1234 Market St",
    "line2": "Ste 567",
    "postal_code": "94114",
    "recipient": "Company Inc. ATTN: VRE6P",
    "state": "CA"
  },
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Lockbox 1",
  "id": "lockbox_3xt21ok13q19advds4t5",
  "idempotency_key": null,
  "recipient_name": "Company Inc.",
  "status": "active",
  "type": "lockbox"
}

Attributes

account_id

string

The identifier for the Account checks sent to this lockbox will be deposited into.

More about Accounts.

address

dictionary

The mailing address for the Lockbox.

created_at

string

The ISO 8601 time at which the Lockbox was created.

description

string

Nullable

The description you choose for the Lockbox.

string

The Lockbox 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.

recipient_name

string

Nullable

The recipient name you choose for the Lockbox.

status

enum

This indicates if mail can be sent to this address.

type

string

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

List Lockboxes

curl \
  --url "${INCREASE_URL}/lockboxes" \
  -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 Lockboxes to those associated with the provided Account.

More about Accounts.

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 Lockbox

curl -X "POST" \
  --url "${INCREASE_URL}/lockboxes" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "description": "Rent payments"
  }'

Parameters

account_id

string

Required

The Account checks sent to this Lockbox should be deposited into.

More about Accounts.

description

string

The description you choose for the Lockbox, for display purposes.

200 character maximum

recipient_name

string

The name of the recipient that will receive mail at this location.

200 character maximum

Retrieve a Lockbox

curl \
  --url "${INCREASE_URL}/lockboxes/lockbox_3xt21ok13q19advds4t5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

lockbox_id

string

Required

The identifier of the Lockbox to retrieve.

More about Lockboxes.

Update a Lockbox

curl -X "PATCH" \
  --url "${INCREASE_URL}/lockboxes/lockbox_3xt21ok13q19advds4t5" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "status": "inactive"
  }'

Parameters

lockbox_id

string

Required

The identifier of the Lockbox.

More about Lockboxes.

description

string

The description you choose for the Lockbox.

200 character maximum

recipient_name

string

The recipient name you choose for the Lockbox.

200 character maximum

status

enum

This indicates if checks can be sent to the Lockbox.