Currencies

Get withdrawals

get

Perform a currency withdrawal from specific address

Path parameters

currencyIdstring · uuidRequired

UUIDv4 unique id of a currency

Example: daa019bf-0ba3-42ba-9a1b-778609af6521

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/currencies/{currencyId}/withdrawals

GET /currencies/{currencyId}/withdrawals HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "id": "18e8f296-1928-417a-b022-579ebcf1627e",
      "brokerId": "2c46d54d-08e3-407f-b694-71356f8c9307",
      "currencyId": "9379676d-2890-482d-899d-a125a2e68c68",
      "accountAddress": "text",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "withdrawn",
      "transactionId": {},
      "correlationId": "18e8f296-1928-417a-b022-579ebcf1627e"
    }
  ]
}

Initiate withdrawal

post

Perform a currency withdrawal, specified by currency id in the path, source address should hold some balance of that currency

Path parameters

currencyIdstring · uuidRequired

UUIDv4 unique id of a currency

Example: 2c70b6c3-8d98-463a-93a0-126ba0cf55e4

Body

accountAddressstringRequired

Source account address to withdraw from

Pattern: r[0-9a-zA-Z]{24,34}

amountinteger · int64Required

Amount to withdraw in sub-units

Example: 10000

ibanstring · iban · min: 15 · max: 34Required

Destination IBAN that withdrawal should be sent to

Example: LT601010012345678901Pattern: ^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$

Responses

201

Withdrawal details

application/json

post

/currencies/{currencyId}/withdrawals

POST /currencies/{currencyId}/withdrawals HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "accountAddress": "text",
  "amount": 10000,
  "iban": "LT601010012345678901"
}

201

Withdrawal details

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "18e8f296-1928-417a-b022-579ebcf1627e",
  "brokerId": "2c46d54d-08e3-407f-b694-71356f8c9307",
  "currencyId": "9379676d-2890-482d-899d-a125a2e68c68",
  "accountAddress": "text",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "withdrawn",
  "transactionId": {},
  "correlationId": "18e8f296-1928-417a-b022-579ebcf1627e"
}

Get currencies

get

Retrieve a list of currencies supported by the platform

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Default: ORPossible values:

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/currencies

GET /currencies HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "id": "ef00a90a-417d-498d-a80b-001eb47fb4b1",
      "name": "Euro",
      "code": "EUR",
      "exponent": 2,
      "supplyLimit": 1000000000,
      "issuingAccountAddress": "text",
      "operationalAccountAddress": "text"
    }
  ]
}

Get currency

get

Retrieve full information about a single currency, specified by currency id in the path

Path parameters

currencyIdstring · uuidRequired

UUIDv4 unique id of a currency

Example: b23a569b-816f-4090-92f3-e448baf5e22a

Responses

200Success

application/json

get

/currencies/{currencyId}

GET /currencies/{currencyId} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "ef00a90a-417d-498d-a80b-001eb47fb4b1",
  "name": "Euro",
  "code": "EUR",
  "exponent": 2,
  "supplyLimit": 1000000000,
  "issuingAccountAddress": "text",
  "operationalAccountAddress": "text",
  "issuingAccount": {
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "address": "text",
    "amount": 10000
  },
  "operationalAccount": {
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z",
    "address": "text",
    "amount": 10000
  }
}

Get deposits

get

Get a paginated list of currency's deposits information in the system

Path parameters

currencyIdstring · uuidRequired

UUIDv4 unique id of a currency

Example: 06527432-4c21-4d17-be0c-2a81b98ed851

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/currencies/{currencyId}/deposits

GET /currencies/{currencyId}/deposits HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "id": "d19171cf-c0a8-4dc9-bb3b-bad6a319e74b",
      "brokerId": "f35161ce-b9a7-4b72-8935-3e366bf7b9f5",
      "currencyId": "85c6dd57-84a6-4da2-b558-ae95c35f496a",
      "accountAddress": "text",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "deposited",
      "transactionId": "text",
      "correlationId": "d19171cf-c0a8-4dc9-bb3b-bad6a319e74b"
    }
  ]
}

Get deposit

get

Retrieve full information about a single deposit, specified by deposit id in the path

Path parameters

depositIdstring · uuidRequired

Unique UUID of the deposit in scope of this gateway.

Example: a907313c-ba9a-4923-a8b1-bbb72e408f58

currencyIdanyRequired

UUIDv4 unique id of a currency

Example: 327844a6-5deb-4eb0-b8de-3822668ef930

Responses

200

Successfully received a deposit

application/json

get

/currencies/{currencyId}/deposits/{depositId}

GET /currencies/{currencyId}/deposits/{depositId} HTTP/1.1
Host: 
Accept: */*

200

Successfully received a deposit

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "d19171cf-c0a8-4dc9-bb3b-bad6a319e74b",
  "brokerId": "f35161ce-b9a7-4b72-8935-3e366bf7b9f5",
  "currencyId": "85c6dd57-84a6-4da2-b558-ae95c35f496a",
  "accountAddress": "text",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "deposited",
  "transactionId": "text",
  "correlationId": "d19171cf-c0a8-4dc9-bb3b-bad6a319e74b"
}

Get withdrawal

get

Retrieve full information about a single withdrawal, specified by withdrawal id in the path

Path parameters

withdrawalIdstring · uuidRequired

UUIDv4 unique id of a withdrawal, in the scope of this node

Example: 34960aac-8c78-4f7d-8023-8661d8d125d6

currencyIdanyRequired

UUIDv4 unique id of a currency

Example: 79dce7aa-0d5f-4147-849b-5b287126d561

Responses

200

Successfully received a withdrawal

application/json

get

/currencies/{currencyId}/withdrawals/{withdrawalId}

GET /currencies/{currencyId}/withdrawals/{withdrawalId} HTTP/1.1
Host: 
Accept: */*

200

Successfully received a withdrawal

{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "id": "18e8f296-1928-417a-b022-579ebcf1627e",
  "brokerId": "2c46d54d-08e3-407f-b694-71356f8c9307",
  "currencyId": "9379676d-2890-482d-899d-a125a2e68c68",
  "accountAddress": "text",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "withdrawn",
  "transactionId": {},
  "correlationId": "18e8f296-1928-417a-b022-579ebcf1627e"
}

get

Retrieve a list of accounts with balance for specified currency.

Path parameters

currencyIdstring · uuidRequired

UUIDv4 unique id of a currency

Example: be0defd6-d92e-4e60-b962-689dbcb2a1d8

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

Responseall of

get

/currencies/{currencyId}/accounts

GET /currencies/{currencyId}/accounts HTTP/1.1
Host: 
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "account": {
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z",
        "nodeId": "08bc68e0-cf6d-457b-99ae-f1af131dec33",
        "address": "text",
        "type": "investor",
        "institutionSectorCode": "S.11",
        "walletType": "client-individual",
        "status": "active",
        "openedAt": "2025-10-12T13:47:34.726Z"
      },
      "amount": 1000
    }
  ]
}

get

Encode payment description

Query parameters

addressstringRequired

Source or destination account address

Pattern: r[0-9a-zA-Z]{24,34}

Responses

200Success

application/json

get

/utils/description/encode

GET /utils/description/encode?address=text HTTP/1.1
Host: 
Accept: */*

200Success

{
  "description": "LMRHEQSBMF2GITCMOY4TCQJSKJJTEM3TKFXFEYZRGNXWQRLKPBITO2SBLIRCYIRWMU3TKZBVGBQS2MJQGQYS2NBWMFRC2ODEME2S2MJTHEZTKMJUHEYWCNDDEJOQ",
  "correlationId": "532bd4fe-6525-466d-a554-6f97b6570d3a"
}

get

Decode payment description

Query parameters

descriptionstringRequired

Encoded payment description

Example:

LMRHEQSBMF2GITCMOY4TCQJSKJJTEM3TKFXFEYZRGNXWQRLKPBITO2SBLIRCYIRWMU3TKZBVGBQS2MJQGQYS2NBWMFRC2ODEME2S2MJTHEZTKMJUHEYWCNDDEJOQ

Responses

200Success

application/json

get

/utils/description/decode

GET /utils/description/decode?description=LMRHEQSBMF2GITCMOY4TCQJSKJJTEM3TKFXFEYZRGNXWQRLKPBITO2SBLIRCYIRWMU3TKZBVGBQS2MJQGQYS2NBWMFRC2ODEME2S2MJTHEZTKMJUHEYWCNDDEJOQ HTTP/1.1
Host: 
Accept: */*

200Success

{
  "address": "text",
  "correlationId": "1c1cb97c-dfd6-4976-ab66-e6aa10f48273"
}

PreviousBrokers NextEmis