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

Reset physical card's PIN attempts

Request

Reset the number of PIN attempts for a physical card.

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

Waiting SCA

Bodyapplication/json
scaIdstring(uuid)required

The id of the SCA operation.

joinCodestring(uuid)

The join code if strategy is JOIN_CODE.

ttlobjectrequired
ttl.​secondsinteger(int64)
ttl.​zeroboolean
ttl.​nanointeger(int32)
ttl.​negativeboolean
ttl.​positiveboolean
ttl.​unitsArray of objects
scaDeviceIdstringrequired
Response
application/json
{ "scaId": "b3cefad3-4f89-419b-8221-cc5050122ff3", "joinCode": "0907af4a-d224-4ddb-a7ab-11c52f9fed47", "ttl": { "seconds": 0, "zero": true, "nano": 0, "negative": true, "positive": true, "units": [] }, "scaDeviceId": "string" }

Request

Permanently close a card.

Security
Linkcy-Auth
Path
cardIdstringrequired

The card id

Bodyapplication/jsonrequired
operatorstring(Operator)required

The entity initiating this operation.

Default "END_USER"
Enum"END_USER""PARTNER""LINKCY"
reasonstringrequired
Enum"STOLEN""LOST""DAMAGED""OTHER"
otherReasonstring[ 0 .. 511 ] characters

Description of reason if 'OTHER' was chosen.

application/json
{ "operator": "END_USER", "reason": "STOLEN", "otherReason": "string" }

Responses

Card is being closed

Response
No content

Request

When activating a card for the first time, you must retrieve its truncated PAN from the end-user. In Sandbox, you can retrieve the PAN here.

Security
Linkcy-Auth
Path
cardIdstringrequired

The card id

Bodyapplication/jsonrequired
truncatedPanstring^[0-9]{4}$

Last 4 digits of the card. This value is only available when the card has been received by the end-user.

Example: "1111"
application/json
{ "truncatedPan": "1111" }

Responses

Card is being activated

Response
No content
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations