批量查询礼品卡
curl --request POST \
--url https://openplatform.gateapi.io/v1/pay/gift/batch/query \
--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 '
{
"batch_id": "G545273793309741056",
"start_time": 1791916618083,
"end_time": 1791939618083
}
'import requests
url = "https://openplatform.gateapi.io/v1/pay/gift/batch/query"
payload = {
"batch_id": "G545273793309741056",
"start_time": 1791916618083,
"end_time": 1791939618083
}
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({
batch_id: 'G545273793309741056',
start_time: 1791916618083,
end_time: 1791939618083
})
};
fetch('https://openplatform.gateapi.io/v1/pay/gift/batch/query', 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/gift/batch/query",
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([
'batch_id' => 'G545273793309741056',
'start_time' => 1791916618083,
'end_time' => 1791939618083
]),
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/gift/batch/query")
.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 \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/v1/pay/gift/batch/query"
payload := strings.NewReader("{\n \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\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/gift/batch/query")
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 \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"total": 1,
"has_more": false,
"list": [
{
"batch_id": "G545273793309741056",
"card_num": "5607423016280059",
"key": "EXAMPLE-REDEEM-CODE",
"title": "Festival Gift Card",
"creator_name": "GateUser-8118f6f8",
"amount": "0.99",
"status": "3",
"currency": "USDT",
"card_temp_id": "346749173549240320",
"create_time": 1791920000000,
"exchange_uid": 39992131,
"exchange_time": 1791923600000
}
]
}
}礼品卡
批量查询礼品卡
根据礼品卡批次号或创建时间范围分页查询当前商户创建的礼品卡。批次号与时间范围同时传入时取交集。
POST
/
v1
/
pay
/
gift
/
batch
/
query
批量查询礼品卡
curl --request POST \
--url https://openplatform.gateapi.io/v1/pay/gift/batch/query \
--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 '
{
"batch_id": "G545273793309741056",
"start_time": 1791916618083,
"end_time": 1791939618083
}
'import requests
url = "https://openplatform.gateapi.io/v1/pay/gift/batch/query"
payload = {
"batch_id": "G545273793309741056",
"start_time": 1791916618083,
"end_time": 1791939618083
}
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({
batch_id: 'G545273793309741056',
start_time: 1791916618083,
end_time: 1791939618083
})
};
fetch('https://openplatform.gateapi.io/v1/pay/gift/batch/query', 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/gift/batch/query",
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([
'batch_id' => 'G545273793309741056',
'start_time' => 1791916618083,
'end_time' => 1791939618083
]),
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/gift/batch/query")
.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 \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/v1/pay/gift/batch/query"
payload := strings.NewReader("{\n \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\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/gift/batch/query")
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 \"batch_id\": \"G545273793309741056\",\n \"start_time\": 1791916618083,\n \"end_time\": 1791939618083\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"total": 1,
"has_more": false,
"list": [
{
"batch_id": "G545273793309741056",
"card_num": "5607423016280059",
"key": "EXAMPLE-REDEEM-CODE",
"title": "Festival Gift Card",
"creator_name": "GateUser-8118f6f8",
"amount": "0.99",
"status": "3",
"currency": "USDT",
"card_temp_id": "346749173549240320",
"create_time": 1791920000000,
"exchange_uid": 39992131,
"exchange_time": 1791923600000
}
]
}
}概述
本页说明POST /v1/pay/gift/batch/query 接口。完整的请求参数、响应结构与示例由上方关联的 OpenAPI 定义渲染。
说明
- 认证方式使用 GatePay 标准签名请求头。
- 支持按批次号、创建时间范围或两者组合过滤;同时传入时取交集。
- 通用签名规则请参见 /global/api-reference/version/100/cn/common/securityAndSignature。
请求头
商户客户端ID
示例:
"mZ96D37oKk-HrWJc"
签名
示例:
"b8c4705ff4c1357f2a27925dd180c1e1f4a244148f312a2dee5afbcc6f4b150e9ffceee455c5a298f895d43a64ee829eebdfd262539d45c41f7aee4336fd8c8c"
毫秒级时间戳,与服务端时间偏差不得超过30秒
示例:
"1738934053475"
随机数
示例:
"5417061546"
请求体
application/json
批量查询请求参数。batch_id 或完整的 start_time/end_time 时间范围至少传一个。
- Option 1
- Option 2
batch_id 或完整的 start_time/end_time 时间范围至少传一个。
礼品卡批次号。传入后按批次精确过滤;与时间范围同时传入时取交集。
Required string length:
1 - 64示例:
"G545273793309741056"
创建时间范围起点,毫秒级 Unix 时间戳,闭区间。必须与 end_time 成对传入。
必填范围:
x >= 0示例:
1791916618083
创建时间范围终点,毫秒级 Unix 时间戳,闭区间。单次查询跨度不得超过 31 天。
必填范围:
x >= 0示例:
1791939618083
页码,从 1 开始。
必填范围:
x >= 1示例:
1
每页条数,默认 20,最大 100。
必填范围:
1 <= x <= 100示例:
20

