wechat-ipay 2.0.0

data/lib/wechat-pay/ecommerce/applyment.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module WechatPay
+  # 商户进件相关
+  module Ecommerce
+    # 二级商户进件
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter11_1_1.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # params = {
+    #   "organization_type": "2",
+    #   "business_license_info": {
+    #     "business_license_copy": "47ZC6GC-vnrbEg05InE4d2I6_H7I4",
+    #     "business_license_number": "123456789012345678",
+    #     "merchant_name": "腾讯科技有限公司",
+    #     "legal_person": "张三"
+    #   },
+    #   "organization_cert_info": {
+    #     "organization_copy": "47ZC6GC-vnrbEny__Ie_An5-tCpqxuGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4 ",
+    #     "organization_time": "[\"2014-01-01\",\"长期\"]",
+    #     "organization_number": "12345679-A"
+    #   },
+    #   "id_card_info": {
+    #     "id_card_copy": "jTpGmxUX3FBWVQ5NJTZvlKC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ",
+    #     "id_card_national": "47ZC6GC-vnrbEny__Ie_AnGprrKhpVBDIUv0OF4wFNIO4kqg05InE4d2I6_H7I4",
+    #     "id_card_name": "pVd1HJ6z7UtC + xriudjD5AqhZ9evAM + Jv1z0NVa8MRtelw / wDa4SzfeespQO / 0 kjiwfqdfg =",
+    #     "id_card_number": "UZFETyabYFFlgvGh6R4vTzDRgzvA2HtP5VHahNhSUqhR9iuGTunRPRVFg ==",
+    #     "id_card_valid_time": "2026-06-06"
+    #   },
+    #   "need_account_info": true,
+    #   "account_info": {
+    #     "bank_account_type": "74",
+    #     "account_name": "fTA4TXc8yMOwFCYeGPktOOSbOBei3KAmUWHGxCQo2hfaC7xumTqXR7 / NyRHpFKXURQFcmmw ==",
+    #     "account_bank": "工商银行",
+    #     "bank_address_code": "110000",
+    #     "bank_branch_id": "402713354941",
+    #     "bank_name": "施秉县农村信用合作联社城关信用社",
+    #     "account_number": "d+xT+MQCvrLHUVD5Fnx30mr4L8sPndjXTd75kPkyjqnoMRrEEaYQE8ZRGYoeorwC"
+    #   },
+    #   "contact_info": {
+    #     "contact_type": "65",
+    #     "contact_name": "pVd1HJ6zyvPedzGaV+Xy7UDa4SzfeespQO / 0 kjiwfqdfg ==",
+    #     "contact_id_card_number": "UZFETyabYFFlgvGh6R4vTzDEOiZZ4ka9+5RgzvA2rJx+NztYUbN209rqR9iuGTunRPRVFg ==",
+    #     "mobile_phone": "Uy5Hb0c5Se/orEbrWze/ROHu9EPAs/CigDlJ2fnyzC1ppJNBrqcBszhYQUlu5zn6o2uZpBhAsQwd3QAjw==",
+    #     "contact_email": "Uy5Hb0c5Se/orEbrWze/ROHu9EPAs/CigDlJ2fnyzC1ppJNaLZExOEzmUn6o2uZpBhAsQwd3QAjw=="
+    #   },
+    #   "sales_scene_info": {
+    #     "store_name": "爱烧烤",
+    #     "store_url": "http://www.qq.com",
+    #     "store_qr_code": "jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAujqhThn4ReFxikqJ5YW6zFQ"
+    #   },
+    #   "merchant_shortname": "爱烧烤",
+    #   "out_request_no": "APPLYMENT_00000000001",
+    #   "qualifications": "[\"jTpGmxUX3FBWVQ5NJInE4d2I6_H7I4\"]",
+    #   "business_addition_pics": "[\"jTpGmg05InE4d2I6_H7I4\"]",
+    #   "business_addition_desc": "特殊情况，说明原因"
+    # }
+    # ```
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.applyment(params)
+    # ```
+    #
+    def self.applyment(payload)
+      url = '/v3/ecommerce/applyments/'
+      method = 'POST'
+
+      payload_json = payload.to_json
+
+      make_request(
+        method: method,
+        path: url,
+        for_sign: payload_json,
+        payload: payload_json,
+        extra_headers: {
+          'Wechatpay-Serial' => WechatPay.platform_serial_no
+        }
+      )
+    end
+
+    QUERY_APPLYMENT_FIELDS = %i[applyment_id out_request_no].freeze # :nodoc:
+    #
+    # 通过商户的申请单或微信的申请单号查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter11_1_2.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_applyment(out_request_no: 'APPLYMENT_00000000005') # by out_request_no
+    # WechatPay::Ecommerce.query_applyment(applyment_id: '200040444455566667') # by_applyment_id
+    # ```
+    #
+    def self.query_applyment(params)
+      if params[:applyment_id]
+        applyment_id = params.delete(:applyment_id)
+        url = "/v3/ecommerce/applyments/#{applyment_id}"
+      else
+        out_request_no = params.delete(:out_request_no)
+        url = "/v3/ecommerce/applyments/out-request-no/#{out_request_no}"
+      end
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    # 证书获取
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_1_3.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.certificates
+    # ```
+    #
+    def self.certificates
+      url = '/v3/certificates'
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    INVOKE_QUERY_SETTLEMENT_FIELDS = [:sub_mchid].freeze # :nodoc:
+    #
+    # 查询结算账户
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_1_5.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_settlement(sub_mchid: '16000000')
+    # ```
+    #
+    def self.query_settlement(params)
+      sub_mchid = params.delete(:sub_mchid)
+      url = "/v3/apply4sub/sub_merchants/#{sub_mchid}/settlement"
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    INVOKE_MODIFY_SETTLEMENT_FIELDS = %i[sub_mchid account_type account_bank bank_address_code account_number].freeze # :nodoc:
+    #
+    # 修改结算账号
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_1_4.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.modify_settlement(sub_mchid: '15000000', account_type: 'ACCOUNT_TYPE_PRIVATE', account_bank: '工商银行', bank_address_code: '110000', account_number: WechatPay::Sign.sign_important_info('755555555'))
+    # ```
+    #
+    def self.modify_settlement(params)
+      sub_mchid = params.delete(:sub_mchid)
+      url = "/v3/apply4sub/sub_merchants/#{sub_mchid}/modify-settlement"
+      method = 'POST'
+
+      payload_json = params.to_json
+
+      make_request(
+        method: method,
+        path: url,
+        for_sign: payload_json,
+        payload: payload_json,
+        extra_headers: {
+          'Wechatpay-Serial' => WechatPay.platform_serial_no
+        }
+      )
+    end
+  end
+end

data/lib/wechat-pay/ecommerce/balance.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+module WechatPay
+  # 余额相关
+  module Ecommerce
+    QUERY_REALTIME_BALANCE_FIELDS = [:sub_mchid].freeze # :nodoc:
+    #
+    # 余额实时查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_7_1.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_realtime_balance(sub_mchid: '1600000')
+    # ```
+    def self.query_realtime_balance(params)
+      sub_mchid = params.delete(:sub_mchid)
+      url = "/v3/ecommerce/fund/balance/#{sub_mchid}"
+      method = 'GET'
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    QUERY_ENDDAY_BALANCE_FIELDS = %i[sub_mchid date].freeze # :nodoc:
+    #
+    # 日终余额查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_7_2.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_endday_balance(sub_mchid: '1600000', date: '2019-08-17')
+    # ```
+    def self.query_endday_balance(params)
+      sub_mchid = params.delete(:sub_mchid)
+      path = "/v3/ecommerce/fund/balance/#{sub_mchid}"
+      method = 'GET'
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    QUERY_PLATFORM_REALTIME_BALANCE_FIELDS = %i[account_type].freeze # :nodoc:
+    #
+    # 平台商户实时余额
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_7_3.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_platform_realtime_balance(account_type: 'BASIC') # basic account
+    # WechatPay::Ecommerce.query_platform_realtime_balance(account_type: 'FEES') # fees account
+    # ```
+    #
+    def self.query_platform_realtime_balance(params)
+      account_type = params.delete(:account_type)
+      url = "/v3/merchant/fund/balance/#{account_type}"
+      method = 'GET'
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    QUERY_PLATFORM_ENDDAY_BALANCE_FIELDS = %i[account_type date].freeze # :nodoc:
+    #
+    # 平台商户日终余额
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_7_4.shtml
+    #
+    # Example:
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_platform_endday_balance(account_type: 'BASIC')
+    # WechatPay::Ecommerce.query_platform_endday_balance(account_type: 'FEES')
+    # ```
+    #
+    def self.query_platform_endday_balance(params)
+      account_type = params.delete(:account_type)
+      path = "/v3/merchant/fund/dayendbalance/#{account_type}"
+      method = 'GET'
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        path: url,
+        method: method,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+  end
+end

data/lib/wechat-pay/ecommerce/bill.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module WechatPay
+  # 账单相关
+  module Ecommerce
+    class << self
+      TRADEBILL_FIELDS = [:bill_date].freeze # :nodoc:
+      #
+      # 申请交易账单
+      #
+      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_9_1.shtml
+      #
+      # Example:
+      #
+      # ``` ruby
+      # WechatPay::Ecommerce.tradebill(bill_date: '2021-04-30')
+      # ```
+      def tradebill(params)
+        path = '/v3/bill/tradebill'
+        method = 'GET'
+
+        query = build_query(params)
+        url = "#{path}?#{query}"
+
+        make_request(
+          path: url,
+          method: method,
+          extra_headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded'
+          }
+        )
+      end
+
+      FUNDFLOWBILL_FIELDS = [:bill_date].freeze # :nodoc:
+      #
+      # 申请资金账单
+      #
+      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_9_2.shtml
+      #
+      # Example:
+      #
+      # ``` ruby
+      # WechatPay::Ecommerce.fundflowbill(bill_date: '2021-04-30')
+      # ```
+      #
+      def fundflowbill(params)
+        path = '/v3/bill/fundflowbill'
+        method = 'GET'
+
+        query = build_query(params)
+        url = "#{path}?#{query}"
+
+        make_request(
+          path: url,
+          method: method,
+          extra_headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded'
+          }
+        )
+      end
+
+      ECOMMERCE_FUNDFLOWBILL_FIELDS = %i[bill_date account_type algorithm].freeze # :nodoc:
+      #
+      # 二级商户资金账单
+      #
+      # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_9_5.shtml
+      #
+      # Example:
+      #
+      # ``` ruby
+      # WechatPay::Ecommerce.ecommerce_fundflowbill(bill_date: '2021-04-30', account_type: 'ALL', algorithm: 'AEAD_AES_256_GCM')
+      # ```
+      #
+      def ecommerce_fundflowbill(params)
+        path = '/v3/ecommerce/bill/fundflowbill'
+        method = 'GET'
+
+        query = build_query(params)
+        url = "#{path}?#{query}"
+
+        make_request(
+          path: url,
+          method: method,
+          extra_headers: {
+            'Content-Type' => 'application/x-www-form-urlencoded'
+          }
+        )
+      end
+    end
+  end
+end

data/lib/wechat-pay/ecommerce/combine_order.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module WechatPay
+  # 合并订单相关
+  module Ecommerce
+    # @private
+    # @!macro [attach] define_transaction_method
+    #   $1合单
+    #
+    #   Document: $3
+    #
+    #   Example:
+    #
+    #   ``` ruby
+    #   params = {
+    #     combine_out_trade_no: 'combine_out_trade_no',
+    #     combine_payer_info: {
+    #       openid: 'client open id'
+    #     },
+    #     sub_orders: [
+    #       {
+    #         mchid: 'mchid',
+    #         sub_mchid: 'sub mchid',
+    #         attach: 'attach',
+    #         amount: {
+    #           total_amount: 100,
+    #           currency: 'CNY'
+    #         },
+    #         out_trade_no: 'out_trade_no',
+    #         description: 'description'
+    #       }
+    #     ],
+    #     notify_url: 'the_url'
+    #   }
+    #
+    #   WechatPay::Ecommerce.invoke_combine_transactions_in_$1(params)
+    #   ```
+    #   @!method invoke_combine_transactions_in_$1
+    #   @!scope class
+    def self.define_combine_transaction_method(key, value, _document)
+      const_set("INVOKE_COMBINE_TRANSACTIONS_IN_#{key.upcase}_FIELDS",
+                %i[combine_out_trade_no combine_payer_info sub_orders notify_url].freeze)
+      define_singleton_method("invoke_combine_transactions_in_#{key}") do |params|
+        combine_transactions_method_by_suffix(value, params)
+      end
+    end
+
+    define_combine_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_3.shtml')
+    define_combine_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_2.shtml')
+    define_combine_transaction_method('native', 'native', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_5.shtml')
+    define_combine_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_1.shtml')
+    define_combine_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_4.shtml')
+
+    QUERY_COMBINE_ORDER_FIELDS = %i[combine_out_trade_no].freeze # :nodoc:
+    #
+    # 合单查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_11.shtml
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_order(combine_out_trade_no: 'C202104302474')
+    # ```
+    #
+    def self.query_combine_order(params)
+      combine_out_trade_no = params.delete(:combine_out_trade_no)
+
+      url = "/v3/combine-transactions/out-trade-no/#{combine_out_trade_no}"
+
+      method = 'GET'
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    CLOSE_COMBINE_ORDER_FIELDS = %i[combine_out_trade_no sub_orders].freeze # :nodoc:
+    #
+    # 关闭合单
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_3_11.shtml
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.close_combine_order(combine_out_trade_no: 'C202104302474')
+    # ```
+    def self.close_combine_order(params)
+      combine_out_trade_no = params.delete(:combine_out_trade_no)
+
+      url = "/v3/combine-transactions/out-trade-no/#{combine_out_trade_no}/close"
+
+      payload = {
+        combine_appid: WechatPay.app_id
+      }.merge(params)
+
+      payload_json = payload.to_json
+
+      method = 'POST'
+
+      make_request(
+        method: method,
+        for_sign: payload_json,
+        payload: payload_json,
+        path: url
+      )
+    end
+
+    class << self
+      private
+
+      def combine_transactions_method_by_suffix(suffix, params)
+        url = "/v3/combine-transactions/#{suffix}"
+        method = 'POST'
+
+        params = {
+          combine_mchid: WechatPay.mch_id,
+          combine_appid: WechatPay.app_id
+        }.merge(params)
+
+        payload_json = params.to_json
+
+        make_request(
+          method: method,
+          path: url,
+          for_sign: payload_json,
+          payload: payload_json
+        )
+      end
+    end
+  end
+end

data/lib/wechat-pay/ecommerce/order.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module WechatPay
+  # 订单相关
+  module Ecommerce
+    # @private
+    # @!macro [attach] define_transaction_method
+    #   $1下单
+    #
+    #   Document: $3
+    #
+    #   Example:
+    #
+    #   ```
+    #   params = {
+    #     description: 'pay',
+    #     out_trade_no: 'Order Number',
+    #     payer: {
+    #       sp_openid: 'wechat open id'
+    #     },
+    #     amount: {
+    #       total: 10
+    #     },
+    #     sub_mchid: 'Your sub mchid',
+    #     notify_url: 'the url'
+    #   }
+    #
+    #   WechatPay::Ecommerce.invoke_transactions_in_$1(params)
+    #   ```
+    #   @!method invoke_transactions_in_$1
+    #   @!scope class
+    def self.define_transaction_method(key, value, _document)
+      const_set("INVOKE_TRANSACTIONS_IN_#{key.upcase}_FIELDS",
+                %i[sub_mchid description out_trade_no notify_url amount].freeze)
+      define_singleton_method("invoke_transactions_in_#{key}") do |params|
+        transactions_method_by_suffix(value, params)
+      end
+    end
+
+    define_transaction_method('native', 'native', 'document missing')
+    define_transaction_method('js', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_2.shtml')
+    define_transaction_method('app', 'app', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_1.shtml')
+    define_transaction_method('h5', 'h5', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_4.shtml')
+    define_transaction_method('miniprogram', 'jsapi', 'https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_3.shtml')
+
+    QUERY_ORDER_FIELDS = %i[sub_mchid out_trade_no transaction_id].freeze # :nodoc:
+    #
+    # 订单查询
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_5.shtml
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.query_order(sub_mchid: '16000008', transaction_id: '4323400972202104305133344444') # by transaction_id
+    # WechatPay::Ecommerce.query_order(sub_mchid: '16000008', out_trade_no: 'N202104302474') # by out_trade_no
+    # ```
+    #
+    def self.query_order(params)
+      if params[:transaction_id]
+        params.delete(:out_trade_no)
+        transaction_id = params.delete(:transaction_id)
+        path = "/v3/pay/partner/transactions/id/#{transaction_id}"
+      else
+        params.delete(:transaction_id)
+        out_trade_no = params.delete(:out_trade_no)
+        path = "/v3/pay/partner/transactions/out-trade-no/#{out_trade_no}"
+      end
+
+      params = params.merge({
+                              sp_mchid: WechatPay.mch_id
+                            })
+
+      method = 'GET'
+      query = build_query(params)
+      url = "#{path}?#{query}"
+
+      make_request(
+        method: method,
+        path: url,
+        extra_headers: {
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      )
+    end
+
+    CLOSE_ORDER_FIELDS = %i[sub_mchid out_trade_no].freeze # :nodoc:
+    #
+    # 关闭订单
+    #
+    # Document: https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_2_6.shtml
+    #
+    # ``` ruby
+    # WechatPay::Ecommerce.close_order(sub_mchid: '16000008', out_trade_no: 'N3344445')
+    # ```
+    #
+    def self.close_order(params)
+      out_trade_no = params.delete(:out_trade_no)
+      url = "/v3/pay/partner/transactions/out-trade-no/#{out_trade_no}/close"
+      params = params.merge({
+                              sp_mchid: WechatPay.mch_id
+                            })
+
+      method = 'POST'
+
+      make_request(
+        method: method,
+        path: url,
+        for_sign: params.to_json,
+        payload: params.to_json
+      )
+    end
+
+    class << self
+      private
+
+      def transactions_method_by_suffix(suffix, params)
+        url = "/v3/pay/partner/transactions/#{suffix}"
+        method = 'POST'
+
+        params = {
+          sp_appid: WechatPay.app_id,
+          sp_mchid: WechatPay.mch_id
+        }.merge(params)
+
+        payload_json = params.to_json
+
+        make_request(
+          method: method,
+          path: url,
+          for_sign: payload_json,
+          payload: payload_json
+        )
+      end
+    end
+  end
+end