The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.
- Get beneficiary's information
List Beneficiaries
Add a new beneficiary
Patch a beneficiary
Get beneficiary's informa...
Linkcy Api (1.114.5)
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.
You can obtain a LinkCy Authorization Key by contacting our commercial team here.
Download OpenAPI description
Overview
Languages
Servers
Generated server url
https://api.sandbox.linkcy.cloud/
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
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
Bodyapplication/jsonrequiredThe 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"
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
Complete name of the person (firstName middleName lastName) or name of the company.
Example: "John Michael Doe"
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/beneficiaries
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
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 }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/beneficiaries/{beneficiaryId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
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" }
If you notice an error or find something unclear, we’d greatly appreciate your feedback to help us improve.
Headers
Bodyapplication/jsonrequiredThe 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"
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
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/beneficiaries/{beneficiaryId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "active": true, "display": true, "friendlyName": "string" }
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" }