API Documentation
Addresses
- Addresses
- Management
Users
- Users overview
- Registration
- Management
- Credentials
- Password
Roles
- Roles overview
- Role Management
- User Role Management
Personas
- Personas overview
- Personal Identity
- User-Persona
Customers
- Customers overview
- Management
- Team Management
- Settings
Countries
- Countries overview
- Management
- Lookup
Currencies
- Currencies overview
- Management
- Exchange Rates
FX
- FX overview
- Exchange Rates
Ledger
- Ledgers overview
- Management
- Operations
- Reports
Tariffs
- Tariffs overview
- Management
- Fee Ranges
- Calculations
Tasks
- Tasks overview
- Management
- Actions
- Assignees
Transactions
- Transactions overview
- Management
- Actions
- Recipients
Uploads
- Uploads overview
- Files
- Customer Documents
Invoices
- Invoices overview
- Management
- Processing
- Payers
- Customer
Accounts
- Accounts overview
- Management
- Customer
- Balance
Chat
- Chat overview
- Conversations
- Messages
Utilities
- Utilities overview
- Record Management
Profile
- Profile overview
- Management
- Avatar
- Security
KYB
- KYB overview
- Flow
- Answers
RBAC
- RBAC overview
- Permissions
- Management
- System
Operations
Transfer between ledgers
Create a transfer between two ledgers
POST
/
v1
/
ledgers
/
{id}
/
transfer
Copy
{
"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"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Source ledger UUID
Body
application/json
Response
201
application/json
Transfer created successfully
The response is of type object
.
Copy
{
"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"
}
Assistant
Responses are generated using AI and may contain mistakes.