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

Request

Initiate an acquiring transaction for a payment. For testing purposes, use the following fake cards: Testing cards

Security
Linkcy-Auth
Bodyapplication/jsonrequired
amountnumberrequired
endUserIdstring(uuid)
redirectUrlstring

Browser will load this URL once payment is completed and can be used to continue the payment journey.

The redirectUrl must be fully qualified for HTTP POST requests.

referencestring
storeCardboolean

Needs to be set to true in order to register external card. Mandatory if amount is zero

externalCardIdstring(uuid)

Id of the external card (required to start a direct payment/top-up).

application/json
{ "amount": 0, "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "redirectUrl": "string", "reference": "string", "storeCard": true, "externalCardId": "fcafdf75-98d6-4bb8-9493-4b96e1b8a14c" }

Responses

OK

Bodyapplication/json
idstring(uuid)required

Id of the created acquiring transaction

webPageobject(Download)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "webPage": { "ttl": "PT8H6M12.345S", "url": "string" } }

Request

Initiate an acquiring transaction for an account load. For testing purposes, use the following fake cards: Testing cards

Security
Linkcy-Auth
Bodyapplication/jsonrequired
amountnumberrequired
targetLedgerIdstring(uuid)required

Identifies the ledger that will be topped up

redirectUrlstring

Browser will load this URL once payment is completed and can be used to continue the payment journey.

The redirectUrl must be fully qualified for HTTP POST requests.

referencestring
storeCardboolean

Needs to be set to true in order to register external card. Mandatory if amount is zero

endUserIdstring(uuid)
externalCardIdstring(uuid)

Id of the external card (required to start a direct payment/top-up).

application/json
{ "amount": 0, "targetLedgerId": "c08a7469-a75d-455d-a40f-2578815cd03c", "redirectUrl": "string", "reference": "string", "storeCard": true, "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "externalCardId": "fcafdf75-98d6-4bb8-9493-4b96e1b8a14c" }

Responses

OK

Bodyapplication/json
idstring(uuid)required

Id of the created acquiring transaction

webPageobject(Download)
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "webPage": { "ttl": "PT8H6M12.345S", "url": "string" } }

Request

Fetch all external cards 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.

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(ExternalCardListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​endUserIdstring(uuid)required
content[].​maskedPanstringrequired
content[].​cardHolderNamestringrequired
content[].​schemestringrequired
content[].​typestringrequired
content[].​expiryDatestringrequired
content[].​creationDatestring(date-time)required
content[].​validityDatestring(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 }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations