↔️Transactions

API's to manage Transactions.

Production URL: https://transactions-v1-api-t3mipd377q-ey.a.run.app

Create Payout Request

Payouts can be created for users which will be deducted from the Tenant Distribution Wallet.

Good to know:

• Payouts can be processed automatically or manually via the NovaX dashboard. Contact [e-mail] to configure your preferred payout process.

• Tenant Distribution Wallets can be funded via bank transfers or crypto deposits. Contact [e-mail] for more information.

Create a payout request that will credit a user's balance. All credits will be locked/pending until the funds are confirmed..

post

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

thirdPartyIdstringoptional

Third party unique transaction id.

userIdstringoptional

NovaX user id.

amountnumberoptional

Amount to credit.

walletTypestringoptional

Wallet to credit. e.g. "main", "ton".

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/payout' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyId": "text",
    "userId": "text",
    "amount": 1,
    "walletType": "text"
  }'

200

409

500

200

{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Payout request successfully created.

Create Staking Payout Request

Staking allows users to earn rewards by holding and locking their cryptocurrencies over a period.

Good to know:

• Rewards are calculated based on the asset configuration.

• For more details about staking terms and conditions, please contact [e-mail].

Create a staking payout transaction.

post

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

thirdPartyIdstringoptional

Third party unique transaction id.

userIdstringoptional

NovaX user id.

usdAmountnumberoptional

USD amount to stake.

assetstring · enumoptional

Type of staking - Supported KRU

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/staking/payout' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "thirdPartyId": "text",
    "userId": "text",
    "usdAmount": 1,
    "asset": "KRU"
  }'

200

409

500

200

{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Staking Payout request successfully created.

Revoke Staking Payout

Revoke a staking payout transaction.

post

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Body

transactionIdstringoptional

Transaction Id for the staking request.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/transactions/staking/payout/revoke' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "transactionId": "text"
  }'

200

409

500

200

{
  "transactionId": "text",
  "thirdPartyId": "text"
}

Revoked Staking Transaction Successfully.

Get User Transactions

Fetches a list of transactions for a user.

get

Query parameters

idstringoptional

The Id of the transaction to retrieve.

userIdstringrequired

The Id of the user whose transactions to retrieve.

Header parameters

x-api-keystringrequired

Your unique API Key.

x-api-hashstringrequired

Your API Hash.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/transactions/users?userId=text' \
  --header 'x-api-key: text' \
  --header 'x-api-hash: text'

200

409

500

200

[
  {
    "id": "text",
    "userId": "text",
    "tenantId": "text",
    "status": "text",
    "amount": 1
  }
]

OK