curl --request GET \
--url https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'import requests
url = "https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details"
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>",
"X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
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>',
'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>'
}
};
fetch('https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details', 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/payment/open/institution/v2/pay/refund/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
"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.get("https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details")
.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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details"
req, _ := http.NewRequest("GET", url, nil)
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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
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/payment/open/institution/v2/pay/refund/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.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["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"refundRequestId": "202508271923022",
"gateRefundId": "1991045981847818240",
"refundId": "1991045981847818240",
"orderId": "35214673103159414",
"merchantTradeNo": "163",
"createTime": 1724769600000,
"transactTime": 1724769660000,
"transactionId": "1991045981847818241",
"txHash": "0x1234...",
"orderAmount": "10",
"orderCurrency": "USDT",
"requestAmount": "0.018",
"requestCurrency": "USDT",
"amount": "0.018",
"currency": "USDT",
"status": "SUCCESS",
"remark": "bourne-test",
"refund_style": 2,
"refund_pay_channel": 1,
"refund_address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"refund_chain": "ETH",
"refund_bear_type": 1,
"refund_amount_type": 2,
"refund_account_type": 1,
"refund_gas_amount": "0.001",
"refund_fail_reason": "",
"refund_to_gate_uid": 10002,
"channelId": "123456",
"nickName": "testUser",
"payerId": 10001,
"fromAddress": "0x1234...",
"payChannel": "1",
"billType": 1,
"goodsName": "charge",
"totalRequestAmount": "0.018",
"totalRequestCurrency": "USDT",
"totalReceiveAmount": "0.018",
"totalReceiveCurrency": "USDT",
"refundDetails": [
{
"transactionId": "1991045981847818241",
"transactTime": 1724769660000,
"payChannel": "1",
"status": "SUCCESS",
"amount": "0.018",
"currency": "USDT",
"chain": "ETH",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"hash": "0x1234...",
"remark": "",
"billType": 1
}
]
}
}Query Refund Details
Query cashier refund details by merchant refund ID. Returns full refund status and transaction information.
curl --request GET \
--url https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details \
--header 'X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>' \
--header 'X-GatePay-Nonce: <x-gatepay-nonce>' \
--header 'X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>' \
--header 'X-GatePay-Signature: <x-gatepay-signature>' \
--header 'X-GatePay-Timestamp: <x-gatepay-timestamp>'import requests
url = "https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details"
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>",
"X-GatePay-On-Behalf-Of": "<x-gatepay-on-behalf-of>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
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>',
'X-GatePay-On-Behalf-Of': '<x-gatepay-on-behalf-of>'
}
};
fetch('https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details', 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/payment/open/institution/v2/pay/refund/details",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-GatePay-Certificate-ClientId: <x-gatepay-certificate-clientid>",
"X-GatePay-Nonce: <x-gatepay-nonce>",
"X-GatePay-On-Behalf-Of: <x-gatepay-on-behalf-of>",
"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.get("https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details")
.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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
.asString();package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://openplatform.gateapi.io/payment/open/institution/v2/pay/refund/details"
req, _ := http.NewRequest("GET", url, nil)
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("X-GatePay-On-Behalf-Of", "<x-gatepay-on-behalf-of>")
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/payment/open/institution/v2/pay/refund/details")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.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["X-GatePay-On-Behalf-Of"] = '<x-gatepay-on-behalf-of>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"code": "000000",
"errorMessage": "",
"data": {
"refundRequestId": "202508271923022",
"gateRefundId": "1991045981847818240",
"refundId": "1991045981847818240",
"orderId": "35214673103159414",
"merchantTradeNo": "163",
"createTime": 1724769600000,
"transactTime": 1724769660000,
"transactionId": "1991045981847818241",
"txHash": "0x1234...",
"orderAmount": "10",
"orderCurrency": "USDT",
"requestAmount": "0.018",
"requestCurrency": "USDT",
"amount": "0.018",
"currency": "USDT",
"status": "SUCCESS",
"remark": "bourne-test",
"refund_style": 2,
"refund_pay_channel": 1,
"refund_address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"refund_chain": "ETH",
"refund_bear_type": 1,
"refund_amount_type": 2,
"refund_account_type": 1,
"refund_gas_amount": "0.001",
"refund_fail_reason": "",
"refund_to_gate_uid": 10002,
"channelId": "123456",
"nickName": "testUser",
"payerId": 10001,
"fromAddress": "0x1234...",
"payChannel": "1",
"billType": 1,
"goodsName": "charge",
"totalRequestAmount": "0.018",
"totalRequestCurrency": "USDT",
"totalReceiveAmount": "0.018",
"totalReceiveCurrency": "USDT",
"refundDetails": [
{
"transactionId": "1991045981847818241",
"transactTime": 1724769660000,
"payChannel": "1",
"status": "SUCCESS",
"amount": "0.018",
"currency": "USDT",
"chain": "ETH",
"address": "0x86608d3C9f979b98a3b2417216eD859d313E339D",
"hash": "0x1234...",
"remark": "",
"billType": 1
}
]
}
}Overview
This page documents theGET /payment/open/institution/v2/pay/refund/details 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
Merchant client ID, obtained from GatePay platform
"4186d0c6-6a35-55a9-8dc6-5312769dbff8"
HMAC-SHA256 signature for request validation
"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"
Millisecond timestamp; the difference from server time must not exceed 30 seconds.
"1672905655498"
Random nonce for replay attack prevention
"9578"
Required delegated-subject header. Provide the initiating account ID for this request. For institution merchant APIs, this is typically the target sub-account ID; for institution charge and transfer APIs, it can be either an institution account ID or a sub-account ID.
Query Parameters
Merchant refund ID, max 32 characters
32
