Skip to content
/
Create a card profile

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

List card profiles

Request

Fetch all card profiles based on parameters.

Security
Linkcy-Auth
Query
sortAttributestring
Value"NAME"
userTypesArray of strings
Items Enum"CORPORATE""CONSUMER"
ledgerTypesArray of strings
Items Enum"EUR_BELGIUM""EUR_FRANCE""EUR_ESTONIA""EUR_LITHUANIA""USD_USA""GBP_GREAT_BRITAIN""EUR_BG"
cardTypesArray of strings
Items Enum"PHYSICAL""VIRTUAL"
activeboolean
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(CardProfileListElementDto)required
content[].​idstring(uuid)required
content[].​namestringrequired
content[].​schemestringrequired
Enum"MASTERCARD""VISA"
content[].​ledgerTypestringrequired
Enum"EUR_BELGIUM""EUR_FRANCE""EUR_ESTONIA""EUR_LITHUANIA""USD_USA""GBP_GREAT_BRITAIN""EUR_BG"
content[].​cardTypestringrequired
Enum"PHYSICAL""VIRTUAL"
content[].​userTypestringrequired
Enum"CORPORATE""CONSUMER"
content[].​activebooleanrequired
content[].​programobject(Program)required
content[].​program.​idstring(uuid)required
content[].​designobject(Design)required
content[].​design.​idstring(uuid)required
content[].​rulesArray of objects(Card Rule)required
content[].​rules[].​typestringrequired
Enum"DAILY_MAX_SPEND""MONTHLY_MAX_SPEND""WEEKLY_MAX_SPEND""DISABLE_CONTACTLESS""DISABLE_ONLINE""DISABLE_RECURRING""MCC_WHITELIST""MCC_BLACKLIST""MERCHANT_WHITELIST""MERCHANT_BLACKLIST"
content[].​rules[].​namestring
content[].​rules[].​valueinteger(int64)
content[].​rules[].​targetsArray of strings
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 card profile

Request

Create a card profile based on a card design.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
namestringrequired
cardDesignIdstring(uuid)required

The card design identifier on which the new card profile will be based.

activeboolean

When active, end-users are able to see this profile and create card with it.

When disabled, it can not be used to create new cards anymore.

application/json
{
  "name": "string",
  "cardDesignId": "21f1b6eb-5662-41f7-952d-3d240b7c3aed",
  "active": true
}

Responses

Created

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

Get card's information

Request

Get all information about a card using its ID.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
endUserIdstring(uuid)required
ledgerIdstring(uuid)required
profileobject(Profile_Partner)required
profile.​idstring(uuid)required
profile.​namestringrequired
expiryDatestring
nameOnCardstring
cardholderNameOnCardstring
friendlyNamestring
deliveryAddressobject(AddressResponseDto_Partner)

Address used on the bank statements of your users.

deliveryMethodstring
Enum"UK_MAIL""INTERNATIONAL_MAIL""FRENCH_MAIL""FRENCH_MAIL_TRACKING""DHL""COURIER"
deliveryShipmentDatestring(date)
deliveryTrackingNumberstring
truncatedPanstring

Last 4 digits of the card. The truncated pan is only displayed if the card has been activated.

typestringrequired
Enum"PHYSICAL""VIRTUAL"
schemestringrequired
Enum"MASTERCARD""VISA"
currencystringrequired
Enum"EUR""GBP""USD""PLN""AUD""CHF""CAD""SEK""NOK""JPY"
statusobject(CardStatusDto_Partner)required
status.​valuestringrequired
Enum"CREATING""AWAITING_ACTIVATION""ACTIVATING""REACTIVATING""ACTIVE""SUSPENDING""SUSPENDED""CLOSING""CLOSED""EXPIRED"
status.​reasonstring
Enum"STOLEN""LOST""DAMAGED""OTHER""LEDGER_CLOSED"
status.​otherReasonstring
status.​operatorstring
Enum"END_USER""PARTNER""LINKCY"
suspensionsInformationArray of objects(CardSuspensionInfoDto_Partner)required
suspensionsInformation[].​datestring(date-time)required
suspensionsInformation[].​reasonstring
Enum"STOLEN""LOST""DAMAGED""OTHER""LEDGER_CLOSED"
suspensionsInformation[].​otherReasonstring
suspensionsInformation[].​operatorstringrequired
Enum"END_USER""PARTNER""LINKCY"
creationDatestring(date-time)required
updateDatestring(date-time)required
pinStatusstringrequired
Enum"LOCKED""UNLOCKING""UNLOCKED""WAITING_ONLINE_TRANSACTION"
rulesArray of ValueCardRuleResponseDto_Partner (object) or TargetsCardRuleResponseDto_Partner (object)(CardRuleResponseDto_Partner)required
Any of:
rules[].​namestring
rules[].​creatorstring
Enum"END_USER""PARTNER""LINKCY"
rules[].​typestringrequired
Enum"DAILY_MAX_SPEND""MONTHLY_MAX_SPEND""WEEKLY_MAX_SPEND""DISABLE_CONTACTLESS""DISABLE_ONLINE""DISABLE_RECURRING""MCC_WHITELIST""MCC_BLACKLIST""MERCHANT_WHITELIST""MERCHANT_BLACKLIST"
rules[].​valueinteger(int64)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
  "profile": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "expiryDate": "string",
  "nameOnCard": "string",
  "cardholderNameOnCard": "string",
  "friendlyName": "string",
  "deliveryAddress": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "isoCountryCode": "ABW",
    "city": "string",
    "postalCode": "string",
    "street": "string",
    "number": "string",
    "refinement": "string",
    "stateOrProvince": "string",
    "status": "INVALID"
  },
  "deliveryMethod": "UK_MAIL",
  "deliveryShipmentDate": "2019-08-24",
  "deliveryTrackingNumber": "string",
  "truncatedPan": "string",
  "type": "PHYSICAL",
  "scheme": "MASTERCARD",
  "currency": "EUR",
  "status": {
    "value": "CREATING",
    "reason": "STOLEN",
    "otherReason": "string",
    "operator": "END_USER"
  },
  "suspensionsInformation": [
    { … }
  ],
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "pinStatus": "LOCKED",
  "rules": [
    { … }
  ]
}

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