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>"
}
}
}Get a book transfer
Get a book transfer by id
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>"
}
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Version of Deliver and Verify APIs. Use v2022-09-21.
v2022-09-21 Path Parameters
Book Transfer ID The unique identifier for the book transfer in UUID format.
Response
successful response.
Show child attributes
Show child attributes
Orum generated unique id for the resource.
Timestamp when the resource was created.
Timestamp when the resource was last updated.
Unique reference id for the book tranfer
1Transfer amount in integral cents (example: 100 = $1). Must be greater than zero.
x >= 1Currency code in ISO 4217 format. Only USD is supported.
USD Describes the current status of the book transfer.
created, completed, failed Array that explains why the transfer failed.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.
"insufficient_funds"
A human-readable description of the reason code.
Show child attributes
Show child attributes
A word-based code created by Orum to describe the reason for the failure. Orum reason codes are rail-agnostic.
"insufficient_funds"
A human-readable description of the reason code.
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.
Was this page helpful?