Get all information about a ledger using its ID.
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
- Generated server urlhttps://api.sandbox.linkcy.cloud/api/partner/ledgers/{ledgerId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadOK
Any of:
When inactive, no external banking information will be returned. Assign an account number to enable the fields.
Direct debit transaction limit. If null, it will take the default value defined in the partner configuration.
Direct Debit Monthly Limit. If null, it will take the default value defined in the partner configuration.
Transaction Limit. If null, it will take the default value defined in the partner configuration.
Transaction Daily Limit. If null, it will take the default value defined in the partner configuration.
Transaction Monthly Limit. If null, it will take the default value defined in the partner configuration.
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "friendlyName": "string", "status": "PENDING", "currency": "EUR", "country": "ESTONIA", "totalAmount": 0, "availableAmount": 0, "reservedAmount": 0, "creationDate": "2019-08-24T14:15:22Z", "updateDate": "2019-08-24T14:15:22Z", "isUpgraded": true, "iban": "string", "bicOrSwift": "string", "accountNumber": "string", "sortCode": "string", "routingNumber": "string", "suspensionsInformation": [ { … } ], "limits": { "ddTransactionLimit": 0, "ddMonthlyLimit": 0, "ddMonthlyLimitUsed": 0, "transactionLimit": 0, "transactionDailyLimit": 0, "transactionDailyLimitUsed": 0, "transactionMonthlyLimit": 0, "transactionMonthlyLimitUsed": 0 }, "closeInformation": { "date": "2019-08-24T14:15:22Z", "reason": "string", "operator": "END_USER" } }
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/ledgers/{ledgerId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "friendlyName": "string", "parentLedgerId": "2588f3a1-5f2a-470b-8a33-a5d776eff4af", "limits": { "ddTransactionLimit": 0, "ddMonthlyLimit": 0, "transactionLimit": 0, "transactionDailyLimit": 0, "transactionMonthlyLimit": 0 } }
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/documents/ledger-statement/{ledgerId}
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
No request payloadResponse
application/json
{ "url": "string", "ttl": "PT8H6M12.345S" }