Quick Start

Create your Business Client Account

Click the Get Started/Enter App button on the Nodex Pay business client site.

Nodex's business client console is only compatible with PC Browser.

Connect Web3 Wallet and login. The wallet address will be the business client's receiving address.

There is one Nodex Pay account per wallet address. Sign to Login.

Account Settings

Business Client (Integrator) receipt token settings

Select the token to be used to deposit funds to the business client receipt address. You must select one of USDT, USDC, DAI or JPYC.

Nodex Pay converts tokens used for payment into business client receipt tokens at the optimal rate during the payment flow. For example, if you set $USDC as the business client receipt token, and payer makes a payment in $SHIB or $UNI, Nodex Pay will convert those tokens to $USDC at the optimal rate. If the payer agrees to that rate, the settlement is executed. If the payment is successful, $USDC will be credited to the business client's receiving address.

The business client receipt token setting can only be done once per account. It cannot be changed later.

Contract Settings

Moves to the Contract Settings screen.

Create contracts on the network where you want payment to be allowed. Click the Create button.

Pay the GAS fee to create the contract. If successful, a business client-specific contract will be deployed.

Once the contract is created, the contract address will be displayed.

"Received address" and "Cash back rate" are options for advanced users.

Payment Settings

Click the "Payment Settings" tab and set values if you want.

URL to receive Payment Result kickback from Nodex Pay (Optional)

The payment is made through the UI, but after the payment is completed, Nodex Pay re-confirms that the payment has been finalized on the blockchain and notifies the result to the business client.

This is the URL to notify it from Nodex Pay to the Business Client.

If you want to receive notification of a transaction result, please implement api on your business client site and set its url here.

Payment Result API

If you don't implement that API, you will need to confirm transactions by yourself. You can confirm transaction history on Nodex Pay Management screen. Because the payment amount will be credited to your wallet, you can also confirm results by yourself, e.g. via Blockchain Explorer from your wallet address.

Payment success return URL (Optional)

This is the URL that payer returns to the business client's site from the payment success screen.

Payment failure return URL (Optional)

This is the URL that payer returns to the business client's site from the payment failure screen.

Exchange margin rate (Required)

Nodex Pay enables you to allow payers to specify their own payment amount in case such as donation and deposit. When payers specify payment amount, they select Fiat currency first.Exchange Margin Rate is set to the exchange rate at which the Fiat currency specified by the payer is converted into the business client's tokens. For details, please refer to "Exchange Margin Rate" on the following page.

Default value is 0.0.

Supported Currencies (Required)

Set the Fiat currency that can be selected when the payer himself/herself specifies the settlement amount to be paid.

Payment custom icon URL (Optional)

You can set custom logo in the payment page by setting the URL of the logo icon to this field.

Only URL with this extension types are accepted : jpg, png, jpeg, webp.

We recommend you use an image with max size of 80x60px and it should be less than 100kbs for the best experience.

For testing purpose, please visit our testnet to test the displaying behavior of the logo image.

After setting custom logo, It will be shown on the payment page.

Authentication token and hash token

The following screen shows the values required to call the Payment Request API. There is nothing special to do on this screen.

Test with QR Code

QR code payments can be initiated with no code. Click the Create button and the Show QR Code button to generate a QR code.

By calling this QR code with a mobile device, the Nodex Pay screen can be called.

Test with APIs

Call the Payment Request API to obtain the URL to start the payment flow by Nodex Pay. For details, please refer to the following.

Payment Request API

Only with Testnet, you can try the ability to generate payment URLs without the hassle of implementing an API.

Copy and paste the Authentication Token and Hash Token previously described.

The Order Code can be any value that is unique for each payment. You may use the value displayed by default.

Amount may or may not be specified. If you want the user to decide the amount of payment, leave it empty. If you want the user to pay a predetermined amount, such as for the sale of a product, specify Amount.

If you specify Currency, the amount will be automatically converted to the amount of your business client(integrator) receipt token in that currency, and the payment will be generated in that amount. For example, at the time of screen capture below, 100JPY is 0.752306 USDT.

If you want to write a simple code to try it out, see the sample code below

When the business client sets the settlement amount

import requests
import hashlib
  
# api-endpoint
API_ENDPOINT = "https://testnet.app.nodexpay.com/api/v1/payment/receive"

# Authentication Token
AUTH_TOKEN = "YOUR AUTHENTICATION TOKEN";

# Hash Token
HASH_TOKEN = "YOUR HASH TOKEN";
  
# Code set by the business client (Integrator) to uniquely identify the payment
order_code = "GENERATE UNIQUE CODE AND STORE IT ON YOUR DATABASE"

# Set amount and Generate verify token
amount_to_be_charged = 10 # this number must be Zero or more
raw = '{}::{}::{}'.format(order_code, amount_to_be_charged, HASH_TOKEN)
verify_token = hashlib.sha256(raw).hexdigest()

# data to be sent to api
data = {'identification_token':AUTH_TOKEN,
        'order_code':order_code,
        'verify_token':verify_token,
        'amount':amount_to_be_charged}
  
# sending post request and saving response as response object
r = requests.post(url = API_ENDPOINT, data = data)
  
# extracting response text 
payment_flow_starting_url = r.url
print("The URL is:%s"%payment_flow_starting_url)

When the payer determines the settlement amount

import requests
import hashlib
  
# api-endpoint
API_ENDPOINT = "https://testnet.app.nodexpay.com/api/v1/payment/receive"

# Authentication Token
AUTH_TOKEN = "YOUR AUTHENTICATION TOKEN";

# Hash Token
HASH_TOKEN = "YOUR HASH TOKEN";
  
# Code set by the business client (Integrator) to uniquely identify the payment
order_code = "GENERATE UNIQUE CODE AND STORE IT ON YOUR DATABASE"

raw = '{}::::{}'.format(order_code, HASH_TOKEN)
verify_token = hashlib.sha256(raw).hexdigest()

# data to be sent to api
data = {'identification_token':AUTH_TOKEN,
        'order_code':order_code,
        'verify_token':verify_token}
        
# sending post request and saving response as response object
r = requests.post(url = API_ENDPOINT, data = data)
  
# extracting response text 
payment_flow_starting_url = r.url
print("The URL is:%s"%payment_flow_starting_url)

Execute settlement

When the payer accesses the URL obtained in the previous section, the Nodex Pay payment screen will appear.

If the payment URL is generated by calling from the QR code or by making an API call without specifying the amount, a screen where the user determines the amount to be paid will be displayed, as shown below.

If the payment URL is generated by an API call with the amount specified, the following screen will be displayed with the payment amount determined.

Connect the web3 wallet.

Select the network and token for payment.

The payment amount of the token for payment is displayed as below. It is automatically calculated from business client receipt amount as an optimal rate at the time.

Click Pay to execute settlement with the business client-specific contract. Click Reject to cancel.

Wait a moment to finalize transaction.

If the business client set "Payment success return URL", screen below is displayed and finishes payment process. By clicking "Back to Payee's Services", the payer redirects to the Payment success return URL.

When the payer determines the settlement amount

When the payer accesses the URL obtained in the previous section, the Nodex Pay payment screen is displayed.

Select the Fiat currency and enter the settlement amount in that currency. The payment amount in business client receiving tokens will then be automatically calculated. If you agree with the exchange rate, click Go Payment to proceed with the payment.

The flow after this is exactly the same as "When the business client sets the settlement amount".

Confirm payments

Confirm payments on Nodex Pay business client site

Business Clients can confirm payments on Nodex Pay business client site.

See Dashboard to confirm summary.

See History to review each payment. To confirm transaction detail on Blockchain explorers, click Transaction ID.

If business client set Successful notify URL, Nodex Pay notifies that transaction is finalized via POST.

Confirm payments on Explorer

Business Clients can also confirm payments on the explorers of each chain.

Open the explorers page, search the transaction ID that you want to confirm.

Check the Transaction Hash is same with the Transation ID.

If Status is "Success", payment is completed.

Here are the URLs for the explorers of each chain:

• Ethereum：https://etherscan.io/

• BNB Chain：https://bscscan.com/

• Polygon：https://polygonscan.com/

• Avalanche C-Chain：https://snowtrace.io/

• Astar Network : https://astar.subscan.io/

• Arbitrum One : https://arbiscan.io/

• OP Mainnet : https://optimism.blockscout.com/

• Mantle Network : https://explorer.mantle.xyz/

• Oasys : https://explorer.oasys.games/

• Base : https://basescan.org/

• Solana : https://explorer.solana.com/

• Kaia : https://kaiascan.io/

Confirm payments by JSON-RPC API

Business Clients can also confirm payments by JSON-RPC API.

Please refer to the following link.

JSON-RPC API | ethereum.orgethereum.org

To eliminate risks related with security and block fork (a.k.a reorg), you should check recursive block confirmation.

Please confirm that the amount has actually been deposited to the business client receipt address as well.