Skip to main content
POST
Create a book transfer

Authorizations

Authorization
string
header
required

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

Headers

Orum-Version
enum<string>
required

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

Available options:
v2022-09-21

Body

application/json
book_transfer_reference_id
string
required

Unique reference id for the transfer group

Minimum string length: 1
amount
integer
required

Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.

Required range: x >= 1
currency
enum<string>
required

Currency code in ISO 4217 format. Only USD is supported.

Available options:
USD
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 and 50 characters for the value. Do not include any sensitive information.

source
Source · object

Information about the ultimate source of the book transfer

destination
Destination · object

Information about the ultimate destination of the book transfer.

Response

successful response.

book_transfer
BookTransfer · object
required