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

Request

Get temporary PAN credentials for this card.

Credentials are valid for 60 seconds, after which you will need to request new credentials again.

This operation might require SCA.

Security
Linkcy-Auth
Path
cardIdstring(uuid)required
Headers
Linkcy-SCA-Strategystring

The strategy to use when a SCA is required:

More information:
  • PUSH_NOTIFICATION: will send a notification if the SCA is required.
  • DATA_SIGNING: Linkcy-SCA-Signature header must contain signature provided by PowerAuth Mobile SDK on registered device.
  • BY_PASS: Sandbox only - will ignore any SCA if used.
Error Codes
  • 409 Conflict
    • SCA_REQUIRED: The operation you are trying to do requires SCA, current strategy {0}.
Default PUSH_NOTIFICATION
Enum"PUSH_NOTIFICATION""DATA_SIGNING""BY_PASS"
Linkcy-SCA-Signaturestring

The signature that needs to be validated, it is generated from data signing.

More information:
  • Signature will be verified against wultra.
  • Operation will be denied if signature is not valide.
  • Avoid creating multiple signature at same time for the same registration.
  • Signature TTL is 30 sec.
Error Codes
  • 401 Forbidden
    • SCA_SIGNATURE_DOES_NOT_MATCH: The sca signature provided doesn't match the one required for this operation
  • 404 Not Found
    • NO_ACTIVE_SCA_DEVICE_FOUND: No active SCA device could be found.
  • 409 Conflict
    • SCA_DEVICE_NOT_VALID: The device cannot be used to sign this data.
    • SCA_SIGNATURE_FORMAT_INVALID: The signature format for data signing SCA strategy is invalid: HTTP header validation failed.
    • SCA_SIGNATURE_MISSING: The signature required for data signing SCA strategy is missing.
  • 500 Internal Server Error
    • SCA_UNEXPECTED_ERROR: Unable to perform SCA operation
No request payload

Responses

OK

Bodyapplication/json
tokenstringrequired

The token to allow your end-user to use the PAN SDK.

Example: "237733595"
secretstringrequired

The secret to allow your end-user to use the PAN SDK.

Example: "066#28055031"
ttlstringrequired

The secret remaining time to live duration in ISO 8601.

Default "PT1M"
Example: "PT8H6M12.345S"
Response
application/json
{ "token": "237733595", "secret": "066#28055031", "ttl": "PT8H6M12.345S" }

Request

Fetch all card designs based on parameters.

Security
Linkcy-Auth
Query
sortAttributestring
Value"FRIENDLY_NAME"
schemestring
Enum"MASTERCARD""VISA"
ledgerTypestring
Enum"EUR_BELGIUM""EUR_FRANCE""EUR_ESTONIA""EUR_LITHUANIA""USD_USA""GBP_GREAT_BRITAIN""EUR_BG"
cardTypestring
Enum"PHYSICAL""VIRTUAL"
userTypestring
Enum"CORPORATE""CONSUMER"
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(CardDesignListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​friendlyNamestringrequired
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[].​availableCountriesArray of stringsrequired
Items Enum"ABW""AFG""AGO""AIA""ALA""ALB""AND""ARE""ARG""ARM"
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