How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Orum Book Transfers API

The Book Transfers API from Orum — 2 operation(s) for book transfers.

Orum Book Transfers API is one of 17 APIs that Orum publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Book Transfers. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 2 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version v2022-09-21.

Requests are made against 2 base URLs: https://api-sandbox.orum.io, https://vault.api-sandbox.orum.io.

3 operations 2 paths 20 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2022-09-21
Base URL
https://api.orum.io
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

Orum Book Transfers API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 29 scopes.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Book Transfers 3
POST
/deliver/booktransfers
Create a book transfer
post-book-transfer 1 param body → 200400404default
GET
/deliver/booktransfers
Get all book transfers
get-book-transfers 6 params → 200400default
GET
/deliver/booktransfers/{id}
Get a book transfer
get-book-transfer 2 params → 200400404default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are BookTransfer (11 properties), BookTransferRequest (6 properties), ErrorResponse (3 properties), BookTransferStatusReason (2 properties). Each schema is shown below with its type and property counts.

BookTransferDestinationObject
object
Information about the ultimate destination of the book transfer.
1 property 1 required
CreatedAt
string
Timestamp when the resource was created.
BookTransferReferenceId
string
Unique reference id for the book tranfer
UpdatedAt
string
Timestamp when the resource was last updated.
BookTransfersResponse
object
1 property 1 required
Currency
string
Currency code in ISO 4217 format. Only USD is supported.
BookTransferStatus
string
Describes the current status of the book transfer.
TransferAmount
integer
Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
BookTransferReasonCode
object
2 properties 2 required
BookTransfer
object
11 properties 7 required
BookTransferSourceObject
object
Information about the ultimate source of the book transfer
1 property 1 required
OrumVersion
string
Version of Deliver and Verify APIs. Use v2022-09-21.
Metadata
object
Additional data you would like to provide on the resource. The field supports valid JSON of up to 5 key-value pairs with a maximum of 20 characters for the key…
TransferGroupReferenceID
string
Unique reference id for the transfer group
BookTransferResponse
object
1 property 1 required
OrumId
string
Orum generated unique id for the resource.
SubledgerReferenceId
string
Unique reference id for the subledger resource. Generated by you.
BookTransferStatusReason
object
For failed book transfers - details on why the book transfer is in a failed state.
2 properties
BookTransferRequest
object
6 properties 3 required
ErrorResponse
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

orum-book-transfers-api-openapi.yml Raw ↑

Other APIs Orum publishes across the network.

Orum Authentication API
Orum Balance API
Orum Businesses API
Orum Cards API
Orum Configure webhooks API
Orum Eligibility API
Orum External Accounts API
Orum Persons API
Orum Reports API
Orum Schedules API
Orum Secure webhooks API
Orum Subledgers API
Where this information came from

This is an independent, third-party profile of Orum Book Transfers API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.