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
Operations

Request

Create a direct debit mandate. Once created, the mandate must be activated in order to be effective.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
endUserIdstring(uuid)

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

friendlyNamestring[ 1 .. 255 ] characters
debtorobject(DebtorCreateRequestDto)required

The information on the debtor.

debtor.​typestringrequired

Describe if the debtor is a person or a company.

Enum"PERSON""COMPANY"
debtor.​namestring[ 3 .. 511 ] charactersrequired

Complete name of the person (firstName middleName lastName) or name of the company.

Example: "John Michael Doe"
debtor.​bankingDetailsSepaDebtorBankingDetails (object)(DebtorBankingDetails)
SepaDebtorBankingDetails (object)(DebtorBankingDetails)
recurringboolean

If true, the mandate will be used for recurring payments. By default is false.

expirationDatestring(date)

The expiration date of the mandate. By default is 5 years from today.

application/json
{ "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "friendlyName": "string", "debtor": { "type": "PERSON", "name": "John Michael Doe", "bankingDetails": {} }, "recurring": true, "expirationDate": "2019-08-24" }

Responses

Created

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

Request

Cancel a direct debit mandate. This operation is irreversible.

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

Responses

OK

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

Request

Activate a direct debit mandate. You must complete debtor banking details before activating the mandate.

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

Responses

OK

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