TransferCheckLockbox

Get a check lockbox

Retrieve a single check lockbox by its ID.

get/transfers/checks/lockboxes/{lockbox_id}

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/checks/lockboxes/{lockbox_id}
  • Auth: HTTP basic

Path parameters

lockbox_idstring required

Response

Successful response

account_number_idstring required

ID of the account number linked to the lockbox

bank_account_idstring required

ID of the bank account linked to the lockbox

created_atstring date-time required

ISO 8601 timestamp when the lockbox was created

descriptionstring nullable

Optional description of the lockbox

idstring required

Unique ID for the lockbox

idempotency_keystring required

Idempotency key used to create the lockbox, if provided.

processing_center'CA' | 'NY' | 'TX' required

Processing center assigned to the lockbox.

status'active' | 'closed' | 'pending' required

The current status of the lockbox. Possible values:

  • active: Lockbox is ready to accept checks.
  • closed: Lockbox is deleted, and no more checks will be accepted.
  • pending: Lockbox is still under review, and not ready to accept checks yet.
type'cmra' | 'registered_agent' required

Type of lockbox address.

updated_atstring date-time required

ISO 8601 timestamp when the lockbox was last updated

Example response

{
  "account_number_id": "acno_3VqZl7yJSJXOQp5X4qiPOusL6ga",
  "bank_account_id": "bacc_3VqZl1eEeP2cRXib4BLHfNCoGb7",
  "description": "Operations lockbox",
  "id": "lbox_3VqZkz3FNgKx24u8FQeGMB1L4mU",
  "idempotency_key": "create-lockbox-2026-06-08",
  "processing_center": "TX",
  "status": "active",
  "type": "cmra"
}

Changes

No recorded changes to this operation across all 1 revision of this API.