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

List Beneficiaries

Request

Fetch all your beneficiaries.

Security
Linkcy-Auth
Query
endUserIdstring(uuid)

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

namestring

The name of the beneficiary. If empty, the query will return results for all beneficiaries.

ibanstring

The IBAN of the beneficiary. If empty, the query will return results for all beneficiaries.

statusArray of strings
Items Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
sortAttributestring
Enum"NAME""CREATION_DATE"
displayboolean

Show only display or non display beneficiaries. Both statuses are shown by default.

activeboolean

Show results with only active status or non active status. Both statuses are shown by default.

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 GbpBeneficiaryListElementDto_Partner (object) or SepaBeneficiaryListElementDto_Partner (object)required
One of:

The information on a beneficiary.

content[].​namestringrequired
content[].​idstring(uuid)required
content[].​typestringrequired
Enum"PERSON""COMPANY"
content[].​statusstringrequired
Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
content[].​activebooleanrequired
content[].​friendlyNamestring
content[].​endUserIdstring(uuid)required
content[].​creationDatestring(date-time)required
content[].​updateDatestring(date-time)required
content[].​accountTypestringrequired
Enum"IBAN""GBP""USD"
content[].​displaybooleanrequired
content[].​accountNumberstringrequired
content[].​sortCodestringrequired
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
}

Add a new beneficiary

Request

Beneficiaries are the one who will receive funds. When you add a beneficiary, the consumer must use the exact full name. If he adds as a beneficiary one of his own accounts, we must be able to detect it. It will simplify Strong Customer Authentication (SCA) during a transfer.

You must fill one of the beneficiary types. BIC / SWIFT code is only required for IBAN. If you want to simplify transfers later, we suggest you add a SWIFT code for US and UK beneficiaries.

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
endUserIdstring(uuid)

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

typestringrequired

Describe if the beneficiary is a person or a company.

Enum"PERSON""COMPANY"
namestringrequired

Complete name of the person (firstName middleName lastName) or name of the company.

Example: "John Michael Doe"
friendlyNamestring[ 1 .. 255 ] characters

Friendly name given to the beneficiary.

bankingDetailsSepaBankingDetails (object) or GbpBankingDetails (object) or UsdBankingDetails (object)(BankingDetails)required
Any of:
bankingDetails.​ibanstringrequired

Must be a valid iban format following the standard ISO_13616.

bankingDetails.​bicstringrequired

Must be a valid bic following the standard ISO_9362.

displayboolean

Display (or not) the beneficiary to the end-user (unusable by end-user).

activeboolean

Activate (or not) the beneficiary. Default value is true.

application/json
{
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "type": "PERSON",
  "name": "John Michael Doe",
  "friendlyName": "string",
  "bankingDetails": {
    "iban": "string",
    "bic": "string"
  },
  "display": true,
  "active": true
}

Responses

Created

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

Get beneficiary's information

Request

Get all information about a beneficiary using its ID.

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

Responses

OK

Bodyapplication/json
One of:

The information on a beneficiary.

linkcyLedgerIdstring(uuid)

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

namestringrequired
idstring(uuid)required
typestringrequired
Enum"PERSON""COMPANY"
statusstringrequired
Enum"DECLINED""PENDING_REVIEW""VALID""PENDING""NEED_ADDITIONAL_INFORMATION"
activebooleanrequired
friendlyNamestring
endUserIdstring(uuid)required

The endUser owning this beneficiary.

creationDatestring(date-time)required
updateDatestring(date-time)required
accountTypestringrequired
Enum"IBAN""GBP""USD"
displayboolean
accountNumberstringrequired
sortCodestringrequired
Response
application/json
{
  "linkcyLedgerId": "a46808dc-b040-4d05-b916-a3302b04dc12",
  "name": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "PERSON",
  "status": "DECLINED",
  "active": true,
  "friendlyName": "string",
  "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  "creationDate": "2019-08-24T14:15:22Z",
  "updateDate": "2019-08-24T14:15:22Z",
  "accountType": "IBAN",
  "display": true,
  "accountNumber": "string",
  "sortCode": "string"
}

Transaction

Operations

Direct Debit Mandate

Operations

Wallet

Operations

Crypto Beneficiary

Operations

Crypto Transaction

Operations

Additional

Operations

Sandbox

Operations

Web Pages

Operations