POST
/
deliver
/
booktransfers
Create a book transfer
curl --request POST \
  --url https://api-sandbox.orum.io/deliver/booktransfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Orum-Version: <orum-version>' \
  --data '{
  "book_transfer_reference_id": "<string>",
  "amount": 2,
  "currency": "USD",
  "metadata": {},
  "source": {
    "subledger_reference_id": "<string>"
  },
  "destination": {
    "subledger_reference_id": "<string>"
  }
}'
{
  "book_transfer": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "book_transfer_reference_id": "<string>",
    "amount": 2,
    "currency": "USD",
    "status": "created",
    "status_reasons": [
      {
        "source": {
          "reason_code": "insufficient_funds",
          "reason_code_message": "<string>"
        },
        "destination": {
          "reason_code": "insufficient_funds",
          "reason_code_message": "<string>"
        }
      }
    ],
    "metadata": {},
    "source": {
      "subledger_reference_id": "<string>"
    },
    "destination": {
      "subledger_reference_id": "<string>"
    }
  }
}

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 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
object

Information about the ultimate source of the book transfer

​
destination
object

Information about the ultimate destination of the book transfer.

Response

successful response.

​
book_transfer
object
required