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>'
{
  "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>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.orum.io/llms.txt

Use this file to discover all available pages before exploring further.

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