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

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

Update a rule from card

Request

Update card by creating a new card rule. When creating a card rule with a type that already exists, it will override the previous one.

Both partner and enduser can set a rule of the same type. The more restrictive one will be applied.

This operation might require SCA.

Security
Linkcy-Auth
Path
cardIdstring(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"
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
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

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"
}

Remove card rule

Request

remove rule from card

This operation might require SCA.

Security
Linkcy-Auth
Path
cardIdstring(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"
Query
creatorTypestring
Enum"END_USER""PARTNER""LINKCY"
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"
}

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

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