Skip to content

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
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
Operations
Operations
Operations

Request

Update your configuration information as Partner.

Security
Linkcy-Auth
Bodyapplication/jsonrequired
addressobject(EuropeanAddressRequest)

Address that will be used on the bank statements of your users.

consumerOtpMessagestring

Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.

If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."

corporateOtpMessagestring

Message that will be displayed when requesting a OTP message. You must include the following place holder: "$otp" where you want to display the OTP secret.

If not set, the default message is: "Your {partnerName} secret to change your password is: {secret} If you are not at the origin of this message, you can ignore it."

displayNamestring

Name display on documents.

logoUrlstring

Url that provides the logo.

contactInformationobject(ContactInformation_Partner)
application/json
{ "address": { "isoCountryCode": "AUT", "city": "string", "postalCode": "string", "street": "string", "number": "string", "refinement": "string", "stateOrProvince": "string", "bypassVerification": true }, "consumerOtpMessage": "string", "corporateOtpMessage": "string", "displayName": "string", "logoUrl": "string", "contactInformation": { "adminEmail": "string", "billingEmail": "string", "commercialEmail": "string", "techEmail": "string", "complianceEmail": "string" } }

Responses

OK

Bodyapplication/json
idstring(uuid)required
updateDatestring(date-time)required
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "updateDate": "2019-08-24T14:15:22Z" }

Request

Update a partner user account.

Security
Linkcy-Auth
Path
accountIdstring(uuid)required
Bodyapplication/jsonrequired
Partner user account (object)(AccountUpdateRequestDto)
application/json
{ "roles": [ "ACCOUNT_CREATE" ] }

Responses

OK

Bodyapplication/json
idstring(uuid)required
updateDatestring(date-time)required
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "updateDate": "2019-08-24T14:15:22Z" }

Request

Get your acquiring configuration information.

Security
Linkcy-Auth
No request payload

Responses

OK

Bodyapplication/json
saleMerchantIdstring
recurringSaleMerchantIdstring
loadMerchantIdstring
recurringLoadMerchantIdstring
saleLedgerIdstring(uuid)
loadLedgerIdstring(uuid)
loadRateFeenumber
customPageUrlstring
loadFlatFeenumber
minLoadnumber
maxLoadnumber
Response
application/json
{ "saleMerchantId": "string", "recurringSaleMerchantId": "string", "loadMerchantId": "string", "recurringLoadMerchantId": "string", "saleLedgerId": "7c9baf3d-1dd4-4bcc-8ea2-e16acc7b3405", "loadLedgerId": "c6604c79-9922-41d2-b00b-5fa26e6d7c23", "loadRateFee": 0, "customPageUrl": "string", "loadFlatFee": 0, "minLoad": 0, "maxLoad": 0 }
Operations
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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations