---
url: "https://pay.weixin.qq.com/doc/v3/partner/4012759673-java.md"
title: "申请退款-请求示例-java"
doc_id: 4012759673
example_lang: "java"
---

## Java


需配合微信支付工具库 WXPayUtility 使用，请参考 [Java](https://pay.weixin.qq.com/doc/v3/partner/4014985777.md)

```
package com.java.demo;

import com.java.utils.WXPayUtility; // 引用微信支付工具库，参考：https://pay.weixin.qq.com/doc/v3/merchant/4014931831

import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

import java.io.IOException;
import java.io.UncheckedIOException;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * 退款申请
 */
public class Create {
  private static String HOST = "https://api.mch.weixin.qq.com";
  private static String METHOD = "POST";
  private static String PATH = "/v3/refund/domestic/refunds";

  public static void main(String[] args) {
    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
    Create client = new Create(
      "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
      "/path/to/apiclient_key.pem",     // 商户API证书私钥文件路径，本地文件路径
      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
    );

    CreateRequest request = new CreateRequest();
    request.subMchid = "1900000109";
    request.transactionId = "1217752501201407033233368018";
    request.outTradeNo = "1217752501201407033233368018";
    request.outRefundNo = "1217752501201407033233368018";
    request.reason = "商品已售完";
    request.notifyUrl = "https://weixin.qq.com";
    request.fundsAccount = ReqFundsAccount.AVAILABLE;
    request.amount = new AmountReq();
    request.amount.refund = 888L;
    request.amount.from = new ArrayList<>();
    {
      FundsFromItem fromItem = new FundsFromItem();
      fromItem.account = Account.AVAILABLE;
      fromItem.amount = 444L;
      request.amount.from.add(fromItem);
    };
    request.amount.total = 888L;
    request.amount.currency = "CNY";
    request.goodsDetail = new ArrayList<>();
    {
      GoodsDetail goodsDetailItem = new GoodsDetail();
      goodsDetailItem.merchantGoodsId = "1217752501201407033233368018";
      goodsDetailItem.wechatpayGoodsId = "1001";
      goodsDetailItem.goodsName = "iPhone6s 16G";
      goodsDetailItem.unitPrice = 528800L;
      goodsDetailItem.refundAmount = 528800L;
      goodsDetailItem.refundQuantity = 1L;
      request.goodsDetail.add(goodsDetailItem);
    };
    try {
      Refund response = client.run(request);
        // TODO: 请求成功，继续业务逻辑
        System.out.println(response);
    } catch (WXPayUtility.ApiException e) {
        // TODO: 请求失败，根据状态码执行不同的逻辑
        e.printStackTrace();
    }
  }

  public Refund run(CreateRequest request) {
    String uri = PATH;
    String reqBody = WXPayUtility.toJson(request);

    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
    reqBuilder.addHeader("Accept", "application/json");
    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
    reqBuilder.addHeader("Content-Type", "application/json");
    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
    reqBuilder.method(METHOD, requestBody);
    Request httpRequest = reqBuilder.build();

    // 发送HTTP请求
    OkHttpClient client = new OkHttpClient.Builder().build();
    try (Response httpResponse = client.newCall(httpRequest).execute()) {
      String respBody = WXPayUtility.extractBody(httpResponse);
      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
        // 2XX 成功，验证应答签名
        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
            httpResponse.headers(), respBody);

        // 从HTTP应答报文构建返回数据
        return WXPayUtility.fromJson(respBody, Refund.class);
      } else {
        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
      }
    } catch (IOException e) {
      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
    }
  }

  private final String mchid;
  private final String certificateSerialNo;
  private final PrivateKey privateKey;
  private final String wechatPayPublicKeyId;
  private final PublicKey wechatPayPublicKey;

  public Create(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
    this.mchid = mchid;
    this.certificateSerialNo = certificateSerialNo;
    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
  }

  public static class CreateRequest {
    @SerializedName("sub_mchid")
    public String subMchid;

    @SerializedName("transaction_id")
    public String transactionId;

    @SerializedName("out_trade_no")
    public String outTradeNo;

    @SerializedName("out_refund_no")
    public String outRefundNo;

    @SerializedName("reason")
    public String reason;

    @SerializedName("notify_url")
    public String notifyUrl;

    @SerializedName("funds_account")
    public ReqFundsAccount fundsAccount;

    @SerializedName("amount")
    public AmountReq amount;

    @SerializedName("goods_detail")
    public List<GoodsDetail> goodsDetail;

  }

  public static class Refund {
    @SerializedName("refund_id")
    public String refundId;

    @SerializedName("out_refund_no")
    public String outRefundNo;

    @SerializedName("transaction_id")
    public String transactionId;

    @SerializedName("out_trade_no")
    public String outTradeNo;

    @SerializedName("channel")
    public Channel channel;

    @SerializedName("user_received_account")
    public String userReceivedAccount;

    @SerializedName("success_time")
    public String successTime;

    @SerializedName("create_time")
    public String createTime;

    @SerializedName("status")
    public Status status;

    @SerializedName("funds_account")
    public FundsAccount fundsAccount;

    @SerializedName("amount")
    public Amount amount;

    @SerializedName("promotion_detail")
    public List<Promotion> promotionDetail;

  }

  public enum ReqFundsAccount {
    @SerializedName("AVAILABLE")
    AVAILABLE,
    @SerializedName("UNSETTLED")
    UNSETTLED
  }

  public static class AmountReq {
    @SerializedName("refund")
    public Long refund;

    @SerializedName("from")
    public List<FundsFromItem> from;

    @SerializedName("total")
    public Long total;

    @SerializedName("currency")
    public String currency;
  }

  public static class GoodsDetail {
    @SerializedName("merchant_goods_id")
    public String merchantGoodsId;

    @SerializedName("wechatpay_goods_id")
    public String wechatpayGoodsId;

    @SerializedName("goods_name")
    public String goodsName;

    @SerializedName("unit_price")
    public Long unitPrice;

    @SerializedName("refund_amount")
    public Long refundAmount;

    @SerializedName("refund_quantity")
    public Long refundQuantity;
  }

  public enum Channel {
    @SerializedName("ORIGINAL")
    ORIGINAL,
    @SerializedName("BALANCE")
    BALANCE,
    @SerializedName("OTHER_BALANCE")
    OTHER_BALANCE,
    @SerializedName("OTHER_BANKCARD")
    OTHER_BANKCARD
  }

  public enum Status {
    @SerializedName("SUCCESS")
    SUCCESS,
    @SerializedName("CLOSED")
    CLOSED,
    @SerializedName("PROCESSING")
    PROCESSING,
    @SerializedName("ABNORMAL")
    ABNORMAL
  }

  public enum FundsAccount {
    @SerializedName("UNSETTLED")
    UNSETTLED,
    @SerializedName("AVAILABLE")
    AVAILABLE,
    @SerializedName("UNAVAILABLE")
    UNAVAILABLE,
    @SerializedName("OPERATION")
    OPERATION,
    @SerializedName("BASIC")
    BASIC,
    @SerializedName("ECNY_BASIC")
    ECNY_BASIC
  }

  public static class Amount {
    @SerializedName("total")
    public Long total;

    @SerializedName("refund")
    public Long refund;

    @SerializedName("from")
    public List<FundsFromItem> from;

    @SerializedName("payer_total")
    public Long payerTotal;

    @SerializedName("payer_refund")
    public Long payerRefund;

    @SerializedName("settlement_refund")
    public Long settlementRefund;

    @SerializedName("settlement_total")
    public Long settlementTotal;

    @SerializedName("discount_refund")
    public Long discountRefund;

    @SerializedName("currency")
    public String currency;

    @SerializedName("refund_fee")
    public Long refundFee;
  }

  public static class Promotion {
    @SerializedName("promotion_id")
    public String promotionId;

    @SerializedName("scope")
    public PromotionScope scope;

    @SerializedName("type")
    public PromotionType type;

    @SerializedName("amount")
    public Long amount;

    @SerializedName("refund_amount")
    public Long refundAmount;

    @SerializedName("goods_detail")
    public List<GoodsDetail> goodsDetail;
  }

  public static class FundsFromItem {
    @SerializedName("account")
    public Account account;

    @SerializedName("amount")
    public Long amount;
  }

  public enum PromotionScope {
    @SerializedName("GLOBAL")
    GLOBAL,
    @SerializedName("SINGLE")
    SINGLE
  }

  public enum PromotionType {
    @SerializedName("CASH")
    CASH,
    @SerializedName("NOCASH")
    NOCASH
  }

  public enum Account {
    @SerializedName("AVAILABLE")
    AVAILABLE,
    @SerializedName("UNAVAILABLE")
    UNAVAILABLE
  }

}

```
