Create Native Pre-order

Create prepay order

curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/transactions/native \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchantTradeNo": "118223456797",
  "env": {
    "terminalType": "APP"
  },
  "goods": {
    "goodsName": "NF2T",
    "goodsDetail": "nef-book"
  }
}
'

import requests

url = "https://openplatform.gateapi.io/v1/pay/transactions/native"

payload = {
    "merchantTradeNo": "118223456797",
    "env": { "terminalType": "APP" },
    "goods": {
        "goodsName": "NF2T",
        "goodsDetail": "nef-book"
    }
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    merchantTradeNo: '118223456797',
    env: {terminalType: 'APP'},
    goods: {goodsName: 'NF2T', goodsDetail: 'nef-book'}
  })
};

fetch('https://openplatform.gateapi.io/v1/pay/transactions/native', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/v1/pay/transactions/native",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'merchantTradeNo' => '118223456797',
    'env' => [
        'terminalType' => 'APP'
    ],
    'goods' => [
        'goodsName' => 'NF2T',
        'goodsDetail' => 'nef-book'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/v1/pay/transactions/native")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/v1/pay/transactions/native"

	payload := strings.NewReader("{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/v1/pay/transactions/native")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "prepayId": "50913213697495040",
    "terminalType": "APP",
    "expireTime": 1674100394000,
    "qrContent": "http://openplatform.gate.io/qr/AjQHJ56mDQ26dtx5ftspl9usV9tlIA8iom35toXhX7Y=",
    "location": "https://114.55.238.130:13555/webpay?prepayid=50913213697495040"
  }
}

POST

pay

transactions

native

Create prepay order

curl --request POST \
  --url https://openplatform.gateapi.io/v1/pay/transactions/native \
  --header 'Content-Type: application/json' \
  --header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
  --header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
  --header 'X-GatePay-Signature: <x-gatepay-signature>' \
  --header 'X-GatePay-Timestamp: <x-gatepay-timestamp>' \
  --data '
{
  "merchantTradeNo": "118223456797",
  "env": {
    "terminalType": "APP"
  },
  "goods": {
    "goodsName": "NF2T",
    "goodsDetail": "nef-book"
  }
}
'

import requests

url = "https://openplatform.gateapi.io/v1/pay/transactions/native"

payload = {
    "merchantTradeNo": "118223456797",
    "env": { "terminalType": "APP" },
    "goods": {
        "goodsName": "NF2T",
        "goodsDetail": "nef-book"
    }
}
headers = {
    "X-GatePay-Certificate-ClientId": "<x-gatepay-certificate-clientid>",
    "X-GatePay-Signature": "<x-gatepay-signature>",
    "X-GatePay-Timestamp": "<x-gatepay-timestamp>",
    "X-GatePay-Nonce": "<x-gatepay-nonce>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-GatePay-Certificate-ClientId': '<x-gatepay-certificate-clientid>',
    'X-GatePay-Signature': '<x-gatepay-signature>',
    'X-GatePay-Timestamp': '<x-gatepay-timestamp>',
    'X-GatePay-Nonce': '<x-gatepay-nonce>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    merchantTradeNo: '118223456797',
    env: {terminalType: 'APP'},
    goods: {goodsName: 'NF2T', goodsDetail: 'nef-book'}
  })
};

fetch('https://openplatform.gateapi.io/v1/pay/transactions/native', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://openplatform.gateapi.io/v1/pay/transactions/native",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'merchantTradeNo' => '118223456797',
    'env' => [
        'terminalType' => 'APP'
    ],
    'goods' => [
        'goodsName' => 'NF2T',
        'goodsDetail' => 'nef-book'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
    "X-GatePay-Nonce: <x-gatepay-nonce>",
    "X-GatePay-Signature: <x-gatepay-signature>",
    "X-GatePay-Timestamp: <x-gatepay-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://openplatform.gateapi.io/v1/pay/transactions/native")
  .header("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
  .header("X-GatePay-Signature", "<x-gatepay-signature>")
  .header("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
  .header("X-GatePay-Nonce", "<x-gatepay-nonce>")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}")
  .asString();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://openplatform.gateapi.io/v1/pay/transactions/native"

	payload := strings.NewReader("{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-GatePay-Certificate-ClientId", "<x-gatepay-certificate-clientid>")
	req.Header.Add("X-GatePay-Signature", "<x-gatepay-signature>")
	req.Header.Add("X-GatePay-Timestamp", "<x-gatepay-timestamp>")
	req.Header.Add("X-GatePay-Nonce", "<x-gatepay-nonce>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://openplatform.gateapi.io/v1/pay/transactions/native")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-GatePay-Certificate-ClientId"] = '<x-gatepay-certificate-clientid>'
request["X-GatePay-Signature"] = '<x-gatepay-signature>'
request["X-GatePay-Timestamp"] = '<x-gatepay-timestamp>'
request["X-GatePay-Nonce"] = '<x-gatepay-nonce>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"merchantTradeNo\": \"118223456797\",\n  \"env\": {\n    \"terminalType\": \"APP\"\n  },\n  \"goods\": {\n    \"goodsName\": \"NF2T\",\n    \"goodsDetail\": \"nef-book\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "SUCCESS",
  "code": "000000",
  "errorMessage": "",
  "data": {
    "prepayId": "50913213697495040",
    "terminalType": "APP",
    "expireTime": 1674100394000,
    "qrContent": "http://openplatform.gate.io/qr/AjQHJ56mDQ26dtx5ftspl9usV9tlIA8iom35toXhX7Y=",
    "location": "https://114.55.238.130:13555/webpay?prepayid=50913213697495040"
  }
}

Overview

This page documents the POST /v1/pay/transactions/native endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

Notes

Authentication uses the standard GatePay signed headers.
This page documents the standard merchant endpoint.
For shared signing rules, see /api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId

string

required

Merchant client ID, obtained from GatePay platform

Example:

"4186d0c6-6a35-55a9-8dc6-5312769dbff8"

X-GatePay-Signature

string

required

HMAC-SHA512 signature for request validation

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

X-GatePay-Timestamp

string

required

Millisecond timestamp; the difference from server time must not exceed 30 seconds.

Example:

"1672905655498"

X-GatePay-Nonce

string

required

Random nonce for replay attack prevention

Example:

"3525756760"

Body

application/json

Request body for creating a Web payment prepay order.

merchantTradeNo

string

required

Merchant order number, up to 100 bytes.

env

object

required

Transaction source information.

Show child attributes

goods

object

required

Goods information.

Show child attributes

currency

string

Order currency, uppercase, such as USDT, BTC, etc.

orderAmount

string

Order amount, ranging from [0.0001, 5000000].

fiatCurrency

string

Fiat order currency in uppercase, such as EUR, GBP, USD, CNY, JPY, AUD, CAD, CHF.

fiatAmount

string

Fiat order amount. Minimum 0.01 with maximum precision of 2 decimal places. When creating an order, you can use either crypto currency and amount, or fiat currency and amount. If fiat is used, the system queries the real-time exchange rate at order creation and converts it to crypto for collection.

orderExpireTime

integer<int64>

Order expiration time, UTC timestamp in milliseconds. Defaults to 1 hour if omitted. If the provided value exceeds current time + 1 day, it is truncated to current time + 1 day.

returnUrl

string

The return URL for the order after successful payment, up to 256 characters long.

cancelUrl

string

The return URL for the order after payment failure, up to 256 characters long.

channelId

string

Client name.

sourceType

string

Source type of the order.

Response

200 - application/json

Prepay order created successfully

Response body for creating a prepay order.

status

string

required

SUCCESS or FAIL.

code

string

required

Error code.

errorMessage

string

Error message.

data

object

Prepay order data.

Show child attributes

⌘I

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes