cURL
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, "type": "credit", "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, "type": "credit", "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" }
Create a transfer between two ledgers
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
Source ledger UUID
Destination ledger UUID
Transfer amount in cents
x >= 1
Unique transaction identifier
Transfer description
Additional transfer metadata
Transfer created successfully
Show child attributes