ExWechatpay.Service.Refund (ex_wechatpay v0.3.5)

View Source

退款服务模块

该模块负责处理微信支付的退款相关操作，包括创建退款、查询退款等。 通过集中管理退款逻辑，提高了代码的可维护性和一致性。

Summary

Functions

create_refund(config, finch, args)

创建退款

handle_refund_notification(config, headers, body)

申请退款回调通知处理

query_refund(config, finch, out_refund_no)

查询退款

Functions

create_refund(config, finch, args)

@spec create_refund(
  ExWechatpay.Model.ConfigOption.t(),
  ExWechatpay.Typespecs.name(),
  ExWechatpay.Typespecs.refund_req()
) :: ExWechatpay.Typespecs.result_t(ExWechatpay.Typespecs.refund_resp())

创建退款

参数

  • config - 配置选项
  • finch - Finch 实例
  • args - 退款参数，必须包含以下字段：
    • out_refund_no - 商户退款单号
    • out_trade_no 或 transaction_id - 商户订单号或微信支付订单号
    • amount - 退款金额信息，包含 refund 字段表示退款金额

返回值

  • {:ok, map()} - 成功创建的退款信息
  • {:error, Exception.t()} - 创建退款失败的错误信息

handle_refund_notification(config, headers, body)

@spec handle_refund_notification(
  ExWechatpay.Model.ConfigOption.t(),
  ExWechatpay.Typespecs.headers(),
  ExWechatpay.Typespecs.body()
) ::
  ExWechatpay.Typespecs.result_t(ExWechatpay.Typespecs.payment_notification())

申请退款回调通知处理

参数

  • config - 配置选项
  • headers - 回调请求头
  • body - 回调请求体

返回值

  • {:ok, map()} - 解析后的回调数据
  • {:error, Exception.t()} - 处理失败的错误信息

query_refund(config, finch, out_refund_no)

@spec query_refund(
  ExWechatpay.Model.ConfigOption.t(),
  ExWechatpay.Typespecs.name(),
  String.t()
) ::
  ExWechatpay.Typespecs.result_t(ExWechatpay.Typespecs.refund_query_resp())

查询退款

参数

  • config - 配置选项
  • finch - Finch 实例
  • out_refund_no - 商户退款单号

返回值

  • {:ok, map()} - 退款信息
  • {:error, Exception.t()} - 查询失败的错误信息