TransferCheck

List all check transfers

Retrieve all check transfers on your platform.

get/transfers/checks

Request

  • Base URL: https://api.column.com
  • URL: https://api.column.com/transfers/checks
  • Auth: HTTP basic

Query parameters

account_number_idstring

Filter check transfers by account number ID.

bank_account_idstring

Filter check transfers by bank account ID.

created.gtstring date-time

Return results where the created_at field is greater than this value.

created.gtestring date-time

Return results where the created_at field is greater than or equal to this value.

created.ltstring date-time

Return results where the created_at field is less than this value.

created.ltestring date-time

Return results where the created_at field is less than or equal to this value.

ending_beforestring

A cursor for use in pagination. ending_before is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, starting with foo_ZXhhbXBsZQo, your subsequent call can include ending_before=foo_ZXhhbXBsZQo in order to fetch the previous page of the list.

limitinteger

A limit on the number of objects to be returned, between 1 and 100. The default is 10.

lockbox_idstring

Filter check transfers by lockbox ID.

starting_afterstring

A cursor for use in pagination. starting_after is an ID that defines your place in the list. For instance, if you make a list request and receive 20 objects, ending with foo_ZXhhbXBsZQo, your subsequent call can include starting_after=foo_ZXhhbXBsZQo in order to fetch the next page of the list.

statusstring

Filter check transfers by status.

typestring

Filter by check transfer type. Can be debit or credit.

Response

Successful response

has_moreboolean required

Whether there are more results available after this set.

Example response

{
  "transfers": [
    {
      "lockbox_id": "lbox_3VqZkz3FNgKx24u8FQeGMB1L4mU"
    }
  ]
}

Changes

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