Send money
Money can be sent using differents transaction types :
Inter-ledger
To send money using inter-ledger transaction, use the "Create an inter-ledger transaction" endpoint.
You have to provide the Ledger which will be debited (ledgerFromId), the ledger which will be credited (ledgerToId) and the(amount).
You can also optionally provide a reference for this transaction.
| Name | Type | Description |
|---|---|---|
| ledgerFromId | string (uuid) | The unique identifier of the source ledger. |
| ledgerToId | string (uuid) | The unique identifier of the destination ledger. |
| amount | number | The amount to be transferred. |
| reference | string [0 .. 18] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$ | A reference for the transfer. Can contain letters, numbers, spaces, and specific characters. |
Payload Example :
{
"ledgerFromId": "b595c981-8a0f-4604-a66c-209d65193394",
"ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488",
"amount": 15.21,
"reference": "string"
}For a transaction with a decimal, please use "." instead of ",".
Answer will contains only the id of the created transaction :
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}You can then fetch this transaction to check the status. Additionaly, if you suscribed to webhhooks, you will be notified of any change in the transaction status. You can find the complete catalog of webhooks [here]. (./webhooks.mdx)
Transaction to a beneficiary
To send money to an extrernal beneficiary, use the "Create a transaction to a beneficiary" endpoint.
Pay attention to send the same currency as the beneficiary account currency.
You have to provide the Ledger which will be debited (ledgerFromId), the beneficiary which will be credited (beneficiaryId) and the (amount). If you want the transaction to be instant (using SEPA Instant for instance), you have to set allowFastPayment to true.
You can also optionally provide a reference for this transaction.
If the beneficiary account is a ledger held at LinkCy, an inter-ledger transaction will be made instead.
| Name | Type | Description |
|---|---|---|
| amount | number | The amount to be transferred. |
| beneficiaryId | string (uuid) | The unique identifier of the beneficiary. |
| ledgerFromId | string (uuid) | The unique identifier of the source ledger. |
| reference | string [0 .. 18] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$ | A reference for the transfer. Can contain letters, numbers, spaces, and specific characters. |
| allowFastPayment | boolean Default: true | If you want the transaction to be instant |
| allowInterLedger | boolean Default: true | If Linkcy detects a possible inter-ledger operation, it will automatically perform it. Set this field to false if you do not want inter-ledger operations. |
Answer will contains only the id of the created transaction :
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}You can then fetch this transaction to check the status. Additionaly, if you sunscribed to webhhooks, you will be notified of all change in the transaction status. Please find the complete catalog of webhooks here.