TransferBook

List all book transfers

Retrieve all book transfers under your developer account. Filtered results can be retrieved with extra parameters in the query (sender_bank_account_id, receiver_bank_account_id, etc.).

get/transfers/book

Request

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

Query parameters

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.

receiver_bank_account_idstring

Filter book transfers by receiver bank account ID.

sender_bank_account_idstring

Filter book transfers by sender bank account 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 book transfers by status.

Response

Successful response

has_moreboolean required

Whether more book transfers are available

Changes

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