Batch Query Gift Cards

Batch query gift cards

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

pay

gift

batch

query

Batch query gift cards

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
      }
    ]
  }
}

Overview

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

Notes

Authentication uses the standard GatePay signed headers.
Filter by batch ID, creation time range, or both. When both are provided, both filters apply.
For shared signing rules, see /global/api-reference/version/100/en/common/securityAndSignature.

Headers

X-GatePay-Certificate-ClientId

string

required

Merchant client ID

Example:

"mZ96D37oKk-HrWJc"

X-GatePay-Signature

string

required

Signature

Example:

"b8c4705ff4c1357f2a27925dd180c1e1f4a244148f312a2dee5afbcc6f4b150e9ffceee455c5a298f895d43a64ee829eebdfd262539d45c41f7aee4336fd8c8c"

X-GatePay-Timestamp

string

required

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

Example:

"1738934053475"

X-GatePay-Nonce

string

required

Nonce

Example:

"5417061546"

Body

application/json

Batch query parameters. Provide batch_id or a complete start_time/end_time range.

Option 1
Option 2

Provide batch_id or a complete start_time/end_time range.

batch_id

string

required

Gift card batch ID. The API uses an exact match. When combined with a time range, both filters apply.

Required string length: 1 - 64

Example:

"G545273793309741056"

start_time

integer<int64>

Inclusive creation time range start as a Unix timestamp in milliseconds. Must be provided with end_time.

Required range: x >= 0

Example:

1791916618083

end_time

integer<int64>

Inclusive creation time range end as a Unix timestamp in milliseconds. A single query cannot span more than 31 days.

Required range: x >= 0

Example:

1791939618083

page

integer

default:1

Page number starting from 1.

Required range: x >= 1

Example:

1

page_size

integer

default:20

Number of records per page. The default is 20 and the maximum is 100.

Required range: 1 <= x <= 100

Example:

20

Response

200 - application/json

Query successful

status

string

Response status

Example:

"SUCCESS"

code

string

Response code. 000000 indicates success.

Example:

"000000"

errorMessage

string

Error message. Empty on success.

Example:

""

data

object

Show child attributes

Common

Balance

Institution

Payment

OTC

Convert

Payout

Gift Card

Subscription

Reconciliation

Notifications

Overview

Notes

Headers

Body

Response

​Overview

​Notes

Headers

Body

Response

Overview

Notes