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

List user accounts

Request

List all user accounts of the specified partner.

Security
Linkcy-Auth
Query
sortAttributestring
Value"EMAIL"
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(PartnerUserAccountListElementDto)required
content[].​idstring(uuid)required
content[].​emailstringrequired
content[].​rolesArray of strings(LinkcyRole)unique

List of roles of the user.

Items Enum"ACCOUNT_CREATE""BANKING_DETAILS_DOCUMENT_EXPORT""BENEFICIARY_CREATE""BENEFICIARY_INFO""BENEFICIARY_LIST""BENEFICIARY_UPDATE""DIRECT_DEBIT_MANDATE_CREATE""DIRECT_DEBIT_MANDATE_UPDATE""DIRECT_DEBIT_MANDATE_ACTIVATE""DIRECT_DEBIT_MANDATE_CANCEL"
content[].​creationDatestring(date-time)required
content[].​updateDatestring(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 user account

Request

Create a partner user account.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Partner user account (object)(AccountCreateRequestDto)
application/json
{
  "email": "string",
  "roles": [
    "ACCOUNT_CREATE"
  ]
}

Responses

Created

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

Get your information

Request

Get your configuration information as partner.

Security
Linkcy-Auth
No request payload

Responses

OK

Bodyapplication/json
namestringrequired
displayNamestring

Name display on documents.

logoUrlstring

Url that provides the logo.

addressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

consumerOtpMessagestring

Message displayed when requesting a OTP message.

corporateOtpMessagestring

Message displayed when requesting a OTP message.

emailPropertiesobject(EmailProperties_Partner)
contactInformationobject(ContactInformation_Partner)required
contactInformation.​adminEmailstring
contactInformation.​billingEmailstring
contactInformation.​commercialEmailstring
contactInformation.​techEmailstring
contactInformation.​complianceEmailstring
limitsobject(PartnerLimitsResponseDto_Partner)required

Configuration of limits.

limits.​ledgerobject(Partner Default Ledger Limits)

Configuration of the default ledger limits for this partner.

limits.​sctInstobject(Partner Default SEPA Credit Transfer Instant Limits)

Configuration of the default transaction limit for SEPA Instant Credit Transfer (SCT Inst) for this partner.

limits.​limitedStatusobject(Partner Default limited status Limits)

Default transaction limit configuration for end-users with limited status for this partner

creationDatestring(date-time)required
updateDatestring(date-time)required
Response
application/json
{
  "name": "string",
  "displayName": "string",
  "logoUrl": "string",
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isoCountryCode": "ABW",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "status": "INVALID"
  },
  "consumerOtpMessage": "string",
  "corporateOtpMessage": "string",
  "emailProperties": {
    "senderEmailAddress": "string",
    "senderEmailName": "string"
  },
  "contactInformation": {
    "adminEmail": "string",
    "billingEmail": "string",
    "commercialEmail": "string",
    "techEmail": "string",
    "complianceEmail": "string"
  },
  "limits": {
    "ledger": { … },
    "sctInst": { … },
    "limitedStatus": { … }
  },
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z"
}

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

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations