Order creation

TIP

After the order is created, the interface will return the payment link, and the user will enter the cash register through the link to pay.

Interface address

POST https://api.tokenpay.me/v1/transaction/prepayment

Interface parameters

Name

Location

Type

Required

Description

app_id

header

string

Yes

Application ID, example value:8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd

mch_id

body

string

Yes

Merchant ID, example value:1234567890

description

body

string

Order description, example value:recharge

out_trade_no

body

string

Yes

Merchant order number, the merchant generates its own unique order number

expire_second

body

integer

Yes

Expiry date(second), example value:3600

amount

body

number

Yes

Order amount, example value:15000000

chain

body

string

Yes

Owned public chain, example value:TRON

currency

body

string

Yes

to_address

body

string

Collection wallet( Notes: payment wallet is required for the application of monitor order)

attach

body

string

Custom parameter. It returns as-is in the query API and payment notifications and can be used as a custom parameter. In practice, this field is returned only when the payment is complete.

locale

body

string

Language: zh_cn Chinese、 en English.Using cash register will display the default language based on this setting.

notify_url

body

string

return_url

body

string

Return address, when payment is complete or fails, click the return button on the address. And it can be the https or the route of the app.

order_type

body

string

Yes

Payment method, example value: platform_order platform collection

Parameters example

{
  "app_id": "d549a3ac0e4641f998c6675fc539ba21",
  "mch_id": "1234567890",
  "description": "recharge",
  "out_trade_no": "fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb",
  "expire_second": 600,
  "amount": 9,
  "chain": "TRON",
  "currency": "USDT",
  "to_address": "TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w",
  "attach": "anim dolore",
  "locale": "zh_cn",
  "notify_url": "https://xxx/xxx",
  "return_url": "https://xxxx/xxx?id=xxxx",
  "order_type": "platform_order"
}

TIP

Interface return

Name

Type

Description

code

integer

msg

string

Status description

request_id

string

Request ID

data

object

Data object

prepay_id

string

Prepayment ID

Prepayment transaction session ID. It is used for subsequent interface calls, and its value is valid for the expire_second parameter set when the order is created, or you can access the payment_url directly to complete the payment.

payment_url

string

Paymwnt cash register URL

payment_url is to pull up the middle page of the payment cash register, you can complete the payment by visiting this url. You can pay by visiting the url. payment_url is valid for the expire_second parameter set when the order is created.

Return example

{
    "code": 0,
    "msg": "ok",
    "request_id": "9b9e08ab-48e5-4efa-83e7-97e5e3fe3d0c",
    "data": {
        "prepay_id": "15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2",
        "payment_url": "/pay/order?prepay_id=15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2"
    }
}

Example code

curl --location --request POST 'https://api.tokenpay.me/v1/transaction/prepayment' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'

package main

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

func main() {

   url := "https://api.tokenpay.me/v1/transaction/prepayment"
   method := "POST"

   payload := strings.NewReader(`<body data here>`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("Authorization", "<Authorization>")
   req.Header.Add("User-Agent", "tokenpay API (https://tokenpay.me)")
   req.Header.Add("Content-Type", "application/json")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := ioutil.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.tokenpay.me/v1/transaction/prepayment',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: tokenpay API (https://tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.me")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'tokenpay API (https://tokenpay.me)',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/transaction/prepayment", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "<body data here>");
Request request = new Request.Builder()
   .url("https://api.tokenpay.me/v1/transaction/prepayment")
   .method("POST", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

PreviousOrder NextOrder inquiry

Last updated 27 days ago

{ "app_id": "d549a3ac0e4641f998c6675fc539ba21", "mch_id": "1234567890", "description": "recharge", "out_trade_no": "fb72xxxx-xxxx-xxxx-xxxx-xxxx8a7b52cb", "expire_second": 600, "amount": 9, "chain": "TRON", "currency": "USDT", "to_address": "TQjxEW2Z3p9wjoxxxxxxxxgJUrWXBun91w", "attach": "anim dolore", "locale": "zh_cn", "notify_url": "https://xxx/xxx", "return_url": "https://xxxx/xxx?id=xxxx", "order_type": "platform_order" }

{ "code": 0, "msg": "ok", "request_id": "9b9e08ab-48e5-4efa-83e7-97e5e3fe3d0c", "data": { "prepay_id": "15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2", "payment_url": "/pay/order?prepay_id=15809074c5bbc36bce27exxxxxxxxxxxxxxxxxxxxa4ca0a281d7e1260624a1c2" } }

curl --location --request POST 'https://api.tokenpay.me/v1/transaction/prepayment' \ --header 'Authorization: <Authorization>' \ --header 'User-Agent: tokenpay API (https://tokenpay.me)' \ --header 'Content-Type: application/json' \ --data-raw '<body data here>'

package main import ( "fmt" "strings" "net/http" "io/ioutil" ) func main() { url := "https://api.tokenpay.me/v1/transaction/prepayment" method := "POST" payload := strings.NewReader(`<body data here>`) client := &http.Client { } req, err := http.NewRequest(method, url, payload) if err != nil { fmt.Println(err) return } req.Header.Add("Authorization", "<Authorization>") req.Header.Add("User-Agent", "tokenpay API (https://tokenpay.me)") req.Header.Add("Content-Type", "application/json") res, err := client.Do(req) if err != nil { fmt.Println(err) return } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { fmt.Println(err) return } fmt.Println(string(body)) }

<?php $curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => 'https://api.tokenpay.me/v1/transaction/prepayment', CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => '', CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 0, CURLOPT_FOLLOWLOCATION => true, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS =>'<body data here>', CURLOPT_HTTPHEADER => array( 'Authorization: <Authorization>', 'User-Agent: tokenpay API (https://tokenpay.me)', 'Content-Type: application/json' ), )); $response = curl_exec($curl); curl_close($curl); echo $response;

import http.client import json conn = http.client.HTTPSConnection("https://api.tokenpay.me") payload = "<body data here>" headers = { 'Authorization': '<Authorization>', 'User-Agent': 'tokenpay API (https://tokenpay.me)', 'Content-Type': 'application/json' } conn.request("POST", "/v1/transaction/prepayment", payload, headers) res = conn.getresponse() data = res.read() print(data.decode("utf-8"))

OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "<body data here>"); Request request = new Request.Builder() .url("https://api.tokenpay.me/v1/transaction/prepayment") .method("POST", body) .addHeader("Authorization", "<Authorization>") .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)") .addHeader("Content-Type", "application/json") .build(); Response response = client.newCall(request).execute();