Skip to main content
GET
Get all book transfers

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

FlowClient Credentials
Token URL
https://api-sandbox.orum.io/oauth/token
Scopes1
read:booktransfers
Read book transfers

Headers

Orum-Version
enum<string>
required

Version of Deliver and Verify APIs. Use v2022-09-21.

Available options:
v2022-09-21

Query Parameters

index
integer
default:0

Index for paginated results

Required range: x >= 0
size
integer
default:100

Max number of results to return

Required range: 0 <= x <= 500
book_transfer_reference_id
string

Filter results by book transfer reference id Unique reference id for the book tranfer

Minimum string length: 1
status
enum<string>

Filter results by book transfer status Describes the current status of the book transfer.

Available options:
created,
completed,
failed
subledger_reference_id
string

Filter results by subledger reference id Unique reference id for the subledger resource. Generated by you.

Required string length: 1 - 255

Response

200 response.

book_transfers
BookTransfer · object[]
required

List of book transfers.