Sign in

Update a Lockbox

patch/lockboxes/{lockbox_id}

Path parameters

lockbox_idstring required

The identifier of the Lockbox.

Request body

check_deposit_behavior'enabled' | 'disabled' | 'pend_for_processing'

This indicates if checks mailed to this lockbox will be deposited.

descriptionstring

The description you choose for the Lockbox.

recipient_namestring

The recipient name you choose for the Lockbox.

Example request

{
  "check_deposit_behavior": "disabled"
}

Response

Lockbox

account_idstring required

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

check_deposit_behavior'enabled' | 'disabled' | 'pend_for_processing' required

Indicates if checks mailed to this lockbox will be deposited.

created_atstring date-time required

The ISO 8601 time at which the Lockbox was created.

descriptionstring nullable required

The description you choose for the Lockbox.

idstring required

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

recipient_namestring nullable required

The recipient name you choose for the Lockbox.

type'lockbox' required

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

Example response

{
  "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"
  },
  "check_deposit_behavior": "enabled",
  "created_at": "2020-01-31T23:59:59Z",
  "description": "Lockbox 1",
  "id": "lockbox_3xt21ok13q19advds4t5",
  "idempotency_key": null,
  "recipient_name": "Company Inc.",
  "type": "lockbox"
}

Changes