Skip to content
/
Activate a direct debit m...

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

Cancel a direct debit mandate

Request

Cancel a direct debit mandate. This operation is irreversible.

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

Responses

OK

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

Activate a direct debit mandate

Request

Activate a direct debit mandate. You must complete debtor banking details before activating the mandate.

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

Responses

OK

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

Get a direct debit mandate information

Request

Get all information about a direct debit mandate using its ID.

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

Responses

OK

Bodyapplication/json
idstring(uuid)required
uniqueReferencestringrequired
endUserIdstring(uuid)required
statusstringrequired
Enum"AWAITING_ACTIVATION""ACTIVATING""ACTIVATED""CANCELING""CANCELED""FAILED"
friendlyNamestring
debtorobject(DebtorInfoResponseDto_Partner)required
debtor.​typestringrequired
Enum"PERSON""COMPANY"
debtor.​namestringrequired
debtor.​bankingDetailsSepaDebtorBankingDetails_Partner (object)(DebtorBankingDetails_Partner)
SepaDebtorBankingDetails_Partner (object)(DebtorBankingDetails_Partner)
debtor.​ledgerIdstring(uuid)

Sometimes the debtor account can correspond to a ledger that you manage, in this case, we would send you the corresponding id.

recurringboolean
expirationDatestring(date)
updateDatestring(date-time)required
creationDatestring(date-time)required
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "uniqueReference": "string",
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "status": "AWAITING_ACTIVATION",
  "friendlyName": "string",
  "debtor": {
    "type": "PERSON",
    "name": "string",
    "bankingDetails": { … },
    "ledgerId": "a2873d47-59a8-4daf-a325-cb2c04557dd7"
  },
  "recurring": true,
  "expirationDate": "2019-08-24",
  "updateDate": "2019-08-24T14:15:22Z",
  "creationDate": "2019-08-24T14:15:22Z"
}

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations