Sign in

List Lockboxes

get/lockboxes

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Lockboxes to those associated with the provided Account.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

idempotency_keystring

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.

Response

Lockbox List

next_cursorstring nullable required

A pointer to a place in the list.

Example response

{
  "data": [
    {
      "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"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes