Skip to content

Nyala Customer API (v1)

NYALA's tokenization API allows you to issue tokens on Polygon & Stellar. It allows you to create and manage tokens - including tokenized securities that have an ISIN - and to manage customer data. Interactions such as creating a new customer entity, request a wallet opening, creating a token and distributing a token to a customer are covered in this document. During the onboarding process, an institution entity will be created for you.

Download OpenAPI description
index.json
index.yaml
Overview
URL
https://www.nyala.de
Nyala Digital Asset AG
developer@nyala.de
Languages
Servers
Production Environment
https://api.nyala.de
UAT / Sandbox Environment
https://uat.api.nyala.de

Customer

The first step in the tokenization lifecycle is to create a Customer that will receive the token.

Operations

Retail Wallet

The second step in the tokenization lifecycle is to request a retail wallet for the Customer newly created. The tokens will be sent to that wallet, and the private key to the wallet will be custodied using our technology.

Operations

Returns a list of retail wallet object associated with the given customer id.

Request

Path
customer-idstring(uuid)required

Customer Id.

curl -i -X GET \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/retail-wallets'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
dataArray of objects or null(RetailWalletDto)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ]
}

Request a new wallet for a customer from the selected custodian.

Request

Path
customer-idstring(uuid)required

Customer Id.

Body

Contains Credentials to access the mnemonic seed. Encryption key file can be left empty, if it's stored on the Custodian side.

custodyProviderstring(int32)(CustodyProvider)
Enum"HADC""Tangany""TanganyExternal""Iris"
curl -i -X POST \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/retail-wallets' \
  -H 'Content-Type: application/json' \
  -d '{
    "custodyProvider": "HADC"
  }'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
dataArray of objects or null(RetailWalletDto)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ]
}

Approves the customer for Monerium. Requests Ibans for all customer wallets from Monerium.

Request

Path
customer-idstring(uuid)required

Customer Id.

curl -i -X POST \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/approve-for-monerium'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
dataArray of objects or null(RetailWalletDto)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ]
}

Request to whitelist a retail wallet for an asset class.

Request

Path
customer-idstring(uuid)required

Customer id.

Body

Data.

tokenizedAssetIdstring(uuid)required
approvedForDeliveryboolean
amountnumber(double)
custodyProviderstring(int32)(CustodyProvider)
Enum"HADC""Tangany""TanganyExternal""Iris"
curl -i -X POST \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/asset-class-opt-in' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenizedAssetId": "ad18357f-6719-482f-a109-bd87822008b9",
    "approvedForDelivery": true,
    "amount": 0.1,
    "custodyProvider": "HADC"
  }'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
datastring(uuid)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

Update asset class optin.

Request

Path
customer-idstring(uuid)required

Customer id.

Body

Data.

tokenizedAssetIdstring(uuid)
approvedForDeliveryboolean
amountnumber(double)
custodyProviderstring(int32)(CustodyProvider)
Enum"HADC""Tangany""TanganyExternal""Iris"
curl -i -X PATCH \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/asset-class-opt-in' \
  -H 'Content-Type: application/json' \
  -d '{
    "tokenizedAssetId": "ad18357f-6719-482f-a109-bd87822008b9",
    "approvedForDelivery": true,
    "amount": 0.1,
    "custodyProvider": "HADC"
  }'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
datastring(uuid)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90"
}

Monerium Redeem. Place Order on Monerium to Redeem.

Request

Path
customer-idstring(uuid)required

Customer Id.

Body

Request Dto.

amountstring or null
ibanstring or null
curl -i -X POST \
  'https://api.nyala.de/api/external/v1/customers/{customer-id}/monerium-redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "amount": "string",
    "iban": "string"
  }'

Responses

OK

Bodyapplication/json
errorMessageCodesArray of strings or nullread-only
errorsArray of objects or null(Error)read-only
dataArray of objects or null(RetailWalletDto)read-only
Response
application/json
{
  "errorMessageCodes": [
    "string"
  ],
  "errors": [
    { … }
  ],
  "data": [
    { … }
  ]
}

External Retail Wallet

Operations

Status

Operations
Cookies
Copyright © NYALA Digital Asset AG.