序列化表格

  • 程序包 com.abasecode.opencode.pay.entity

    • 类 com.abasecode.opencode.pay.entity.BaseGoodDetail

      class BaseGoodDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • 序列化字段

        • category
          String category
          商品类目
        • contentTree
          String contentTree
          商品类目树
        • goodId
          String goodId
          商品ID
        • goodName
          String goodName
          商品名称
        • price
          int price
          商品价格(分)
        • quantity
          Integer quantity
          商品数量
        • showUrl
          String showUrl
          商品的展示地址

    • 类 com.abasecode.opencode.pay.entity.BaseOrder

      class BaseOrder extends Object implements Serializable
      serialVersionUID:
      -1L

      • 序列化字段

        • amount
          @javax.validation.constraints.NotNull int amount
          总价（分）
        • details
          List<BaseGoodDetail> details
          商品详情，可空。支付宝或微信均适用
        • otherParams
          String otherParams
          微信，支付宝:公用回传参数，如果请求时传递了该参数，则返回给商户时会回传该参数。 支付宝只会在同步返回（包括跳转回商户网站）和异步通知时将该参数原样返回。 本参数必须进行UrlEncode之后才可以发送给支付宝。 微信只能传128个字节。
        • outTradeNo
          @NotNull String outTradeNo
          订单号，32位
        • subject
          @NotNull String subject
          商品标题
        • timeExpire
          String timeExpire
          交易结束时间。支付宝或微信均适用。 非必须 格式：yyyy-MM-dd HH:mm:ss 例如：2022-11-28 11:59:59 时区为东八区

    • 类 com.abasecode.opencode.pay.entity.BaseOrderAlipay

      class BaseOrderAlipay extends Object implements Serializable
      serialVersionUID:
      8579515877126502990L

      • 序列化字段

        • authToken
          String authToken
          支付宝：针对用户授权接口，获取用户相关数据时，用于标识用户授权关系 非必须
        • businessParams
          String businessParams
          支付宝：商户传入业务信息，具体值要和支付宝约定，应用于安全，营销等参数直传场景，格式为json格式 非必须
        • extendParams
          ExtendParams extendParams
          业务扩展参数 非必须
        • quitUrl
          String quitUrl
          支付宝：用户付款中途退出返回商户网站的地址 非必须

    • 类 com.abasecode.opencode.pay.entity.BaseOrderWechat

      class BaseOrderWechat extends Object implements Serializable
      serialVersionUID:
      -1986039082025305864L

      • 序列化字段

        • description
          String description
          微信：商品描述
        • goodsTag
          String goodsTag
          微信：单优惠标记 非必须
        • invoice
          boolean invoice
          微信：电子发票入口开放标识 非必须

    • 类 com.abasecode.opencode.pay.entity.PayNotify

      class PayNotify extends Object implements Serializable
      serialVersionUID:
      5851302634186636366L

      • 序列化字段

        • appId
          String appId
          付款（支付宝，微信） 退单（支付宝）微信退款返回空，“” 应用id
        • code
          int code
          成功0，失败-1
        • notifyTime
          String notifyTime
          付款（支付宝，微信） 退单（支付宝，微信） 付款通知时间、退单通知时间 支付宝的 notify_time 微信的 create_time
        • outTradeNo
          String outTradeNo
          商户订单号 付款（支付宝，微信） 退单（支付宝，微信） 商户订单号
        • payChannel
          PayChannel payChannel
          通道
        • payTime
          String payTime
          付款（支付宝，微信） 退单（支付宝），退单时微信返回空。。 支付宝的 gmt_payment 微信的 success_time
        • refundAmount
          int refundAmount
          付款默认为0 退单（支付宝=refund_fee，微信=refund）
        • refundAmountMoney
          String refundAmountMoney
          付款（默认为0.00） 退单（支付宝=refund_fee，微信=refund）
        • refundTime
          String refundTime
          退款时间 付款（空，空） 退单（支付宝=gmt_refund，微信=success_time）
        • sellerId
          String sellerId
          商户号 付款（支付宝，微信） 退单（支付宝，微信） mchid（微信） seller_id（支付宝）
        • status
          String status
          状态 付款（支付宝，微信） 退单（支付宝，微信） 支付宝的（trade_status） 微信的的（trade_state）和（refund_status）
        • totalAmount
          int totalAmount
          付款（支付宝，微信） 退单（支付宝，微信） 支付宝的（totalAmount) 微信的（amount.total)
        • totalAmountMoney
          String totalAmountMoney
          付款（支付宝，微信） 退单（支付宝，微信） 支付宝的totalAmount 微信的（amount.total)
        • tradeNo
          String tradeNo
          支付通道订单号 付款（支付宝，微信） 退单（支付宝，微信） 渠道订单号 支付宝（trade_no） 微信（transaction_id）
        • type
          int type
          1=付款，2=退款

    • 类 com.abasecode.opencode.pay.entity.PayQueryResult

      class PayQueryResult extends Object implements Serializable
      serialVersionUID:
      8533237444886761415L

      • 序列化字段

        • alipayResult
          com.alipay.api.response.AlipayTradeQueryResponse alipayResult
          支付宝结果
        • outTradeNo
          String outTradeNo
          订单号
        • payAmount
          int payAmount
          客户付款金额（分） 总金额 - 付款金额 =其他优惠抵扣金额
        • payAmountMoney
          String payAmountMoney
          客户付款金额（小数格式）
        • payChannel
          PayChannel payChannel
          通道
        • payStatus
          PayStatus payStatus
          订单状态
        • successTime
          String successTime
          付款时间
        • totalAmount
          int totalAmount
          总金额（分）
        • totalAmountMoney
          String totalAmountMoney
          总金额（小数模式）
        • tradeNo
          String tradeNo
          付款渠道订单号
        • wechatResult
          PayQueryReturn wechatResult
          微信结果

    • 类 com.abasecode.opencode.pay.entity.PayRefundNotifyResult

      class PayRefundNotifyResult extends Object implements Serializable
      serialVersionUID:
      -4239484413142115675L

      • 序列化字段

        • outRefundNo
          String outRefundNo
          商户退单号
        • outTradeNo
          String outTradeNo
          商户订单号
        • payChannel
          PayChannel payChannel
          通道
        • refundAmount
          int refundAmount
          退款金额（分）
        • refundAmountMoney
          String refundAmountMoney
          退款金额（小数）
        • totalAmount
          int totalAmount
          订单金额（分）
        • totalAmountMoney
          String totalAmountMoney
          订单金额（小数）

    • 类 com.abasecode.opencode.pay.entity.PayRefundResult

      class PayRefundResult extends Object implements Serializable
      serialVersionUID:
      -8370328458203385256L

      • 序列化字段

        • outRefundNo
          String outRefundNo
          退款单号 对应支付宝的 out_request_no 对应微信的 out_refund_no
        • outTradeNo
          String outTradeNo
          商户订单号
        • payChannel
          PayChannel payChannel
          通道
        • refundAmount
          int refundAmount
          退款总金额。 指该笔交易累计已经退款成功的金额。
        • refundAmountMoney
          String refundAmountMoney
          退款总金额。（小数格式） 指该笔交易累计已经退款成功的金额。
        • refundNo
          String refundNo
          渠道退单号（支付宝同tradeNo，微信为refund_id）
        • refundResultAlipay
          PayRefundResultAlipay refundResultAlipay
          支付宝详情
        • refundResultWechat
          PayRefundResultWechat refundResultWechat
          微信详情
        • status
          String status
          退款状态。 微信枚举值： SUCCESS：退款成功 CLOSED：退款关闭 PROCESSING：退款处理中 ABNORMAL：退款异常 支付宝值：
        • successTime
          String successTime
          退款时间 成功才有 格式如 2020-12-01 16:18:12
        • tradeNo
          String tradeNo
          渠道订单号(微信为transaction_id，支付宝为trade_no)

    • 类 com.abasecode.opencode.pay.entity.PayRefundResultAlipay

      class PayRefundResultAlipay extends Object implements Serializable
      serialVersionUID:
      -2592163947404044717L

      • 序列化字段

        • buyerLogonId
          String buyerLogonId
          用户的登录id
        • buyerUserId
          String buyerUserId
          买家在支付宝的用户id
        • fundChange
          String fundChange
          本次退款是否发生了资金变化
        • refundHybAmount
          String refundHybAmount
          本次请求退惠营宝金额（小数格式）
        • sendBackFee
          String sendBackFee
          本次商户实际退回金额。 说明：如需获取该值，需在入参query_options中传入 refund_detail_item_list。
        • storeName
          String storeName
          交易在支付时候的门店名称

    • 类 com.abasecode.opencode.pay.entity.PayRefundResultWechat

      class PayRefundResultWechat extends Object implements Serializable
      serialVersionUID:
      -157566418752030367L

      • 序列化字段

        • amount
          AmountRefundReturn amount
          微信退款信息
        • fundsAccount
          String fundsAccount
          退款所使用资金对应的资金账户类型 枚举值： UNSETTLED : 未结算资金 AVAILABLE : 可用余额 UNAVAILABLE : 不可用余额 OPERATION : 运营户 BASIC : 基本账户（含可用余额和不可用余额）
        • promotionDetail
          List<WechatPromotion> promotionDetail
          优惠退款信息
        • userReceivedAccount
          String userReceivedAccount
          取当前退款单的退款入账方，有以下几种情况： 1）退回银行卡：{银行名称}{卡类型}{卡尾号} 2）退回支付用户零钱:支付用户零钱 3）退还商户:商户基本账户商户结算银行账户 4）退回支付用户零钱通:支付用户零钱通

    • 类 com.abasecode.opencode.pay.entity.PrepayResult

      class PrepayResult extends Object implements Serializable
      serialVersionUID:
      -7401634860330043604L

      • 序列化字段

        • prePayResult
          String prePayResult
          预支付信息 支付宝和微信都是在客户端浏览器直接调用

  • 程序包 com.abasecode.opencode.pay.form

    • 类 com.abasecode.opencode.pay.form.PayCloseForm

      class PayCloseForm extends Object implements Serializable
      serialVersionUID:
      8764108092461510085L

      • 序列化字段

        • outTradeNo
          @NotNull String outTradeNo
          用户订单号
        • payChannel
          @NotNull PayChannel payChannel
          支付通道

    • 类 com.abasecode.opencode.pay.form.PayQueryForm

      class PayQueryForm extends Object implements Serializable
      serialVersionUID:
      5805699541271365409L

      • 序列化字段

        • outTradeNo
          @NotNull String outTradeNo
          订单号
        • payChannel
          @NotNull PayChannel payChannel
          支付通道
        • queryOptions
          List<String> queryOptions
          仅支付宝可选 查询选项，商户传入该参数可定制本接口同步响应额外返回的信息字段，数组格式。支持枚举如下： trade_settle_info：返回的交易结算信息，包含分账、补差等信息； fund_bill_list：交易支付使用的资金渠道； voucher_detail_list：交易支付时使用的所有优惠券信息； discount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息； mdiscount_amount：商家优惠金额；

    • 类 com.abasecode.opencode.pay.form.PayRefundForm

      class PayRefundForm extends Object implements Serializable
      serialVersionUID:
      510808670423160657L

      • 序列化字段

        • orderAmount
          @javax.validation.constraints.NotNull int orderAmount
          订单总金额（分）
        • outRefundNo
          String outRefundNo
          退款单号，不指定则系统生成 对应支付宝的 out_request_no 对应微信的 out_refund_no
        • outTradeNo
          @NotNull String outTradeNo
          商户订单号
        • payChannel
          @NotNull PayChannel payChannel
          支付通道
        • refundAmount
          @javax.validation.constraints.NotNull int refundAmount
          退款金额（分）
        • refundReason
          String refundReason
          退款原因

    • 类 com.abasecode.opencode.pay.form.PayRefundQueryForm

      class PayRefundQueryForm extends Object implements Serializable
      serialVersionUID:
      7527239355089100054L

      • 序列化字段

        • outRefundNo
          @NotNull String outRefundNo
          商户退单号
        • outTradeNo
          @NotNull String outTradeNo
          商户单号
        • payChannel
          @NotNull PayChannel payChannel
          支付通道
        • payType
          @NotNull PayType payType
          支付类型

  • 程序包 com.abasecode.opencode.pay.plugin.alipay.entity

    • 类 com.abasecode.opencode.pay.plugin.alipay.entity.NotifyParam

      class NotifyParam extends Object implements Serializable
      serialVersionUID:
      1L

      • 序列化字段

        • appId
          String appId
          支付宝分配给开发者的应用 ID。
        • body
          String body
          订单的备注、描述、明细等。对应请求时的 body 参数，原样通知回来。
        • buyerId
          String buyerId
          买家支付宝账号对应的支付宝唯一用户号。以 2088 开头的纯 16 位数字。
        • buyerLogonId
          String buyerLogonId
          买家支付宝账号。
        • buyerPayAmount
          String buyerPayAmount
          用户在交易中支付的金额。
        • charset
          String charset
          编码格式，如 utf-8、gbk、gb2312 等。
        • fundBillList
          String fundBillList
          支付成功的各个渠道金额信息。详情可查看 资金明细信息说明。
        • gmtClose
          String gmtClose
          该笔交易结束时间。格式为 yyyy-MM-dd HH:mm:ss。
        • gmtCreate
          String gmtCreate
          该笔交易创建的时间。格式为 yyyy-MM-dd HH:mm:ss。
        • gmtPayment
          String gmtPayment
          该笔交易 的买家付款时间。格式为 yyyy-MM-dd HH:mm:ss。
        • gmtRefund
          String gmtRefund
          该笔交易的退款时间。格式 yyyy-MM-dd HH:mm:ss.S。
        • invoiceAmount
          String invoiceAmount
          用户在交易中支付的可开发票的金额。
        • notifyId
          String notifyId
          通知校验 ID。
        • notifyTime
          String notifyTime
          通知的发送时间。格式为 yyyy-MM-dd HH:mm:ss。
        • notifyType
          String notifyType
          通知的类型。
        • outBizNo
          String outBizNo
          商户业务 ID，主要是退款通知中返回退款申请的流水号。
        • outTradeNo
          String outTradeNo
          原支付请求的商户订单号。
        • passbackParams
          String passbackParams
          公共回传参数，如果请求时传递了该参数，则返回给商家时会在异步通知时将该参数原样返回。本参数必须进行 UrlEncode 之后才可以发送给支付宝。
        • pointAmount
          String pointAmount
          使用集分宝支付的金额。
        • receiptAmount
          String receiptAmount
          商家在收益中实际收到的款项，单位人民币（元）。
        • refundFee
          String refundFee
          退款通知中，返回总退款金额，单位为人民币（元），支持两位小数。
        • sellerEmail
          String sellerEmail
          卖家支付宝账号。
        • sellerId
          String sellerId
          卖家支付宝用户号。
        • sign
          String sign
          签名。详情可查看 异步返回结果的验签。
        • signType
          String signType
          商家生成签名字符串所使用的签名算法类型，目前支持 RSA2 和 RSA，推荐使用 RSA2。
        • subject
          String subject
          商品的标题/交易标题/订单标题/订单关键字等，是请求时对应的参数，原样通知回来。
        • totalAmount
          String totalAmount
          本次交易支付的订单金额，单位为人民币（元）。
        • tradeNo
          String tradeNo
          支付宝交易凭证号。
        • tradeStatus
          String tradeStatus
          交易目前所处的状态。详情可查看 交易状态说明。
        • version
          String version
          调用的接口版本，固定为：1.0。
        • voucherDetailList
          String voucherDetailList
          本交易支付时所有优惠券信息，详情可查看 优惠券信息说明。

    • 类 com.abasecode.opencode.pay.plugin.alipay.entity.PayQueryParam

      class PayQueryParam extends Object implements Serializable

      • 序列化字段

        • outTradeNo
          String outTradeNo
          商户订单号
        • queryOptions
          String[] queryOptions
          查询选项，商户传入该参数可定制本接口同步响应额外返回的信息字段，数组格式。支持枚举如下： trade_settle_info：返回的交易结算信息，包含分账、补差等信息； fund_bill_list：交易支付使用的资金渠道； voucher_detail_list：交易支付时使用的所有优惠券信息； discount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息； mdiscount_amount：商家优惠金额；
        • tradeNo
          String tradeNo
          支付宝交易号

    • 类 com.abasecode.opencode.pay.plugin.alipay.entity.RefundChargeInfo

      class RefundChargeInfo extends Object implements Serializable
      serialVersionUID:
      -7839760887731476148L

      • 序列化字段

        • chargeType
          String chargeType
          收单手续费trade，花呗分期手续hbfq，其他手续费charge
        • refundChargeFee
          String refundChargeFee
          实退费用
        • refundSubFeeDetailList
          List<RefundSubFee> refundSubFeeDetailList
          组合支付退费明细
        • switchFeeRate
          String switchFeeRate
          签约费率

    • 类 com.abasecode.opencode.pay.plugin.alipay.entity.RefundSubFee

      class RefundSubFee extends Object implements Serializable
      serialVersionUID:
      4019628813337436556L

      • 序列化字段

        • refundChargeFee
          String refundChargeFee
          实退费用
        • switchFeeRate
          String switchFeeRate
          签约费率

    • 类 com.abasecode.opencode.pay.plugin.alipay.entity.TradeFundBill

      class TradeFundBill extends Object implements Serializable
      serialVersionUID:
      628157169205539619L

      • 序列化字段

        • amount
          String amount
          该支付工具类型所使用的金额
        • fundChannel
          String fundChannel
          交易使用的资金渠道，详见 支付渠道列表
        • fundType
          String fundType
          渠道所使用的资金类型,目前只在资金渠道(fund_channel)是银行卡渠道(BANKCARD)的情况下才返回该信息(DEBIT_CARD:借记卡,CREDIT_CARD:信用卡,MIXED_CARD:借贷合一卡)
        • realAmount
          String realAmount
          渠道实际付款金额

  • 程序包 com.abasecode.opencode.pay.plugin.alipay.form

    • 类 com.abasecode.opencode.pay.plugin.alipay.form.AlipayCloseOrderForm

      class AlipayCloseOrderForm extends Object implements Serializable

      • 序列化字段

        • operatorId
          String operatorId
          商家操作员编号 id，可选
        • outTradeNo
          String outTradeNo
          商户订单号（二选一）
        • tradeNo
          String tradeNo
          支付宝交易号（二选一）

    • 类 com.abasecode.opencode.pay.plugin.alipay.form.AlipayQueryForm

      class AlipayQueryForm extends Object implements Serializable

      • 序列化字段

        • outTradeNo
          String outTradeNo
          订单号
        • queryOptions
          List<String> queryOptions
          查询选项，商户传入该参数可定制本接口同步响应额外返回的信息字段，数组格式。支持枚举如下： trade_settle_info：返回的交易结算信息，包含分账、补差等信息； fund_bill_list：交易支付使用的资金渠道； voucher_detail_list：交易支付时使用的所有优惠券信息； discount_goods_detail：交易支付所使用的单品券优惠的商品优惠信息； mdiscount_amount：商家优惠金额；
        • tradeNo
          String tradeNo
          订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no

    • 类 com.abasecode.opencode.pay.plugin.alipay.form.AlipayRefundForm

      class AlipayRefundForm extends Object implements Serializable

      • 序列化字段

        • outRequestNo
          String outRequestNo
          退款请求号。 标识一次退款请求，需要保证在交易号下唯一，如需部分退款，则此参数必传。 针对同一次退款请求，如果调用接口失败或异常了，重试时需要保证退款请求号不能变更，防止该笔交易重复退款。支付宝会保证同样的退款请求号多次请求只会退一次。
        • outTradeNo
          String outTradeNo
          商户订单号
        • queryOptions
          List<String> queryOptions
          查询选项。 商户通过上送该参数来定制同步需要额外返回的信息字段，数组格式。支持： refund_detail_item_list：退款使用的资金渠道； deposit_back_info：触发银行卡冲退信息通知
        • refundAmount
          String refundAmount
          退款金额。 需要退款的金额，该金额不能大于订单金额，单位为元，支持两位小数。 注：如果正向交易使用了营销，该退款金额包含营销金额，支付宝会按业务规则分配营销和买家自有资金分别退多少，默认优先退买家的自有资金。 如交易总金额100元，用户支付时使用了80元自有资金和20元无资金流的营销券，商家实际收款80元。 如果首次请求退款60元，则60元全部从商家收款资金扣除退回给用户自有资产； 如果再请求退款40元，则从商家收款资金扣除20元退回用户资产以及把20元的营销券退回给用户（券是否可再使用取决于券的规则配置）。
        • refundReason
          String refundReason
          退款原因说明。 商家自定义，将在会在商户和用户的pc退款账单详情中展示
        • tradeNo
          String tradeNo
          支付宝交易号

    • 类 com.abasecode.opencode.pay.plugin.alipay.form.AlipayRefundQueryForm

      class AlipayRefundQueryForm extends Object implements Serializable
      serialVersionUID:
      -6663404660376537193L

      • 序列化字段

        • outRequestNo
          @NotEmpty String outRequestNo
          退款请求号。 请求退款接口时，传入的退款请求号，如果在退款请求时未传入，则该值为创建交易时的商户订单号。
        • outTradeNo
          String outTradeNo
          商户订单号。 订单支付时传入的商户订单号,和支付宝交易号不能同时为空。 trade_no,out_trade_no如果同时存在优先取trade_no
        • queryOptions
          List<String> queryOptions
          查询选项，商户通过上送该参数来定制同步需要额外返回的信息字段，数组格式。枚举支持： refund_detail_item_list：本次退款使用的资金渠道； gmt_refund_pay：退款执行成功的时间； deposit_back_info：银行卡冲退信息；
        • tradeNo
          String tradeNo
          支付宝交易号。 和商户订单号不能同时为空

  • 程序包 com.abasecode.opencode.pay.plugin.wechatpay.entity

  • 程序包 com.abasecode.opencode.pay.plugin.wechatpay.form