Transaction - 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.
Request Body schema: application/json
ledgerFromId
required
string <uuid>
ledgerToId
required
string <uuid>
amount
required
number
reference
string [ 0 .. 18 ] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$

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 :

Copy
Copied
{
    "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). You can also optionally provide a reference for this transaction.

By default, LinkCy will use the best rails to perform this transaction :

  • if an instant transaction is possible (Using SEPA instant of UK Faster Payments for example), then it will be applied.
  • if the beneficiary account is a ledger host at LinkCy, an inter-ledger transaction will be made.
You can prevent these optimizations by setting the allowFastPayment or allowInterLedger to false.
Request Body schema: application/json
amount
required
number
beneficiaryId
required
string <uuid>
ledgerFromId
required
string <uuid>
reference
string [ 0 .. 18 ] characters ^[.'a-zA-ZÀ-ÿ0-9,? ]*$
allowFastPayment
boolean
Default: true

If for any reason you do not want want to allow fast payment, (ie: want to use EU_SEPA_STEP2 over EU_SEPA_INSTANT), you can set this field to false. In sandbox, GBP transactions are always in fast payment and EUR transactions are always in normal payment.

allowInterLedger
boolean
Default: true

If Linkcy detect a possible inter-ledger operation, Linkcy automatically perform this inter-ledger operation. However, if you do not want to, you can set this field to false

Payload Example :

Cannot find specified operation in definition: linkcy

Answer will contains only the id of the created transaction :

Copy
Copied
{
    "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]. (./webhooks.mdx)