Skip to content
/
Create a direct debit tra...

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

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

Create a direct debit transaction

Request

Create a SEPA Direct Debit transaction. The ledger and the mandate must be activated.

If the mandate is not recurring, only one transaction will be allowed.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
mandateIdstring(uuid)required
ledgerToIdstring(uuid)required
datestring(date)required

The date on which the direct debit must be executed. Cannot be earlier than D+2 and must be a working day (neither weekend nor public holiday).

amountnumberrequired
referencestring[ 0 .. 60 ] characters^[.'a-zA-ZÀ-ÿ0-9,_? /-]*$required

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

application/json
{
  "mandateId": "d4dbf0da-b5aa-43ae-b9db-c2aff331d3ad",
  "ledgerToId": "7280fced-5334-43dd-8913-9f06bb46b488",
  "date": "2019-08-24",
  "amount": 0,
  "reference": "string"
}

Responses

Created

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

Get transaction's information

Request

Get all information about a transaction using its ID.

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

Responses

OK

Bodyapplication/json
Any of:
idstring(uuid)required
typestringrequired
Value"INTER_LEDGER"
paymentTypestringrequired
Enum"MONEY_TRANSFER""ACCOUNT_LOAD""TECH_MVC_CREATION""TECH_TRANSACTION""TECH_VIRTUAL_TRANSFER"
statusstringrequired
Enum"APPROVED""DECLINED""RELEASED""REVERSED""PENDING""PENDING_REVIEW""UNKNOWN""ABORTED"
creationDatestring(date-time)required
amountnumberrequired
currencystringrequired
Enum"EUR""GBP""USD""PLN""AUD""CHF""CAD""SEK""NOK""JPY"
informationobject(Transaction Information)required
information.​originalAmountnumberrequired
information.​originalCurrencystringrequired
information.​conversionRatestringrequired
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"
information.​notestring
information.​clearingDatestring(date-time)required
information.​referencestring
senderobject(Transaction Actor)
receiverobject(Transaction Actor)
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "INTER_LEDGER",
  "paymentType": "MONEY_TRANSFER",
  "status": "APPROVED",
  "creationDate": "2019-08-24T14:15:22Z",
  "amount": 0,
  "currency": "EUR",
  "information": {
    "originalAmount": 0,
    "originalCurrency": "string",
    "conversionRate": "string",
    "declineReason": "BENEFICIARY_ACCOUNT_CLOSED_OR_STOPPED",
    "note": "string",
    "clearingDate": "2019-08-24T14:15:22Z",
    "reference": "string"
  },
  "sender": {
    "ledgerFriendlyName": "string",
    "virtualLedgerId": "9fd33797-d74c-48f1-ae37-6d778044619f",
    "virtualLedgerFriendlyName": "string",
    "name": "string",
    "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
    "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
    "previousTotalBalance": 0,
    "previousReservedBalance": 0
  },
  "receiver": {
    "ledgerFriendlyName": "string",
    "virtualLedgerId": "9fd33797-d74c-48f1-ae37-6d778044619f",
    "virtualLedgerFriendlyName": "string",
    "name": "string",
    "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
    "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7",
    "previousTotalBalance": 0,
    "previousReservedBalance": 0
  }
}

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations