> ## 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.

# Address Payment Convert Refund

> Initiate a refund for the convert address payment order, which is only applicable to the convert address payment order.

## Overview

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

Initiate a refund for the convert address payment order, which is only applicable to the convert address payment order.  If the provided parameters correspond to the direct payment order, an error message will be returned.

## 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/address-payment-openapi.json POST /v1/pay/address/refundconvert
openapi: 3.1.0
info:
  title: GatePay Address Payment API
  description: GatePay Address Payment APIs for crypto payment via blockchain address.
  version: 1.0.0
servers:
  - url: https://openplatform.gateapi.io
security: []
paths:
  /v1/pay/address/refundconvert:
    post:
      summary: Refund (Convert Payment)
      description: >-
        Initiate a refund for the convert address payment order, which is only
        applicable to the convert address payment order.
      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'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RefundConvertRequest'
            example:
              refundRequestId: '483902480932841787'
              prepayId: '1665553233227833'
              refundOrderCurrency: BTC
              refundOrderAmount: '1.1'
              refundPayCurrency: USDT
              refundPayAmount: '1000.1'
              refundReason: refund test
              receiverId: 123456
      responses:
        '200':
          description: SUCCESS
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RefundConvertResponse'
              example:
                status: SUCCESS
                code: '00000'
                errorMessage: ''
                data:
                  refundRequestId: '483902480932841787'
                  prepayId: '1665553233227833'
                  orderCurrency: BTC
                  orderAmount: '2.2'
                  refundOrderAmount: '1.1'
                  payCurrency: USDT
                  payAmount: '44000'
                  refundPayAmount: '1000.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
    X-GatePay-Signature:
      name: X-GatePay-Signature
      in: header
      required: true
      description: HMAC-SHA256 signature for request validation
      schema:
        type: string
    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
    X-GatePay-Nonce:
      name: X-GatePay-Nonce
      in: header
      required: true
      description: Random nonce for replay attack prevention
      schema:
        type: string
  schemas:
    RefundConvertRequest:
      type: object
      required:
        - refundRequestId
        - prepayId
        - refundOrderCurrency
        - refundPayCurrency
        - refundReason
        - receiverId
      properties:
        refundRequestId:
          type: string
          description: Merchant request refund number
        prepayId:
          type: string
          description: Payment order ID for refund
        refundOrderCurrency:
          type: string
          description: Refund order currency
        refundPayCurrency:
          type: string
          description: Refund payment currency
        refundPayAmount:
          type: string
          description: Refund payment amount in the corresponding currency
        refundReason:
          type: string
          description: Reason for refund
        receiverId:
          type: string
          description: Gate system user ID for refund recipient in address payment
    RefundConvertResponse:
      type: object
      description: Response to request for refund of convert payment order
      properties:
        status:
          type: string
        code:
          type: string
        errorMessage:
          type: string
        data:
          type: object
          properties:
            refundRequestId:
              type: string
              description: Merchant's refund request ID
            prepayId:
              type: string
              description: ID of the corresponding payment order
            orderCurrency:
              type: string
              description: Currency of the order
            orderAmount:
              type: string
              description: Amount of the order
            refundOrderAmount:
              type: string
              description: Refund amount in the currency of the order
            payCurrency:
              type: string
              description: Currency used by the user for payment
            payAmount:
              type: string
              description: Amount the user should have paid for the order
            refundPayAmount:
              type: string
              description: Refund amount in the currency used by the user for payment

````