Skip to content

Overview

This is the partner API from linkcy. Here you can find our API documentation.

LinkCy API allows you to create fully embedded banking products for your own company or consumers. This API is backed by all mandatory requirements by financial authorities. To process, information provided into the API must be accurate.

Authentication

You can obtain a LinkCy Authorization Key by contacting our commercial team here.

Download OpenAPI description
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
Operations
Operations
Operations
Operations
Operations

Consumer

The consumer represents the individual partner client. It must have a valid phone number and be formally identified with a KYC procedure before carrying out any operation.

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Create a SEPA Direct Debit transaction. The ledger and the mandate must be activated.

If the mandate is not recurring, only one transaction will be allowed.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
mandateIdstring(uuid)required
ledgerToIdstring(uuid)required
datestring(date)required

The date on which the direct debit must be executed. Cannot be earlier than D+2 and must be a working day (neither weekend nor public holiday).

amountnumberrequired
referencestring[ 0 .. 60 ] characters^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$required

Reference of the transaction. If null, default reference will be 'Transfer'.

application/json
{ "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad", "ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488", "date": "2019-08-24", "amount": 0, "reference": "string" }

Responses

Created

Bodyapplication/json
idstring(uuid)required
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }

Request

Get all information about a transaction using its ID.

Security
Linkcy-Auth
Path
transactionIdstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
Any of:
idstring(uuid)required
typestringrequired
Value"INTER_LEDGER"
paymentTypestringrequired
Enum"MONEY_TRANSFER""ACCOUNT_LOAD""TECH_MVC_CREATION""TECH_TRANSACTION""TECH_VIRTUAL_TRANSFER"
statusstringrequired
Enum"APPROVED""DECLINED""RELEASED""REVERSED""PENDING""PENDING_REVIEW""UNKNOWN""ABORTED"
creationDatestring(date-time)required
amountnumberrequired
currencystringrequired
Enum"EUR""GBP""USD""PLN""AUD""CHF""CAD""SEK""NOK""JPY"
informationobject(Transaction Information)required
information.​originalAmountnumberrequired
information.​originalCurrencystringrequired
information.​conversionRatestringrequired
information.​declineReasonstring
Enum"BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED""BENEFICIARY_INFORMATION_MISSING""BENEFICIARY_INFORMATION_INVALID""BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT""BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS""REFERENCE_INVALID""SENDER_ACCOUNT_CLOSED""SENDER_INFORMATION_INVALID""AMOUNT_OR_CURRENCY_INVALID""INSUFFICIENT_FUNDS"
information.​notestring
information.​clearingDatestring(date-time)required
information.​referencestring
senderobject(Transaction Actor)
receiverobject(Transaction Actor)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "INTER_LEDGER", "paymentType": "MONEY_TRANSFER", "status": "APPROVED", "creationDate": "2019-08-24T14:15:22Z", "amount": 0, "currency": "EUR", "information": { "originalAmount": 0, "originalCurrency": "string", "conversionRate": "string", "declineReason": "BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED", "note": "string", "clearingDate": "2019-08-24T14:15:22Z", "reference": "string" }, "sender": { "ledgerFriendlyName": "string", "virtualLedgerId": "9fd33797-d74c-48f1-ae37-6d778044619f", "virtualLedgerFriendlyName": "string", "name": "string", "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7", "previousTotalBalance": 0, "previousReservedBalance": 0 }, "receiver": { "ledgerFriendlyName": "string", "virtualLedgerId": "9fd33797-d74c-48f1-ae37-6d778044619f", "virtualLedgerFriendlyName": "string", "name": "string", "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7", "previousTotalBalance": 0, "previousReservedBalance": 0 } }

Request

Create a receipt for a transaction using its ID. File generated is in pdf format.

Security
Linkcy-Auth
Path
transactionIdstring(uuid)required
No request payload

Responses

OK

Bodyapplication/json
urlstringrequired
ttlstringrequired
Example: "PT8H6M12.345S"
Response
application/json
{ "url": "string", "ttl": "PT8H6M12.345S" }
Operations
Operations
Operations
Operations
Operations
Operations
Operations