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

Create a default card profile rule

Request

When creating a card with this profile, profile rules will by default be applied to the card.

Any modification on a rule type will ONLY apply to new created cards.

Any card created PRIOR to that modification will NOT be affected by it, and will retain all rules applied on creation.

Security
Linkcy-Auth
Path
cardProfileIdstring(uuid)required
ruleTypestringrequired
Enum"DAILY_MAX_SPEND""MONTHLY_MAX_SPEND""WEEKLY_MAX_SPEND""DISABLE_CONTACTLESS""DISABLE_ONLINE""DISABLE_RECURRING""MCC_WHITELIST""MCC_BLACKLIST""MERCHANT_WHITELIST""MERCHANT_BLACKLIST"
Bodyapplication/jsonrequired
Any of:
valueinteger(int64)[ 1 .. 999999999 ]required
namestring
endUserIdstring(uuid)
creatorTypestring
Enum"END_USER""PARTNER""LINKCY"
application/json
{ "value": 1, "name": "string", "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "creatorType": "END_USER" }

Responses

No Content

Response
No content

Request

Remove a default card rule from card profile.

This only applies to cards created AFTER default rule deletion.

Any card created PRIOR to that modification will NOT be affected by it, and will retain all rules applied on creation.

Security
Linkcy-Auth
Path
cardProfileIdstring(uuid)required
ruleTypestringrequired
Enum"DAILY_MAX_SPEND""MONTHLY_MAX_SPEND""WEEKLY_MAX_SPEND""DISABLE_CONTACTLESS""DISABLE_ONLINE""DISABLE_RECURRING""MCC_WHITELIST""MCC_BLACKLIST""MERCHANT_WHITELIST""MERCHANT_BLACKLIST"
No request payload

Responses

No Content

Response
No content

Request

Fetch all cards based on parameters. More options will be added in the near future.

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

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

ledgerIdstring(uuid)

The ID of the card ledger. If empty, the query will return cards for all ledgers.

profileIdstring(uuid)

The ID of the card profile. If empty, the query will return cards for all profiles.

statusArray of strings
Items Enum"CREATING""AWAITING_ACTIVATION""ACTIVATING""REACTIVATING""ACTIVE""SUSPENDING""SUSPENDED""CLOSING""CLOSED""EXPIRED"
typesArray of strings
Items Enum"PHYSICAL""VIRTUAL"
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(CardListElementDto)required
content[].​idstring(uuid)required
content[].​endUserIdstring(uuid)required
content[].​ledgerIdstring(uuid)required
content[].​friendlyNamestring
content[].​profileobject(Profile)required
content[].​profile.​idstring(uuid)required
content[].​profile.​namestringrequired
content[].​expiryDatestringrequired
content[].​nameOnCardstringrequired
content[].​cardholderNameOnCardstring
content[].​typestringrequired
Enum"PHYSICAL""VIRTUAL"
content[].​statusstringrequired
Enum"CREATING""AWAITING_ACTIVATION""ACTIVATING""REACTIVATING""ACTIVE""SUSPENDING""SUSPENDED""CLOSING""CLOSED""EXPIRED"
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 }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations