Payment Request API

API Spec

Request to create a payment from the Business Client to the Nodex Pay

POST https://app.nodexpay.com/api/v1/payment/receive

Request Body

Name

Type

Description

identification_token*

string

"Authentication Token" can be obtained from the Business Client Management screen

order_code*

string

The value set by the business client to uniquely identify the payment.

Limit to 255 single-byte characters.

verify_token*

string

The value obtained by hashing the string 'order_code::amount::Hash Token' with SHA256 if amount is not null.

In case amount is null, hashing the string 'order_code::::Hash Token' with SHA256.

"Hash Token" can be obtained from the Business Client Management screen

amount

number, float

The amount to be charged by your deposit currency. It is Zero or more.

If a currency is specified in amount_type field, the amount in that currency is converted to the amount in the business client receipt token to generate the settlement data.

If amount_type is not specified, this value is set as the amount of the business client receipt token.

If the payer determines the amount to be paid, this field can be null. So this field is optional.

When specifying this field, values from 0.000001 to 100000000 can be specified.

color_theme

string

'dark' or 'light'

amount_type

string

"USD", "JPY", "EUR", "AED", "SGD", "HKD", "CAD", "IDR", "PHP", "INR", "KRW"

If a currency is specified in this field, the amount field value in this currency is converted to the amount in the business client receipt token to generate the settlement data.

If this field value is not specified, the amount field value is set as the amount of the business client receipt token.

uimode

string

'switchable'

Set in case that you implement Window widget.

ext_description

string

Sets the description of ext_reserved.

Limit to 100 characters.

deadline

int

You can specify the expiration date of the payment.

To specify an arbitrary expiration date, set this parameter to a value in unixtime format.

If this parameter is not specified, the system automatically sets the default value.

The default value is set to the date and time one hour after the API request.

description

string

Set in case you want to show a custom message in payment page. Limit to 100 characters.

Returning Payment process URL on nodexpay.com The payer is redirected to this URL to make the payment.

{
    "url": "https://app.nodexpay.com/payment/PAYMENT_TOKEN_ISSUED_BY_NODEX",
    "token": "PAYMENT_TOKEN_ISSUED_BY_NODEX",
    "ext_reserved": "",
    "ext_description": ""
}

In case you input ext_reserved and ext_description.

{
    "url": "https://app.nodexpay.com/payment/PAYMENT_TOKEN_ISSUED_BY_NODEX",
    "token": "PAYMENT_TOKEN_ISSUED_BY_NODEX",
    "ext_reserved": "0x00000000000000000............",
    "ext_description": "This value you input as ext_description"
}

{ 
    "status": "400", 
    "data: { errors: [ The following ERROR NUMBER ] 
}

RECEIVED_IDENTIFICATION_TOKEN_EMPTY = 2010;

RECEIVED_IDENTIFICATION_TOKEN_INVALID = 2011;

RECEIVED_ORDER_CODE_EMPTY = 2020;

RECEIVED_ORDER_CODE_DUPLICATE = 2021;

RECEIVED_AMOUNT_INVALID_FORMAT = 2030;

RECEIVED_COLOR_THEME_INVALID_FORMAT = 2050;

RECEIVED_VERIFY_TOKEN_EMPTY = 2060;

RECEIVED_VERIFY_TOKEN_INVALID = 2061;

RECEIVED_INVALID_CALLBACK_URL = 2040;

RECEIVED_INVALID_DEADLINE = 2460;

CONTRACT_PAYMENT_TOKEN_EMPTY = 2070;

CONTRACT_NETWORK_TYPE_EMPTY = 2080;

CONTRACT_NETWORK_TYPE_INVALID_VALUE = 2081;

CONTRACT_ADDRESS_EMPTY = 2090;

RECEIVED_EXT_RESERVED_INVALID = 2101;

RECEIVED_EXT_DESCRIPTION_INVALID = 2102;

PUBLISH_TRANSACTION_DUPLICATE = 2110;

PUBLISH_TRANSACTION_PAYMENT_TOKEN_EMPTY = 2120;

UPDATE_TRANSACTION_PAYMENT_TOKEN_EMPTY = 2130;

UPDATE_TRANSACTION_EMAIL_INVALID_FORMAT = 2140;

UPDATE_TRANSACTION_EXCHANGED_AMOUNT_INVALID_FORMAT = 2150;

UPDATE_TRANSACTION_BASE_CURRENCY_UNMATCH = 2160;

UPDATE_TRANSACTION_BASE_AMOUNT_INVALID_FORMAT = 2170;

UPDATE_TRANSACTION_RATE_INVALID_FORMAT = 2180;

UPDATE_TRANSACTION_MARGIN_RATE_INVALID_FORMAT = 2190;

UPDATE_TRANSACTION_NETWORK_TYPE_INVALID_FORMAT = 2210;

UPDATE_TRANSACTION_CONTRACT_ADDRESS_INVALID_FORMAT = 2220;

UPDATE_TRANSACTION_WALLET_ADDRESS_INVALID_FORMAT = 2230;

UPDATE_TRANSACTION_PAY_SYMBOL_INVALID_FORMAT = 2240;

UPDATE_TRANSACTION_PAY_AMOUNT_INVALID_FORMAT = 2250;

UPDATE_TRANSACTION_TRANSACTION_ADDRESS_INVALID_FORMAT = 2260;

UPDATE_TRANSACTION_TARGET_NOT_EXIST = 2270;

UPDATE_TRANSACTION_COMBINATION_INVALID = 2280;

UPDATE_TRANSACTION_TARGET_STATE_MISMATCH = 2290;

PAYMENT_TRANSACTION_UPDATE_PAYMENT_TOKEN_EMPTY = 2310;

GET_PAYMENT_RECEIVE_INFO_PAYMENT_TOKEN_EMPTY = 2320;

GET_EXCHANGE_RATE_PAYMENT_TOKEN_EMPTY = 2330;

GET_EXCHANGE_RATE_EXCHANGE_SETTING_INVALID = 2331;

GET_EXCHANGE_RATE_LEGAL_CURRENCY_EMPTY = 2340;

GET_EXCHANGE_RATE_LEGAL_CURRENCY_INVALID = 2341;

GET_EXCHANGE_RATE_AMOUNT_INVALID = 2350;

GET_PAYMENT_COMPLETED_URL_SETTING_INVALID_PAYMENT_TOKEN = 2360;

RECEIVE_CONTRACT_UNPUBLISHED = 2370;

GET_PAYMENT_AVAILABLE_NETWORK_PAYMENT_TOKEN_INVALID = 2380;

GET_PAYMENT_NORMAL_TRANSACTION_PAYMENT_TOKEN_INVALID = 2390;

GET_PAYMENT_NORMAL_TRANSACTION_UNPUBLISHED = 2410;

GET_GENERATED_DONATION_ORDER_CODE_IDENTIFICATION_TOKEN_EMPTY = 2420;

GET_GENERATED_DONATION_ORDER_CODE_DONATION_FOR_INVALID_FORMAT = 2430;

GET_MERCHANT_CONTRACT_STATUS_PAYMEMT_TOKEN_NOT_VALID = 2431;

REFRESH_PAYMENT_TOKEN_DATA_NOT_EXIST = 2440;

GET_NORMAL_TRANSACTION_DEVICE_MATCH_STATUS_DEVICE_ID_INVALID_FORMAT = 2450;

Sample Codes

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)

package main

import (
  "crypto/sha256"
  "encoding/hex"
  "encoding/json"
  "fmt"
  "io/ioutil"
  "net/http"
  "net/url"
)

func main() {
  // 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.00 // this number must be Zero or more
  raw := fmt.Sprintf("%s::%f::%s", ORDER_CODE, amount_to_be_charged, HASH_TOKEN)
  verify_token := sha256.Sum256([]byte(raw))

  // data to be sent to api
  data := url.Values{}
  data.Add("identification_token", AUTH_TOKEN)
  data.Add("order_code", ORDER_CODE)
  data.Add("verify_token", hex.EncodeToString(verify_token[:]))
  data.Add("amount", fmt.Sprintf("%f", amount_to_be_charged))

  // sending post request and saving response as response object
  res, _ := http.PostForm(API_ENDPOINT, data)
  defer res.Body.Close()

  body, _ := ioutil.ReadAll(res.Body)

  var responseObj interface{}
  _ = json.Unmarshal(body, &responseObj)

  url := responseObj.(map[string]interface{})["url"]
  if url != nil {
    fmt.Printf("url: %s\n", url)
  } else {
    err := responseObj.(map[string]interface{})["errors"]
    fmt.Println(err)
  }
}

<?php

// api-endpoint
define("API_ENDPOINT", "https://testnet.app.nodexpay.com/api/v1/payment/receive");
// Authentication Token
define("AUTH_TOKEN", "YOUR AUTHENTICATION TOKEN");
// Hash Token
define("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
$amount_to_be_charged = 10; // this number must be Zero or more

// Generate verify token
$generate_params = [
  "order_code" => $order_code,
  "amount" => $amount_to_be_charged,
  "hash_token" => HASH_TOKEN
];
$raw = implode("::", $generate_params);
$verify_token = hash("sha256", $raw);

// Data to be sent to api
$request_params = [
  "identification_token" => AUTH_TOKEN,
  "order_code" => $order_code,
  "amount" => $amount_to_be_charged,
  "verify_token" => $verify_token
];

// Sending post request and saving response as response object
$curl_handler = curl_init(API_ENDPOINT);
curl_setopt($curl_handler, CURLOPT_POST, true);
curl_setopt($curl_handler, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($curl_handler, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl_handler, CURLOPT_POSTFIELDS, $request_params);
$response = curl_exec($curl_handler);
curl_close($curl_handler);

// Extracting response text
$data = json_decode($response);
echo "The URL is:{$data->url}";

require 'net/http'
require 'digest'
require 'json'

# api-endpoint
API_ENDPOINT  = URI.parse('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 = "#{order_code}::#{amount_to_be_charged}::#{HASH_TOKEN}"
verify_token = Digest::SHA256.hexdigest(raw)

# 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 = Net::HTTP.post_form(API_ENDPOINT, data)

# extracting response text
payment_flow_starting_url = JSON.parse(r.body)['url']
p "The URL is: #{payment_flow_starting_url}"ruby

import java.net.URL;
import java.net.HttpURLConnection;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.BufferedWriter;
import java.io.BufferedReader;
import java.io.InputStreamReader;

import java.security.MessageDigest;
import org.json.JSONObject; // Note: that if "org.json" library is not present, a compile error will occur

public class GeneratePaymentURL {
    public static void main(String[] args) {
        // api-endpoint
        final String API_ENDPOINT = "https://testnet.nodexpay.app.com/api/v1/payment/receive";

        // Authentication Token
        final String AUTH_TOKEN = "YOUR AUTHENTICATION TOKEN";

        // Hash Token
        final String HASH_TOKEN = "YOUR HASH TOKEN";

        // Code set by the business client (Integrator) to uniquely identify the payment
        String order_code = "GENERATE UNIQUE CODE AND STORE IT ON YOUR DATABASE";

        // Set amount and Generate verify token
        Float amount_to_be_charged = 10.0f;

        try{
            // generate verify token
            String raw = String.format("%s::%.2f::%s", 
                                    order_code, amount_to_be_charged, HASH_TOKEN);
            MessageDigest md = MessageDigest.getInstance("SHA-256");
            md.update(raw.getBytes());
            byte[] verify_byte = md.digest();

            StringBuilder verify_token = new StringBuilder(2 * verify_byte.length);
            for (byte b: verify_byte) {
                verify_token.append(String.format("%02x", b&0xff));
            }

            // POST
            URL url = new URL(API_ENDPOINT);
            HttpURLConnection conn = (HttpURLConnection) url.openConnection();
            conn.setDoOutput(true); // allow POST
            conn.setRequestMethod("POST");
            conn.connect();

            // POST params
            String params = String.format("identification_token=%s&order_code=%s&verify_token=%s&amount=%.2f", 
                                        AUTH_TOKEN, order_code, verify_token, amount_to_be_charged);

            OutputStream os = conn.getOutputStream();
            BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os));
            writer.write(params);
            writer.flush();
            writer.close();
            os.close();

            BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream()));
            StringBuilder sb = new StringBuilder();
            String line;
            while ((line = reader.readLine()) != null) {
                sb.append(line);
            }
            String result = sb.toString();

            JSONObject obj = new JSONObject(result);
            String payment_url = obj.getString("url");

            System.out.println("The URL is: " + payment_url);

        } catch (Exception e) {
            System.out.println(e);
        }
    }
}

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)

PreviousAPIs NextPayment Result API

Last updated 5 months ago

import java.net.URL; import java.net.HttpURLConnection; import java.io.OutputStream; import java.io.OutputStreamWriter; import java.io.BufferedWriter; import java.io.BufferedReader; import java.io.InputStreamReader; import java.security.MessageDigest; import org.json.JSONObject; // Note: that if "org.json" library is not present, a compile error will occur public class GeneratePaymentURL { public static void main(String[] args) { // api-endpoint final String API_ENDPOINT = "https://testnet.nodexpay.app.com/api/v1/payment/receive"; // Authentication Token final String AUTH_TOKEN = "YOUR AUTHENTICATION TOKEN"; // Hash Token final String HASH_TOKEN = "YOUR HASH TOKEN"; // Code set by the business client (Integrator) to uniquely identify the payment String order_code = "GENERATE UNIQUE CODE AND STORE IT ON YOUR DATABASE"; // Set amount and Generate verify token Float amount_to_be_charged = 10.0f; try{ // generate verify token String raw = String.format("%s::%.2f::%s", order_code, amount_to_be_charged, HASH_TOKEN); MessageDigest md = MessageDigest.getInstance("SHA-256"); md.update(raw.getBytes()); byte[] verify_byte = md.digest(); StringBuilder verify_token = new StringBuilder(2 * verify_byte.length); for (byte b: verify_byte) { verify_token.append(String.format("%02x", b&0xff)); } // POST URL url = new URL(API_ENDPOINT); HttpURLConnection conn = (HttpURLConnection) url.openConnection(); conn.setDoOutput(true); // allow POST conn.setRequestMethod("POST"); conn.connect(); // POST params String params = String.format("identification_token=%s&order_code=%s&verify_token=%s&amount=%.2f", AUTH_TOKEN, order_code, verify_token, amount_to_be_charged); OutputStream os = conn.getOutputStream(); BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(os)); writer.write(params); writer.flush(); writer.close(); os.close(); BufferedReader reader = new BufferedReader(new InputStreamReader(conn.getInputStream())); StringBuilder sb = new StringBuilder(); String line; while ((line = reader.readLine()) != null) { sb.append(line); } String result = sb.toString(); JSONObject obj = new JSONObject(result); String payment_url = obj.getString("url"); System.out.println("The URL is: " + payment_url); } catch (Exception e) { System.out.println(e); } } }