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

Acquiring

Operations

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

List crypto transactions

Request

Fetch all crypto transactions.

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

The id of the end-user who is transaction actor (sender / receiver)

walletIdstring(uuid)

Get transactions made from or to this wallet (walletFrom / walletTo)

blockchainTypesArray of strings
Items Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
paymentTypesArray of strings
Items Enum"TOKEN_SEND""TOKEN_RECEIVE"
showDeclinedTransactionboolean

Get transactions in DECLINED status, by default is true

startDatestring(date-time)

Get transactions from this date, example: 2022-05-16T10:30

endDatestring(date-time)

Get transactions until this date, example: 2022-05-16T10:30

statusArray of strings
Items Enum"APPROVED""PENDING""DECLINED"
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(CryptoTransactionResponseDto_Partner)required
content[].​idstring(uuid)required
content[].​paymentTypestringrequired
Enum"TOKEN_SEND""TOKEN_RECEIVE"
content[].​typestringrequired
Value"DIGITAL_ASSETS"
content[].​statusstringrequired
Enum"APPROVED""PENDING""DECLINED"
content[].​amountnumberrequired
content[].​assetstringrequired
content[].​decimalsinteger(int32)required
content[].​informationobject(Crypto Transaction Information)required
content[].​information.​blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
content[].​information.​transactionHashstring
content[].​feesobject(Crypto Transaction Fees)
content[].​senderobject(Crypto Transaction Actor)
content[].​receiverobject(Crypto Transaction Actor)
content[].​referencestring
content[].​creationDatestring(date-time)required
content[].​confirmationDatestring(date-time)
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
}

Send tokens to a crypto beneficiary

Request

Send tokens to a crypto beneficiary.

This operation might require SCA.

Security
Linkcy-Auth
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
beneficiaryIdstring(uuid)required
walletFromIdstring(uuid)required
referencestring[ 0 .. 60 ] characters^[.'a-zA-ZÀ-ÿ0-9,? ]*$
assetstringrequired

The symbol of the asset to be sent. For example, 'SepoliaETH' for Sepolia Ethereum.

Example: "ETH"
contractstring
amountnumberrequired

Amount in the smallest fraction. (example: for 1 ETH, amount should be 1000000000000000000)

application/json
{
  "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  "walletFromId": "053f8d4b-9949-4ce1-a1b8-5890d9b26f9a",
  "reference": "string",
  "asset": "ETH",
  "contract": "string",
  "amount": 0
}

Responses

Created

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

Get crypto transaction's information

Request

Get all information about a crypto transaction using its ID.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
paymentTypestringrequired
Enum"TOKEN_SEND""TOKEN_RECEIVE"
typestringrequired
Value"DIGITAL_ASSETS"
statusstringrequired
Enum"APPROVED""PENDING""DECLINED"
amountnumberrequired
assetstringrequired
decimalsinteger(int32)required
informationobject(Crypto Transaction Information)required
information.​blockchainstringrequired
Enum"BITCOIN""ETHEREUM""BNB_SMART_CHAIN"
information.​transactionHashstring
feesobject(Crypto Transaction Fees)
senderobject(Crypto Transaction Actor)
receiverobject(Crypto Transaction Actor)
referencestring
creationDatestring(date-time)required
confirmationDatestring(date-time)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "paymentType": "TOKEN_SEND",
  "type": "DIGITAL_ASSETS",
  "status": "APPROVED",
  "amount": 0,
  "asset": "string",
  "decimals": 0,
  "information": {
    "blockchain": "BITCOIN",
    "transactionHash": "string"
  },
  "fees": {
    "amount": 0,
    "asset": "string",
    "decimals": 0
  },
  "sender": {
    "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
    "name": "string",
    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
    "walletAddress": "string",
    "walletFriendlyName": "string"
  },
  "receiver": {
    "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
    "name": "string",
    "walletId": "0ecad4a2-3549-43fb-807e-9ff033247480",
    "walletAddress": "string",
    "walletFriendlyName": "string"
  },
  "reference": "string",
  "creationDate": "2019-08-24T14:15:22Z",
  "confirmationDate": "2019-08-24T14:15:22Z"
}

Additional

Operations

Sandbox

Operations

Web Pages

Operations