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

List transactions

Request

Fetch all transactions.

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

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

ledgerIdstring(uuid)

Get transactions made from or to this ledger (ledgerFrom / ledgerTo)

cardIdstring(uuid)

Get transactions made from this card

transactionTypesArray of strings(TransactionType)
Items Enum"CARD_AUTHORIZATION""CARD_CLEARING""SEPA_DIRECT_DEBIT""INTER_LEDGER""ACQUIRING""FX""SEPA_CREDIT_TRANSFER""UK_CREDIT_TRANSFER""UNKNOWN"
paymentTypesArray of strings
Items Enum"MONEY_TRANSFER""TECH_MVC_CREATION""TECH_TRANSACTION""TECH_VIRTUAL_TRANSFER""ACCOUNT_LOAD""PAYMENT""ACCOUNT_FUNDING""ACCOUNT_TRANSFER""ACCOUNT_VERIFICATION""ADJUSTMENT_CREDIT"
showReleasedTransactionboolean

Get transactions in RELEASED status (card authorization), by default is true

showDeclinedTransactionboolean

Get transactions in DECLINED and ABORTED 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""DECLINED""RELEASED""REVERSED""PENDING""PENDING_REVIEW""UNKNOWN""ABORTED"
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 Inter-Ledger (object) or SEPA (object) or Card (object) or UK (object) or Other (object) or Acquiring (object)(TransactionResponseDto_Partner)required
Any of:
content[].​idstring(uuid)required
content[].​typestringrequired
Value"INTER_LEDGER"
content[].​paymentTypestringrequired
Enum"MONEY_TRANSFER""ACCOUNT_LOAD""TECH_MVC_CREATION""TECH_TRANSACTION""TECH_VIRTUAL_TRANSFER"
content[].​statusstringrequired
Enum"APPROVED""DECLINED""RELEASED""REVERSED""PENDING""PENDING_REVIEW""UNKNOWN""ABORTED"
content[].​creationDatestring(date-time)required
content[].​amountnumberrequired
content[].​currencystringrequired
Enum"EUR""GBP""USD""PLN""AUD""CHF""CAD""SEK""NOK""JPY"
content[].​informationobject(Transaction Information)required
content[].​information.​originalAmountnumberrequired
content[].​information.​originalCurrencystringrequired
content[].​information.​conversionRatestringrequired
content[].​information.​declineReasonstring
Enum"BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED""BENEFICIARY_INFORMATION_MISSING""BENEFICIARY_INFORMATION_INVALID""BENEFICIARY_NAME_DOES_NOT_MATCH_BENEFICIARY_ACCOUNT""BENEFICIARY_NOT_ENABLED_FOR_INSTANT_PAYMENTS""REFERENCE_INVALID""SENDER_ACCOUNT_CLOSED""SENDER_INFORMATION_INVALID""AMOUNT_OR_CURRENCY_INVALID""INSUFFICIENT_FUNDS"
content[].​information.​notestring
content[].​information.​clearingDatestring(date-time)required
content[].​information.​referencestring
content[].​senderobject(Transaction Actor)
content[].​receiverobject(Transaction Actor)
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
}

Create a transaction to a beneficiary

Request

Create a transaction between a ledger and a 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
amountnumberrequired
beneficiaryIdstring(uuid)required
ledgerFromIdstring(uuid)required
referencestring[ 0 .. 60 ] characters^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$

Reference of the transaction. If null, default reference will be 'Transfer'.

allowFastPaymentboolean

If for any reason you do not want want to allow fast payment, (ie: want to use EU_SEPA_STEP2 over EU_SEPA_INSTANT), you can set this field to false. In sandbox, GBP transactions are always in fast payment and EUR transactions are always in normal payment.

Default true
allowInterLedgerboolean

If Linkcy detect a possible inter-ledger operation, Linkcy automatically perform this inter-ledger operation. However, if you do not want to, you can set this field to false

Default true
application/json
{
  "amount": 0,
  "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
  "ledgerFromId": "b595c981-8a0f-4604-a66c-209d65193394",
  "reference": "string",
  "allowFastPayment": true,
  "allowInterLedger": true
}

Responses

Created

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

Create an inter-ledger transaction

Request

Create a transaction between ledgers of two of your end-users.

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
ledgerFromIdstring(uuid)required
ledgerToIdstring(uuid)required
amountnumberrequired
referencestring[ 0 .. 60 ] characters^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$

Reference of the transaction. If null, default reference will be 'Transfer'.

application/json
{
  "ledgerFromId": "b595c981-8a0f-4604-a66c-209d65193394",
  "ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488",
  "amount": 0,
  "reference": "string"
}

Responses

Created

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

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations