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

Request

You can patch a ledger to update some information.

Security
Linkcy-Auth
Path
ledgerIdstring(uuid)required
Bodyapplication/jsonrequired
friendlyNamestring[ 1 .. 255 ] characters
parentLedgerIdstring(uuid)
limitsobject(LedgerLimitsRequestDto)
application/json
{ "friendlyName": "string", "parentLedgerId": "2588f3a1-5f2a-470b-8a33-a5d776eff4af", "limits": { "ddTransactionLimit": 0, "ddMonthlyLimit": 0, "transactionLimit": 0, "transactionDailyLimit": 0, "transactionMonthlyLimit": 0 } }

Responses

OK

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

Request

Security
Linkcy-Auth
Path
ledgerIdstring(uuid)required
Query
startDatestring(date)
endDatestring(date)
No request payload

Responses

OK

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

Request

Security
Linkcy-Auth
Path
ledgerIdstring(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
Operations
Operations
Operations
Operations