Ledger

List ledgers

Fetch all ledger based on parameters.

SecurityLinkcy-Auth
Request
query Parameters
sortAttribute
string
Value: "CREATION_DATE"
endUserId
string <uuid>
pageSize
integer <int32> [ 0 .. 100 ]
Default: 20

The size of the page to be returned.

page
integer <int32> >= 0
Default: 0

The page number.

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

OK

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

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
endUserId
string <uuid>

Mandatory if not authenticated as end-user.

type
required
string
Enum: "EUR_LITHUANIA" "EUR_FRANCE" "USD_USA" "GBP_GREAT_BRITAIN"
friendlyName
string [ 0 .. 255 ] characters
autoUpgrade
boolean

If true, this ledger will be automatically upgraded once activated.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409
500

Internal Server Error

post/api/partner/ledgers
Request samples
application/json
{
  • "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5",
  • "type": "EUR_LITHUANIA",
  • "friendlyName": "string",
  • "autoUpgrade": true
}
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
500

Internal Server Error

post/api/partner/ledgers/{ledgerId}/upgrade
Request samples
Response samples
application/json
{
  • "errorCode": "CONSUMER_NOT_FOUND",
  • "status": 400,
  • "details": [
    ],
  • "error": "linkcy.bad.request",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Freeze a ledger

Freeze 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
operator
string (Operator)

The operator of the operation. If the operation can be reverted, the same or higher authorization level will be required.Can be END_USER for when requesting as consumer or corporate. Can be END_USER or PARTNER when requesting as a partner.

Enum: "END_USER" "PARTNER" "LINKCY"
reason
required
string
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

post/api/partner/ledgers/{ledgerId}/freeze
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
operator
required
string (Operator)
Default: "END_USER"

The operator of the operation. If the operation can be reverted, the same or higher authorization level will be required.Can be END_USER for when requesting as consumer or corporate. Can be END_USER or PARTNER when requesting as a partner.

Enum: "END_USER" "PARTNER" "LINKCY"
reason
string [ 0 .. 511 ] characters
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

409
500

Internal Server Error

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

409

Conflict

500

Internal Server Error

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": "ACTIVE",
  • "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"
}

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
500

Internal Server Error

get/api/partner/documents/bank-details/{ledgerId}
Request samples
Response samples
application/json
"string"