LinkCy

Ledger

List ledgers

Fetch all ledger based on parameters.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "CREATION_DATE"
endUserId
string <uuid>

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

status
Array of strings
Items Enum: "PENDING" "ACTIVE" "CLOSING" "CLOSED" "SUSPENDED" … 1 more
parentId
string <uuid>

The ID of the parent ledger you want to retrieve virtual ledgers from. If empty, the query will return ledgers regardless of parent.

iban
string
pageSize
integer <int32> <= 100

The size of the page to be returned.

page
integer <int32> >= 0

The page number.

sortDirection
string
Enum: "ASC" "DESC"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/partner/ledgers
Request samples 
Response samples 
application/json
{
  • "content": [
    ],
  • "totalElements": 1,
  • "page": 0,
  • "pageSize": 0
}
Create a ledger
This is the very first point to enter into the banking ecosystem. 


You will have the possibility to choose the type and the country of the IBAN. Every EUR IBAN is plugged into SEPA Step 2 and SEPA Instant.


Friendly name must be unique for each consumer.


SecurityLinkcy-Auth 
Request 
Request Body schema: application/json
required
Any of:
endUserId
string <uuid> 
The id of the end-user, can be a consumer or corporate. Mandatory if not authenticated as end-user.


 
type
required
string
 Enum: "EUR_BELGIUM" "EUR_FRANCE"  
autoUpgrade
boolean
If true, this ledger will be automatically upgraded once activated.


 
object (LedgerLimitsRequestDto) 
 
friendlyName
string  [ 1 .. 255 ] characters 
 
Responses 
201
Created


400
Bad Request


401
Unauthorized


403
Forbidden


409
Conflict


post/api/partner/ledgers
Request samples 
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "EUR_BELGIUM",
  • "autoUpgrade": true,
  • "limits": {
    },
  • "friendlyName": "string"
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Upgrade a ledger
By upgrading a ledger, you will be able to access its account number and perform SEPA transactions to and from it.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/ledgers/{ledgerId}/upgrade
Request samples 
Response samples 
application/json
{
  • "details": [
    ],
  • "errorCode": "CONSUMER_NOT_FOUND",
  • "error": "linkcy.bad.request",
  • "status": 400,
  • "timestamp": "2024-11-14T16:15:01.629595888Z"
}
Suspend a ledger
Suspend a ledger and all associated cards.


Card will show a new rule with type LINKCY setting the transaction limit to 0.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Request Body schema: application/json
required
operator
string (Operator) 
 Enum: "END_USER" "PARTNER" "LINKCY"  
reason
required
string
 
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/ledgers/{ledgerId}/suspensions
Request samples 
application/json
{
  • "operator": "END_USER",
  • "reason": "string"
}
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Close a ledger
Close a ledger and all associated cards.


All balances(totalAmount, availableAmount, reservedAmount) must be to 0.
All transactions must be completed.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Request Body schema: application/json
required
operator
required
string (Operator) 
 Default:  "END_USER"
Description of reason if 'OTHER' was chosen.


 Enum: "END_USER" "PARTNER" "LINKCY"  
reason
string  [ 0 .. 511 ] characters 
Description of reason if 'OTHER' was chosen.


 
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


post/api/partner/ledgers/{ledgerId}/close
Request samples 
application/json
{
  • "operator": "END_USER",
  • "reason": "string"
}
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
Get information on a ledger
Get all information about a ledger using its ID.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/ledgers/{ledgerId}
Request samples 
Response samples 
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": {
    },
  • "closeInformation": {
    }
}
Update a ledger
You can patch a ledger to update some information.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Request Body schema: application/json
required
friendlyName
string  [ 1 .. 255 ] characters 
 
parentLedgerId
string <uuid> 
 
object (LedgerLimitsRequestDto) 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


patch/api/partner/ledgers/{ledgerId}
Request samples 
application/json
{
  • "friendlyName": "string",
  • "parentLedgerId": "2588f3a1-5f2a-470b-8a33-a5d776eff4af",
  • "limits": {
    }
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
Get a ledger statement
SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
query Parameters
startDate
string <date> 
 
endDate
string <date> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


get/api/partner/documents/ledger-statement/{ledgerId}
Request samples 
Response samples 
application/json
{
  • "url": "string",
  • "ttl": "PT8H6M12.345S"
}
Get banking details from ledger
SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
Responses 
200
OK


400
Bad Request


401
Unauthorized


403
Forbidden


404
Not Found


409
Conflict


get/api/partner/documents/bank-details/{ledgerId}
Request samples 
Response samples 
application/json
{
  • "url": "string",
  • "ttl": "PT8H6M12.345S"
}
Unsuspend a ledger
Unsuspend a ledger and all associated cards.


SecurityLinkcy-Auth 
Request 
path Parameters
ledgerId
required
string <uuid> 
 
operator
required
string (Operator) 
 Enum: "END_USER" "PARTNER" "LINKCY"  
Responses 
204
No Content


400
Bad Request


401
Unauthorized


403
Forbidden


delete/api/partner/ledgers/{ledgerId}/suspensions/{operator}
Request samples 
Response samples 
application/json
{
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}
➔ Next to Card