Skip to content

Linkcy Api (1.114.5)

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
sandbox.json
sandbox.yaml
Overview
URL
https://linkcy.io/#contact
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/

Authentication

Operations

Strong Authentication

Operations

Partner

Operations

Webhook

Operations

End-user

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

Corporate

Operations

KYC

Operations

KYB

Operations

Documents

Operations

Ledger

Operations

List ledgers

Request

Fetch all ledger based on parameters.

Security
Linkcy-Auth
Query
sortAttributestring
Value"CREATION_DATE"
endUserIdstring(uuid)

The ID of the end-user. If empty, the query will return results for all end-users.

statusArray of strings
Items Enum"PENDING""ACTIVE""CLOSING""CLOSED""SUSPENDED""FAILED"
parentIdstring(uuid)

The ID of the parent ledger you want to retrieve virtual ledgers from. If empty, the query will return ledgers regardless of parent.

ibanstring
pageSizeinteger(int32)<= 100

The size of the page to be returned.

pageinteger(int32)[ 0 .. 500 ]

The page number.

sortDirectionstring
Enum"ASC""DESC"
No request payload

Responses

OK

Bodyapplication/json
contentArray of objects(PartnerLedgerListElementDto)required
content[].​isUpgradedbooleanrequired
content[].​idstring(uuid)required
content[].​currencystringrequired
Enum"EUR""GBP""USD""PLN""AUD""CHF""CAD""SEK""NOK""JPY"
content[].​countrystringrequired
Enum"ESTONIA""FRANCE""BELGIUM""GREAT_BRITAIN""LITHUANIA""BULGARIA""USA"
content[].​parentIdstring(uuid)

The id of the parent ledger if this ledger is virtual

content[].​statusstringrequired
Enum"PENDING""ACTIVE""CLOSING""CLOSED""SUSPENDED""FAILED"
content[].​friendlyNamestring
content[].​endUserobject(End-user)required
content[].​endUser.​idstring(uuid)required
content[].​creationDatestring(date-time)required
totalElementsinteger(int64)required
Example: 1
pageinteger(int32)required

The page number.

pageSizeinteger(int32)required

The requested page size.

Response
application/json
{
  "content": [
    { … }
  ],
  "totalElements": 1,
  "page": 0,
  "pageSize": 0
}

Create a ledger

Request

This is the very first point to enter into the banking ecosystem.

You will have the possibility to choose the type and the country of the IBAN. Every EUR IBAN is plugged into SEPA Step 2 and SEPA Instant.

Friendly name must be unique for each consumer.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
endUserIdstring(uuid)

The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.

typestringrequired
Enum"EUR_BELGIUM""EUR_FRANCE""EUR_BG"
autoUpgradeboolean

If true, this ledger will be automatically upgraded once activated.

limitsobject(LedgerLimitsRequestDto)
friendlyNamestring[ 1 .. 255 ] characters
application/json
{
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "type": "EUR_BELGIUM",
  "autoUpgrade": true,
  "limits": {
    "ddTransactionLimit": 0,
    "ddMonthlyLimit": 0,
    "transactionLimit": 0,
    "transactionDailyLimit": 0,
    "transactionMonthlyLimit": 0
  },
  "friendlyName": "string"
}

Responses

Created

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

Suspend a ledger

Request

Suspend a ledger and all associated cards.

blockIncomingTransaction set to "true" will prevent incoming transactions.

Card will show a new rule with type LINKCY setting the transaction limit to 0.

Security
Linkcy-Auth
Path
ledgerIdstring(uuid)required
Bodyapplication/jsonrequired
operatorstring(Operator)
Enum"END_USER""PARTNER""LINKCY"
reasonstringrequired
blockIncomingTransactionbooleanrequired
application/json
{
  "operator": "END_USER",
  "reason": "string",
  "blockIncomingTransaction": true
}

Responses

No Content

Response
No content

Card

Operations

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations