Create transfer between ledgers

Create a transfer transaction between two ledgers, with optional currency conversion

POST/v1/ledgers/transfers

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Represents the input for creating a transfer between ledgers. Ledgers can be identified using UUID (source_ledger_id/dest_ledger_id), code (source_ledger_code/dest_ledger_code), or numeric ID (source_ledger_num_id/dest_ledger_num_id).

source_ledger_id?string

Source ledger ID (required unless source_ledger_code or source_ledger_num_id is provided)

source_ledger_code?string

Source ledger code (alternative to source_ledger_id)

source_ledger_num_id?integer

Numeric ID of the source ledger (alternative to source_ledger_id and source_ledger_code)

dest_ledger_id?string

Destination ledger ID (required unless dest_ledger_code or dest_ledger_num_id is provided)

dest_ledger_code?string

Destination ledger code (alternative to dest_ledger_id)

dest_ledger_num_id?integer

Numeric ID of the destination ledger (alternative to dest_ledger_id and dest_ledger_code)

amount*integer

Amount in minor units (e.g., cents for EUR/USD)

description?string

Transfer description

reference_id?string

External reference ID

metadata?

Additional metadata

perform_conversion?boolean

Whether to perform currency conversion

value_date?string

Date when the transfer takes economic effect (defaults to current date if not provided)

Response Body

`application/json`

curl -X POST "https://example.com/v1/ledgers/transfers" \  -H "Content-Type: application/json" \  -d '{    "amount": 0  }'

{
  "transaction": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "string",
    "total_amount": {
      "amount": "123456",
      "currency": "EUR",
      "precision": 2
    },
    "currency_id": "305e0674-ee79-42b7-bf83-278294a47a7b",
    "currency_code": "string",
    "description": "string",
    "reference_id": "string",
    "timestamp": "2019-08-24T14:15:22Z",
    "value_date": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "reconciled_at": "2019-08-24T14:15:22Z",
    "metadata": {},
    "created_at": "2019-08-24T14:15:22Z",
    "modified_at": "2019-08-24T14:15:22Z",
    "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
    "modified_by": "e8d4374d-93a1-4e98-a6c6-fdcf00c5059f",
    "total_debit_lcy": {
      "amount": "123456",
      "currency": "EUR",
      "precision": 2
    },
    "total_credit_lcy": {
      "amount": "123456",
      "currency": "EUR",
      "precision": 2
    },
    "active": true,
    "id_client": "string"
  },
  "transit_funds": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
    "source_ledger_id": "d3e70a10-4c19-47f1-a6ca-0fba6a88cc7e",
    "dest_ledger_id": "678fc2d3-64d6-4319-a49b-91099d0fe468",
    "transit_ledger_id": "ed483d94-1f3e-400d-aee6-e6e2bb01c035",
    "amount": {
      "amount": "123456",
      "currency": "EUR",
      "precision": 2
    },
    "status": "pending",
    "value_date": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "completed_at": "2019-08-24T14:15:22Z",
    "metadata": {}
  },
  "message": "string",
  "links": {
    "complete_transfer": "string"
  }
}

Empty

Request Body

Response Body

201application/json

400

401

403

404

`application/json`