Auth API
- How to authenticate
Deliver API
- Persons
- Businesses
- External Accounts
- Cards
- Transfers
- Schedules
- Eligibility
- Transfer Groups
- Balance
- Reports
- Subledgers
- Book Transfers
Verify API
Webhooks API
- Overview And Set Up
- Event Types and Payloads
- Configure webhooks
- Trigger webhooks
- Secure webhooks
Book Transfers
Create a book transfer
Create a book transfer
POST
/
deliver
/
booktransfers
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,
"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,
"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 API. Use v2022-09-21.
Available options:
v2022-09-21
Body
application/json
Response
200
application/json
successful response.
The response is of type object
.
Was this page helpful?
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,
"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,
"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>"
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.