Skip to main content
POST
/
v1
/
ledgers
/
{id}
/
transfer
Transfer between ledgers
curl --request POST \
  --url https://api.example.com/v1/ledgers/{id}/transfer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination_ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 2,
  "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "metadata": {}
}
'
{
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source_entry": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "description": "<string>",
    "balance": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "destination_entry": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "description": "<string>",
    "balance": 123,
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "timestamp": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.corebanq.com/llms.txt

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

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Source ledger UUID

Body

application/json
​
destination_ledger_id
string<uuid>
required

Destination ledger UUID

​
amount
integer
required

Transfer amount in cents

Required range: x >= 1
​
transaction_id
string<uuid>
required

Unique transaction identifier

​
description
string

Transfer description

​
metadata
object

Additional transfer metadata

Response

Transfer created successfully

​
transfer_id
string<uuid>
​
source_entry
object
​
destination_entry
object
​
timestamp
string<date-time>