---
title: "Checkout Refund Details"
method: GET
path: "/v2/pay/refund/details"
---

# Checkout Refund Details

`GET /v2/pay/refund/details`

Query cashier refund details by merchant refund ID. Returns full refund status and transaction information.

## Query parameters

- `refundRequestId` string, required

## Headers

- `X-GatePay-Certificate-ClientId` string, required
- `X-GatePay-Signature` string, required
- `X-GatePay-Timestamp` string, required
- `X-GatePay-Nonce` string, required

## Response `200`

Refund details retrieved successfully

- RefundDetailsResponse
  - `status` string — Response status
  - `code` string — Response code
  - `errorMessage` string — Error message
  - `data` RefundDetailsData
    - `refundRequestId` string — Merchant refund ID
    - `gateRefundId` string — Gate refund ID
    - `refundId` string — Refund ID
    - `orderId` string — Order ID
    - `merchantTradeNo` string — Merchant order number
    - `createTime` integer — Create time in milliseconds
    - `transactTime` integer — Transaction time in milliseconds
    - `transactionId` string — Transaction ID
    - `txHash` string — Transaction hash
    - `orderAmount` string — Order amount
    - `orderCurrency` string — Order currency
    - `requestAmount` string — Requested refund amount
    - `requestCurrency` string — Request currency
    - `amount` string — Refund amount
    - `currency` string — Refund currency
    - `status` 'PENDING' | 'PROCESS' | 'CHECK' | 'SUCCESS' | 'FAIL' — Refund status
    - `remark` string — Remark
    - `refund_style` integer — Refund style
    - `refund_pay_channel` integer — Refund payment channel
    - `refund_address` string — Refund address
    - `refund_chain` string — Refund chain
    - `refund_bear_type` integer — Who bears refund cost
    - `refund_amount_type` integer — Refund amount type
    - `refund_account_type` integer — Refund account type
    - `refund_gas_amount` string — Refund gas amount
    - `refund_fail_reason` string — Refund failure reason
    - `refund_to_gate_uid` integer — Refund recipient Gate UID
    - `channelId` string — Channel ID
    - `nickName` string — Payer nickname
    - `payerId` integer — Payer ID
    - `fromAddress` string — Payer address
    - `payChannel` string — Payment channel
    - `billType` integer — Bill type
    - `goodsName` string — Goods name
    - `totalRequestAmount` string — Total requested amount
    - `totalRequestCurrency` string — Total request currency
    - `totalReceiveAmount` string — Total received amount
    - `totalReceiveCurrency` string — Total receive currency
    - `refundDetails` RefundDetailItem[] — Refund transaction details
      - `transactionId` string — Transaction ID
      - `transactTime` integer — Transaction time in milliseconds
      - `payChannel` string — Payment channel
      - `status` string — Status
      - `amount` string — Amount
      - `currency` string — Currency
      - `chain` string — Chain
      - `address` string — Address
      - `hash` string — Transaction hash; depending on the business callback, this value may appear as hash, txHash, or tx_hash
      - `remark` string — Remark
      - `billType` integer — Bill type

## Changes

- **2026-08-05** `db3687218ec6` — 1 breaking
  - the `data/payChannel` response's property type/format changed from `integer`/`` to `string`/`` for status `200`

[Change history](https://skmtc.dev/gate/apis/gatepay-api-2/changes/v2/pay/refund/details/get.md)

---

[API](https://skmtc.dev/gate/apis/gatepay-api-2.md) · [All operations](https://skmtc.dev/gate/apis/gatepay-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gate/gatepay-api-2/revisions/db3687218ec6/schema)
