Overview

This Document includes APIs for both Payment Gateway and Payment Processor. If you are a merchant,please use the Payment Gateway API for integration If you are an acquirer,please used the Payment Processor API for integration.

1.Payment Gateway

Abstract

The chapter describes the API of online service which is based on HTTPS protocol.The API is organized around Payment Gateway. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication.

Target audience: Experienced payment developer.

Key Benefits:

Fast setup & integration.
Very secure.
PCIDSS requirements and compliances are handled by JS SDK.

Base

Apply To Service Provider For The Required Parameters

Please apply to the payment process service provider for the required parameters before API integration. The online service system includes a developing and production environment. Obviously, developers should develop on the "develop" environment during the development and test.

Required Parameter List:

Parameter	Description
Domain	The online service system includes a developing and production environment. Obviously, developers should develop on the "develop" environment during the development and test.
login email	`username` It is used for Login API.
Password	`password` It is used for Login API.
Store ID	`{store_id}` It is used for URL
APP-ID	It is used for Webhook
secret_key	It is used for Webhook

Communication

HTTPS porctocol is used in Payment Gateway Server.

The requests are required to send same header items as below:

Parameter	Type	Usage	Description
Content-Type	String	M	Constant. Value example: “application/json; charset=UTF-8”
X-USER-DEVICE-ID	String	O	If the payment is made on the POS device, this field should be POS Device SN. If the payment is made on the website, this field should be fingerprint
X-USER-ACCESS-TOKEN	String	M	Access token, could be null while doing Login. Value example: “q8s4qg53s8g99grszad9wusds72z9n6”
X-CLIENT-IP	String	M	1.The client ID must be the IP address of the consumer. 2.It is client ip and the field must be required for pre-create api. Pre-create and called JS SDK should be from the same client ip.
X-APP-ID	String	O	The appid is provided by Payment Process Service Provider when applying for merchants Value Example:HxEAHKIAAAF5IKE0RZ3MBeHt4WEUKWbBzyPa_WQLseDAcqdDtZ-QAPP-ID

Time Format

Parameter	example
date_time	2025-08-12T07:03:01+00:00
created_at	2025-05-16T07:53:48.649Z
update_at	2025-05-16T07:53:48.649Z
complete_at	2025-05-16T07:53:48.649Z
acquirer_txn_date_time	2025-08-12T07:03:01+00:00
gateway_clearance_at	2025-05-16T07:53:48.649Z
acquirer_clearance_at	2025-05-16T07:53:48.649Z

Description

The API is used to logging in online service with a valid username and password. An access token will be returned it is mandatory to save it for future use. Any new HTTPS requests should contain the access token in Https headers, or 401 error occurs.

1.The login email, password and the Store ID are provided by payment process service provider when applying for merchants.

2.Validity of Access Token: Default permanent validity. If doing Login to get new access token, the new access token will be valid, the old access token will be invalid.

POST https://{Domain}/gateway/v3/login

The Login command request like this:

curl --location --request POST 'https://{Domain}/gateway/v3/login' \
--header 'Content-Type: application/json' \
--data-raw '{
   "username":"abcdtest@test.com",
    "password":"123456"
    }'

The Login command response like this:

{

  "access_token": "i2ctfruzrda0efqlu47dnu2zwha97o6",  
   //* The access_token value is very important and needs to be saved

    }

Parameters Description