Skip to content
/
Get acquiring transaction...

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

List external cards

Request

Fetch all external cards based on parameters

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

The ID of the end-user. If empty, the query will return results for all end-users.

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(ExternalCardListElementDto_Partner)required
content[].​idstring(uuid)required
content[].​endUserIdstring(uuid)required
content[].​maskedPanstringrequired
content[].​cardHolderNamestringrequired
content[].​schemestringrequired
content[].​typestringrequired
content[].​expiryDatestringrequired
content[].​creationDatestring(date-time)required
content[].​validityDatestring(date-time)required
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
}

Get acquiring transaction information

Request

Get all information about an acquiring 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
  }
}

Beneficiary

Operations

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations