Currencies

Get withdrawals

get

Perform a currency withdrawal from specific address

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/currencies/{currencyId}/withdrawals

HTTPcURLJavaScriptPython

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

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-01-29T01:47:32.890Z",
      "updatedAt": "2026-01-29T01:47:32.890Z",
      "id": "3d152bdd-1ec8-4bb0-93c8-def401747014",
      "brokerId": "d449e186-da32-4e0e-b418-66a0c646403e",
      "currencyId": "84ffdd88-db29-4e44-b081-0a31235bbf47",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "withdrawn",
      "transactionId": "123456789012345678",
      "correlationId": "3d152bdd-1ec8-4bb0-93c8-def401747014"
    }
  ]
}

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

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

Body

application/json

accountAddressstring · xrp-addressRequired

Source account address to withdraw from

Example: rHb9CJAWyB4rj91VRWn96DkukG4bwdtyThPattern: 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

HTTPcURLJavaScriptPython

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

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

201

Withdrawal details

{
  "createdAt": "2026-01-29T01:47:32.890Z",
  "updatedAt": "2026-01-29T01:47:32.890Z",
  "id": "3d152bdd-1ec8-4bb0-93c8-def401747014",
  "brokerId": "d449e186-da32-4e0e-b418-66a0c646403e",
  "currencyId": "84ffdd88-db29-4e44-b081-0a31235bbf47",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "withdrawn",
  "transactionId": "123456789012345678",
  "correlationId": "3d152bdd-1ec8-4bb0-93c8-def401747014"
}

Get currencies

get

Retrieve a list of currencies supported by the platform

Query parameters

modestring · enumOptional

Strategy applied when filtering/searching on multiple fields

Possible values:

Responses

200

Successfully retrieved a list of items.

application/json

get

/currencies

HTTPcURLJavaScriptPython

GET /currencies HTTP/1.1
Accept: */*

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-01-29T01:47:32.890Z",
      "updatedAt": "2026-01-29T01:47:32.890Z",
      "id": "f6bb6c1e-047d-4166-bf06-e8d5f4edd014",
      "name": "Euro",
      "code": "EUR",
      "exponent": 0,
      "supplyLimit": 1000000000,
      "issuingAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh"
    }
  ]
}

Get currency

get

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

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

Responses

200Success

application/json

get

/currencies/{currencyId}

HTTPcURLJavaScriptPython

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

200Success

{
  "createdAt": "2026-01-29T01:47:32.890Z",
  "updatedAt": "2026-01-29T01:47:32.890Z",
  "id": "f6bb6c1e-047d-4166-bf06-e8d5f4edd014",
  "name": "Euro",
  "code": "EUR",
  "exponent": 0,
  "supplyLimit": 1000000000,
  "issuingAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "operationalAccountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "issuingAccount": {
    "createdAt": "2026-01-29T01:47:32.890Z",
    "updatedAt": "2026-01-29T01:47:32.890Z",
    "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "amount": 10000
  },
  "operationalAccount": {
    "createdAt": "2026-01-29T01:47:32.890Z",
    "updatedAt": "2026-01-29T01:47:32.890Z",
    "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
    "amount": 10000
  }
}

Get deposits

get

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

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/currencies/{currencyId}/deposits

HTTPcURLJavaScriptPython

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

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "createdAt": "2026-01-29T01:47:32.890Z",
      "updatedAt": "2026-01-29T01:47:32.890Z",
      "id": "b18c0893-f86b-4477-a267-7b46d623be72",
      "brokerId": "669ed9a5-1ff4-41d4-9214-a28d0df194c4",
      "currencyId": "9d28e972-6028-4355-a800-c392a1a2384e",
      "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
      "iban": "LT601010012345678901",
      "amount": 10000,
      "status": "deposited",
      "transactionId": "123456789012345678",
      "correlationId": "b18c0893-f86b-4477-a267-7b46d623be72"
    }
  ]
}

Get deposit

get

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

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

depositIdstring · uuidRequired

Deposit UUID identifier, globally unique to Axiology TSS

Example: a961a9e2-1d65-4b58-b835-6776fa6b0a71

Responses

200

Successfully received a deposit

application/json

get

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

HTTPcURLJavaScriptPython

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

200

Successfully received a deposit

{
  "createdAt": "2026-01-29T01:47:32.890Z",
  "updatedAt": "2026-01-29T01:47:32.890Z",
  "id": "b18c0893-f86b-4477-a267-7b46d623be72",
  "brokerId": "669ed9a5-1ff4-41d4-9214-a28d0df194c4",
  "currencyId": "9d28e972-6028-4355-a800-c392a1a2384e",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "deposited",
  "transactionId": "123456789012345678",
  "correlationId": "b18c0893-f86b-4477-a267-7b46d623be72"
}

Get withdrawal

get

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

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

withdrawalIdstring · uuidRequired

Withdrawal UUID identifier, globally unique to Axiology TSS

Example: d75c707a-c37e-494f-826e-a54d01557aad

Responses

200

Successfully received a withdrawal

application/json

get

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

HTTPcURLJavaScriptPython

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

200

Successfully received a withdrawal

{
  "createdAt": "2026-01-29T01:47:32.890Z",
  "updatedAt": "2026-01-29T01:47:32.890Z",
  "id": "3d152bdd-1ec8-4bb0-93c8-def401747014",
  "brokerId": "d449e186-da32-4e0e-b418-66a0c646403e",
  "currencyId": "84ffdd88-db29-4e44-b081-0a31235bbf47",
  "accountAddress": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "iban": "LT601010012345678901",
  "amount": 10000,
  "status": "withdrawn",
  "transactionId": "123456789012345678",
  "correlationId": "3d152bdd-1ec8-4bb0-93c8-def401747014"
}

get

Retrieve a list of accounts with balance for specified currency.

Path parameters

currencyIdstring · uuidRequired

Currency UUID identifier, globally unique to Axiology TSS

Example: f841b418-eafd-4ee1-950e-5836b4e9b2c7

Query parameters

Responses

200

Successfully retrieved a list of items.

application/json

get

/currencies/{currencyId}/accounts

HTTPcURLJavaScriptPython

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

200

Successfully retrieved a list of items.

{
  "pagination": {
    "size": 10,
    "page": 1,
    "totalItems": 25,
    "totalPages": 3
  },
  "items": [
    {
      "account": {
        "createdAt": "2026-01-29T01:47:32.890Z",
        "updatedAt": "2026-01-29T01:47:32.890Z",
        "nodeId": "fb098963-aa15-48e0-94cf-84d5b3829044",
        "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
        "type": "investor",
        "institutionSectorCode": "S.11",
        "walletType": "client-individual",
        "status": "active",
        "openedAt": "2026-01-29T01:47:32.890Z"
      },
      "amount": 1000
    }
  ]
}

get

Encode payment description

Query parameters

addressstring · xrp-addressRequired

Source or destination account address

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

Responses

200Success

application/json

get

/utils/description/encode

HTTPcURLJavaScriptPython

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

200Success

{
  "description": "LMRHEQSBMF2GITCMOY4TCQJSKJJTEM3TKFXFEYZRGNXWQRLKPBITO2SBLIRCYIRWMU3TKZBVGBQS2MJQGQYS2NBWMFRC2ODEME2S2MJTHEZTKMJUHEYWCNDDEJOQ",
  "correlationId": "3252c282-fd9f-4af3-ab9d-c1334cd2d5ce"
}

get

Decode payment description

Query parameters

descriptionstringRequired

Encoded payment description

Example: LMRHEQSBMF2GITCMOY4TCQJSKJJTEM3TKFXFEYZRGNXWQRLKPBITO2SBLIRCYIRWMU3TKZBVGBQS2MJQGQYS2NBWMFRC2ODEME2S2MJTHEZTKMJUHEYWCNDDEJOQ

Responses

200Success

application/json

get

/utils/description/decode

HTTPcURLJavaScriptPython

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

200Success

{
  "address": "rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh",
  "correlationId": "f4a3c91d-14ee-4a97-881b-5979a3585fad"
}