> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query Refund Details

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

## Overview

This page documents the `GET /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](/api-reference/version/100/en/common/securityAndSignature).


## OpenAPI

````yaml /api-reference/version/100/en/openapi/institution/checkout-payment-openapi.json GET /payment/open/institution/v2/pay/refund/details
openapi: 3.1.0
info:
  title: GatePay API
  description: >-
    GatePay Checkout Payment API - Create orders at the cashier, process
    refunds, and query order/refund details.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io
security: []
paths:
  /payment/open/institution/v2/pay/refund/details:
    get:
      summary: Checkout Refund Details
      description: >-
        Query cashier refund details by merchant refund ID. Returns full refund
        status and transaction information.
      parameters:
        - $ref: '#/components/parameters/X-GatePay-Certificate-ClientId'
        - $ref: '#/components/parameters/X-GatePay-Signature'
        - $ref: '#/components/parameters/X-GatePay-Timestamp'
        - $ref: '#/components/parameters/X-GatePay-Nonce'
        - $ref: '#/components/parameters/refundRequestId'
        - $ref: '#/components/parameters/X-GatePay-On-Behalf-Of'
      responses:
        '200':
          description: Refund details retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundDetailsResponse'
              examples:
                successResponse:
                  summary: Success Response
                  value:
                    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
components:
  parameters:
    X-GatePay-Certificate-ClientId:
      name: X-GatePay-Certificate-ClientId
      in: header
      required: true
      description: Merchant client ID, obtained from GatePay platform
      schema:
        type: string
        example: 4186d0c6-6a35-55a9-8dc6-5312769dbff8
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: HMAC-SHA256 signature for request validation
      schema:
        type: string
        example: >-
          672d5650dcc9bb22ebf25fa16c28d03c0e159d742a9176d4340a5da326d75dc8a2ec24c97fa6fc5d1533dd6e968863747e1d86a45e562cbe899f9ed7e9ca7f77
    X-GatePay-Timestamp:
      name: X-GatePay-Timestamp
      in: header
      required: true
      description: >-
        Timestamp in milliseconds, must not differ from server time by more than
        5 minutes
      schema:
        type: string
        example: '1672905655498'
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random nonce for replay attack prevention
      schema:
        type: string
        example: '9578'
    refundRequestId:
      name: refundRequestId
      in: query
      required: true
      description: Merchant refund ID, max 32 characters
      schema:
        type: string
        maxLength: 32
    X-GatePay-On-Behalf-Of:
      name: X-GatePay-On-Behalf-Of
      in: header
      required: true
      schema:
        type: string
      description: >-
        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.
  schemas:
    RefundDetailsResponse:
      type: object
      properties:
        status:
          type: string
          description: Response status
        code:
          type: string
          description: Response code
        errorMessage:
          type: string
          description: Error message
        data:
          $ref: '#/components/schemas/RefundDetailsData'
    RefundDetailsData:
      type: object
      properties:
        refundRequestId:
          type: string
          description: Merchant refund ID
        gateRefundId:
          type: string
          description: Gate refund ID
        refundId:
          type: string
          description: Refund ID
        orderId:
          type: string
          description: Order ID
        merchantTradeNo:
          type: string
          description: Merchant order number
        createTime:
          type: integer
          format: int64
          description: Create time in milliseconds
        transactTime:
          type: integer
          format: int64
          description: Transaction time in milliseconds
        transactionId:
          type: string
          description: Transaction ID
        txHash:
          type: string
          description: Transaction hash
        orderAmount:
          type: string
          description: Order amount
        orderCurrency:
          type: string
          description: Order currency
        requestAmount:
          type: string
          description: Requested refund amount
        requestCurrency:
          type: string
          description: Request currency
        amount:
          type: string
          description: Refund amount
        currency:
          type: string
          description: Refund currency
        status:
          type: string
          description: Refund status
          enum:
            - PENDING
            - PROCESS
            - CHECK
            - SUCCESS
            - FAIL
        remark:
          type: string
          description: Remark
        refund_style:
          type: string
          description: Refund style
        refund_pay_channel:
          type: string
          description: Refund payment channel
        refund_address:
          type: string
          description: Refund address
        refund_chain:
          type: string
          description: Refund chain
        refund_bear_type:
          type: string
          description: Who bears refund cost
        refund_amount_type:
          type: string
          description: Refund amount type
        refund_account_type:
          type: string
          description: Refund account type
        refund_gas_amount:
          type: string
          description: Refund gas amount
        refund_fail_reason:
          type: string
          description: Refund failure reason
        refund_to_gate_uid:
          type: string
          description: Refund recipient Gate UID
        channelId:
          type: string
          description: Channel ID
        nickName:
          type: string
          description: Payer nickname
        payerId:
          type: string
          description: Payer ID
        fromAddress:
          type: string
          description: Payer address
        payChannel:
          type: string
          description: Payment channel
        billType:
          type: string
          description: Bill type
        goodsName:
          type: string
          description: Goods name
        totalRequestAmount:
          type: string
          description: Total requested amount
        totalRequestCurrency:
          type: string
          description: Total request currency
        totalReceiveAmount:
          type: string
          description: Total received amount
        totalReceiveCurrency:
          type: string
          description: Total receive currency
        refundDetails:
          type: array
          items:
            $ref: '#/components/schemas/RefundDetailItem'
          description: Refund transaction details
    RefundDetailItem:
      type: object
      properties:
        transactionId:
          type: string
          description: Transaction ID
        transactTime:
          type: integer
          format: int64
          description: Transaction time in milliseconds
        payChannel:
          type: string
          description: Payment channel
        status:
          type: string
          description: Status
        amount:
          type: string
          description: Amount
        currency:
          type: string
          description: Currency
        chain:
          type: string
          description: Chain
        address:
          type: string
          description: Address
        hash:
          type: string
          description: >-
            Transaction hash; depending on the business callback, this value may
            appear as hash, txHash, or tx_hash
        remark:
          type: string
          description: Remark
        billType:
          type: string
          description: Bill type

````