API for Refund

Introduction

Merchants can initiate a refund by calling this API, allowing for partial or full refunds. Refund order supported all token and network for payment.

If the email field is filled out, ACH will send a refund notification email to the user after the refund is processed.

API Description

Request Method: POST

Request URL: open/api/payment/refund

Request Parameters

Body Parameters

ParameterSignature RequiredRequiredTypeLengthDescription
appIdYesYesstring64appID
refundOrderNoNoNostring64Refund order number, customized by the merchant
merchantOrderNoYesYesstring64Merchant order number, the number used when creating an order
walletAddressYesYesstring64User Wallet address
refundAmountYesYesstring32Refund amount(in USD)
refundTokenYesYesstring32Refund token
refundNetworkYesYesstring32Refund network
emailNoNostring64User email
refundReasonNoNostring64Refund reason
memoNoNostring64Memo
signNoYesstring256Signature

Request Parameter Example

{
  "appId": "your_app_id_here_abc123",
  "merchantOrderNo": "merchant_order_20250427_002",
  "walletAddress": "0xYourWalletAddress1a2b3c4d5e6f",
  "refundAmount": "25.50",
  "refundToken": "refund_token_xyz789",
  "refundNetwork": "ETHEREUM",
  "email": "[email protected]",
  "refundReason": "requested_by_user",
  "memo": "Optional memo for the refund",
  "sign": "ybcdef0123456789abcdef012345789abcdef0123456789abcdef0123456789abcdef012345"
}

Response Parameters

Response Parameter Example

{
    "code": "0",
    "msg": "success",
    "model": "",
    "traceId": "66cff1bec8a8a398c1c8e80e38e7572e",
    "success": true,
    "error": false
}