Skip to main content
GET
/
v2
/
pay
/
refund
/
details
Checkout Refund Details
curl --request GET \
  --url https://openplatform.gateapi.io/v2/pay/refund/details \
  --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>'
{
  "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 the GET /v2/pay/refund/details endpoint. The full schema, parameters, and examples are rendered from the linked OpenAPI definition above.

​
Notes

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-SHA256 signature for request validation

Example:

"672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77"

​
X-GatePay-Timestamp
string
required

Timestamp in milliseconds, must not differ from server time by more than 5 minutes

Example:

"1672905655498"

​
X-GatePay-Nonce
string
required

Random nonce for replay attack prevention

Example:

"9578"

Query Parameters

​
refundRequestId
string
required

Merchant refund ID, max 32 characters

Maximum string length: 32

Response

200 - application/json

Refund details retrieved successfully

​
status
string

Response status

​
code
string

Response code

​
errorMessage
string

Error message

​
data
object