Skip to content
/
Suspend a ledger

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

Create a ledger

Request

This is the very first point to enter into the banking ecosystem.

You will have the possibility to choose the type and the country of the IBAN. Every EUR IBAN is plugged into SEPA Step 2 and SEPA Instant.

Friendly name must be unique for each consumer.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
Any of:
endUserIdstring(uuid)

The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.

typestringrequired
Enum"EUR_BELGIUM""EUR_FRANCE""EUR_BG"
autoUpgradeboolean

If true, this ledger will be automatically upgraded once activated.

limitsobject(LedgerLimitsRequestDto)
friendlyNamestring[ 1 .. 255 ] characters
application/json
{
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "type": "EUR_BELGIUM",
  "autoUpgrade": true,
  "limits": {
    "ddTransactionLimit": 0,
    "ddMonthlyLimit": 0,
    "transactionLimit": 0,
    "transactionDailyLimit": 0,
    "transactionMonthlyLimit": 0
  },
  "friendlyName": "string"
}

Responses

Created

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

Suspend a ledger

Request

Suspend a ledger and all associated cards.

blockIncomingTransaction set to "true" will prevent incoming transactions.

Card will show a new rule with type LINKCY setting the transaction limit to 0.

Security
Linkcy-Auth
Path
ledgerIdstring(uuid)required
Bodyapplication/jsonrequired
operatorstring(Operator)
Enum"END_USER""PARTNER""LINKCY"
reasonstringrequired
blockIncomingTransactionbooleanrequired
application/json
{
  "operator": "END_USER",
  "reason": "string",
  "blockIncomingTransaction": true
}

Responses

No Content

Response
No content

Close a ledger

Request

Close a ledger and all associated cards.

All balances(totalAmount, availableAmount, reservedAmount) must be to 0.
All transactions must be completed.

Security
Linkcy-Auth
Path
ledgerIdstring(uuid)required
Bodyapplication/jsonrequired
operatorstring(Operator)required

Description of reason if 'OTHER' was chosen.

Default "END_USER"
Enum"END_USER""PARTNER""LINKCY"
reasonstring[ 0 .. 511 ] characters

Description of reason if 'OTHER' was chosen.

application/json
{
  "operator": "END_USER",
  "reason": "string"
}

Responses

No Content

Response
No content

Card

Operations

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