↔️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 [email protected] to configure your preferred payout process.

  • Tenant Distribution Wallets can be funded via bank transfers or crypto deposits. Contact [email protected] 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
200

Payout request successfully created.

application/json
post
POST /transactions/payout HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "thirdPartyId": "text",
  "userId": "text",
  "amount": 1,
  "walletType": "text"
}
{
  "transactionId": "text",
  "thirdPartyId": "text"
}

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 [email protected].

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

Possible values:
Responses
200

Staking Payout request successfully created.

application/json
post
POST /transactions/staking/payout HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "thirdPartyId": "text",
  "userId": "text",
  "usdAmount": 1,
  "asset": "KRU"
}
{
  "transactionId": "text",
  "thirdPartyId": "text"
}

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
200

Revoked Staking Transaction Successfully.

application/json
post
POST /transactions/staking/payout/revoke HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Content-Type: application/json
Accept: */*
Content-Length: 24

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

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
200

OK

application/json
get
GET /transactions/users?userId=text HTTP/1.1
Host: 
x-api-key: text
x-api-hash: text
Accept: */*

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

Last updated