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

Card

Operations

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

List direct debit mandates

Request

Fetch all direct debit mandates based on parameters.

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

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

statusstring
Enum"AWAITING_ACTIVATION""ACTIVATING""ACTIVATED""CANCELING""CANCELED""FAILED"
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(DirectDebitMandateListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​uniqueReferencestringrequired
content[].​endUserIdstring(uuid)required
content[].​statusstringrequired
Enum"AWAITING_ACTIVATION""ACTIVATING""ACTIVATED""CANCELING""CANCELED""FAILED"
content[].​friendlyNamestring
content[].​debtorobject(DebtorInfoResponseDto_Partner)required
content[].​debtor.​typestringrequired
Enum"PERSON""COMPANY"
content[].​debtor.​namestringrequired
content[].​debtor.​bankingDetailsSepaDebtorBankingDetails_Partner (object)(DebtorBankingDetails_Partner)
SepaDebtorBankingDetails_Partner (object)(DebtorBankingDetails_Partner)
content[].​debtor.​ledgerIdstring(uuid)

Sometimes the debtor account can correspond to a ledger that you manage, in this case, we would send you the corresponding id.

content[].​recurringboolean
content[].​expirationDatestring(date)
content[].​updateDatestring(date-time)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 new direct debit mandate

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"
}

Cancel a direct debit mandate

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"
}

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations