Skip to main content
GET
/
deliver
/
booktransfers
/
{id}
Get a book transfer
curl --request GET \
  --url https://api-sandbox.orum.io/deliver/booktransfers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Orum-Version: <orum-version>'
import requests

url = "https://api-sandbox.orum.io/deliver/booktransfers/{id}"

headers = {
"Orum-Version": "<orum-version>",
"Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {
method: 'GET',
headers: {'Orum-Version': '<orum-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api-sandbox.orum.io/deliver/booktransfers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.orum.io/deliver/booktransfers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Orum-Version: <orum-version>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-sandbox.orum.io/deliver/booktransfers/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Orum-Version", "<orum-version>")
req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-sandbox.orum.io/deliver/booktransfers/{id}")
.header("Orum-Version", "<orum-version>")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.orum.io/deliver/booktransfers/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Orum-Version"] = '<orum-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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_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>"
    }
  }
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}
{
"error_code": "<string>",
"message": "<string>",
"details": {}
}

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

Path Parameters

id
string<uuid>
required

Book Transfer ID The unique identifier for the book transfer in UUID format.

Response

successful response.

book_transfer
BookTransfer · object
required