Module: CmbPay

Defined in:
lib/cmb_pay.rb,
lib/cmb_pay/sign.rb,
lib/cmb_pay/util.rb,
lib/cmb_pay/service.rb,
lib/cmb_pay/version.rb,
lib/cmb_pay/merchant_code.rb,
lib/cmb_pay/message/pay_message.rb,
lib/cmb_pay/message/bill_records_message.rb,
lib/cmb_pay/message/refund_order_message.rb,
lib/cmb_pay/message/single_order_message.rb

Defined Under Namespace

Modules: MerchantCode, Service, Sign, Util Classes: BillRecordsMessage, PayMessage, RefundOrderMessage, SingleOrderMessage

Constant Summary collapse

SUPPORTED_BANK = 
{
  '招商银行' => nil,
  '兴业银行' => 309,
  '中信银行' => 302,
  '中国民生银行' => 305,
  '光大银行' => 303,
  '华夏银行' => 304,
  '北京农村商业银行' => 1418,
  '深圳发展银行' => 307,
  '中国银行' => 104,
  '北京银行' => 403,
  '中国邮政储蓄银行' => 100,
  '上海浦东发展银行' => 310,
  '东亚银行' => 2502,
  '广东发展银行' => 306,
  '南京银行' => 424,
  '上海交通银行' => 301,
  '平安银行' => 410,
  '中国工商银行' => 102,
  '杭州银行' => 423,
  '中国建设银行' => 105,
  '宁波银行' => 408,
  '中国农业银行' => 103,
  '浙商银行' => 316,
  '渤海银行' => 318,
  '上海农村商业银行' => 402,
  '上海银行' => 313
}.freeze
SUPPORTED_BANK_EN = 
{
  'China Merchants Bank' => nil,
  'Industrial Bank Co.,Ltd' => 309,
  'China Citic Bank' => 302,
  'China Minsheng Bank' => 305,
  'China Everbright Bank' => 303,
  'Huaxia Bank' => 304,
  'Beijing Rural Commercial Bank' => 1418,
  'Shenzhen Development Bank' => 307,
  'Bank of China' => 104,
  'Bank of Beijing' => 403,
  'Postal Savings Bank of China' => 100,
  'SPD Bank' => 310,
  'BEA Bank of East Asia Limited' => 2502,
  'CGB China Guangfa Bank' => 306,
  'Bank of Nanjing' => 424,
  'Bank of Communications' => 301,
  'Ping An Bank' => 410,
  'ICBC Industrial And Commercial Bank of China' => 102,
  'HCCB Bank of Hangzhou' => 423,
  'China Construction Bank' => 105,
  'Bank of Ningbo' => 408,
  'ABC Agricultural Bank of China' => 103,
  'China Zheshang Bank' => 316,
  'China Bohai Bank' => 318,
  'Shanghai Rural Commercial Bank Co., Ltd.' => 402,
  'Bank of Shanghai' => 313
}.freeze
GOODS_TYPE = 
{
  '网上支付' => 54_011_600,
  '充值缴费' => 54_011_610,
  '彩票' => 54_011_611,
  '话费' => 54_011_612,
  '虚拟商品' => 54_011_620,
  '游戏点卡' => 54_011_621,
  '旅游出行' => 54_010_6,
  '酒店' => 54_010_650,
  '机票' => 54_010_651,
  '服装' => 54_010_5,
  '文化教育' => 54_011_630,
  '书报杂志' => 54_011_631,
  '考试培训' => 54_011_632,
  '数码产品' => 54_011_640,
  '护肤化妆' => 54_010_7,
  '母婴用品' => 54_011_650,
  '生活日用' => 54_010_111,
  '食品' => 54_010_112,
  '汽车费用' => 54_010_2,
  '信用卡还款' => 54_010_306, # 此商品类型只允许使用借记卡支付
  '保险' => 54_011_1,
  '家居物品' => 54_011_2,
  '医疗保健' => 54_012_2,
  '礼品' => 54_012_3,
  '办公设备' => 54_011_660,
  '家用电器' => 54_011_670,
  '体育用品' => 54_011_680,
  '娱乐休闲' => 54_010_8,
  '网络服务' => 54_011_690,
  '收藏爱好' => 54_011_691,
  '投资理财' => 54_011_692
}.freeze
VERSION = 
'1.1.0'.freeze

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.branch_id ⇒ Object

开户分行号



17
18
19
 
# File 'lib/cmb_pay.rb', line 17

def branch_id
  @branch_id
end

.co_key ⇒ Object

商户校验码/商户密钥，测试环境为空



19
20
21
 
# File 'lib/cmb_pay.rb', line 19

def co_key
  @co_key
end

.co_no ⇒ Object

支付商户号/收单商户号



18
19
20
 
# File 'lib/cmb_pay.rb', line 18

def co_no
  @co_no
end

.default_goods_type ⇒ Object

默认收款方的商品类型



26
27
28
 
# File 'lib/cmb_pay.rb', line 26

def default_goods_type
  @default_goods_type
end

.default_payee_id ⇒ Object

默认收款方的用户标识



25
26
27
 
# File 'lib/cmb_pay.rb', line 25

def default_payee_id
  @default_payee_id
end

.environment ⇒ Object

调用的招商银行支付环境，默认生产，测试填test



24
25
26
 
# File 'lib/cmb_pay.rb', line 24

def environment
  @environment
end

.expire_in_minutes ⇒ Object

会话有效时间



23
24
25
 
# File 'lib/cmb_pay.rb', line 23

def expire_in_minutes
  @expire_in_minutes
end

.mch_no ⇒ Object

协议商户企业编号，或者说是8位虚拟企业网银编号



20
21
22
 
# File 'lib/cmb_pay.rb', line 20

def mch_no
  @mch_no
end

.one_cent_as_newspaper ⇒ Object

仅支付一分钱，商品类型直接归类到书报杂志，方便在生产上做快速测试和对账，默认启用



27
28
29
 
# File 'lib/cmb_pay.rb', line 27

def one_cent_as_newspaper
  @one_cent_as_newspaper
end

.operator ⇒ Object

操作员号，一般是9999



21
22
23
 
# File 'lib/cmb_pay.rb', line 21

def operator
  @operator
end

.operator_password ⇒ Object

操作员的密码，默认是支付商户号，但建议修改。



22
23
24
 
# File 'lib/cmb_pay.rb', line 22

def operator_password
  @operator_password
end

Class Method Details

.build_direct_request_x_head(cmb_command, branch_id, co_no, time_stamp, with_operator: false, operator: nil, operator_password: nil) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/cmb_pay.rb', line 215

def self.build_direct_request_x_head(cmb_command, branch_id, co_no, time_stamp,
                                     with_operator: false, operator: nil, operator_password: nil)
  branch_id = CmbPay.branch_id if branch_id.nil?
  co_no = CmbPay.co_no if co_no.nil?
  if with_operator
    operator = CmbPay.operator if operator.nil?
    operator_password = CmbPay.operator_password if operator_password.nil?
    "<BranchNo>#{branch_id}</BranchNo><MerchantNo>#{co_no}</MerchantNo><Operator>#{operator}</Operator><Password>#{operator_password}</Password><TimeStamp>#{Util.cmb_timestamp(t: time_stamp)}</TimeStamp><Command>#{cmb_command}</Command>"
  else
    "<BranchNo>#{branch_id}</BranchNo><MerchantNo>#{co_no}</MerchantNo><TimeStamp>#{Util.cmb_timestamp(t: time_stamp)}</TimeStamp><Command>#{cmb_command}</Command>"
  end
end

.build_direct_request_x_query_body(begin_date, end_date, count, operator, pos) ⇒ Object 



228
229
230
231
232
233
 
# File 'lib/cmb_pay.rb', line 228

def self.build_direct_request_x_query_body(begin_date, end_date, count, operator, pos)
  operator = '9999' if operator.nil?
  begin_date = begin_date.strftime('%Y%m%d') unless begin_date.is_a?(String)
  end_date = end_date.strftime('%Y%m%d') unless end_date.is_a?(String)
  "<BeginDate>#{begin_date}</BeginDate><EndDate>#{end_date}</EndDate><Count>#{count}</Count><Operator>#{operator}</Operator><pos>#{pos}</pos>"
end

.encode_goods_type(goods_type) ⇒ Object 



298
299
300
301
 
# File 'lib/cmb_pay.rb', line 298

def self.encode_goods_type(goods_type)
  return goods_type if /^\d+$/ =~ goods_type.to_s
  GOODS_TYPE[goods_type]
end

.generate_cmb_card_bank_xml(card_bank) ⇒ Object 



290
291
292
293
294
295
296
 
# File 'lib/cmb_pay.rb', line 290

def self.generate_cmb_card_bank_xml(card_bank)
  return "<CardBank>#{format('%04d', card_bank.to_i)}</CardBank>" if /^\d+$/ =~ card_bank.to_s
  card_back_id = SUPPORTED_BANK[card_bank]
  card_back_id = SUPPORTED_BANK_EN[card_bank] if card_back_id.nil?
  return nil if card_back_id.nil?
  "<CardBank>#{format('%04d', card_back_id)}</CardBank>"
end

.generate_pay_link_of(pay_type, payer_id, bill_no, amount_in_cents, merchant_url, merchant_para, protocol, merchant_ret_url, merchant_ret_para, card_bank, options) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/cmb_pay.rb', line 243

def self.generate_pay_link_of(pay_type, payer_id, bill_no, amount_in_cents, merchant_url, merchant_para,
                              protocol, merchant_ret_url, merchant_ret_para, card_bank, options)
  branch_id = options.delete(:branch_id) || CmbPay.branch_id
  co_no = options.delete(:co_no) || CmbPay.co_no
  co_key = options.delete(:co_key) || CmbPay.co_key
  mch_no = options.delete(:mch_no) || CmbPay.mch_no
  cmb_bill_no = Util.cmb_bill_no(bill_no)
  expire_in_minutes = options.delete(:expire_in_minutes) || CmbPay.expire_in_minutes
  pay_in_yuan, pay_in_cent = amount_in_cents.to_i.divmod(100)
  pay_amount = "#{pay_in_yuan}.#{format('%02d', pay_in_cent)}"
  cmb_merchant_para = Service.encode_merchant_para(merchant_para)
  trade_date = options.delete(:trade_date) || Time.now.strftime('%Y%m%d')
  payee_id = options.delete(:payee_id) || CmbPay.default_payee_id
  goods_type = if amount_in_cents == 1 && CmbPay.one_cent_as_newspaper == true
                 '书报杂志'
               else
                 options.delete(:goods_type) || CmbPay.default_goods_type
               end
  random = options.delete(:random)
  if protocol.is_a?(Hash) && !payer_id.nil?
    cmb_reserved_xml = "<Protocol><PNo>#{protocol['PNo']}</PNo><TS>#{protocol['TS'] || Time.now.strftime('%Y%m%d%H%M%S')}</TS><MchNo>#{mch_no}</MchNo><Seq>#{protocol['Seq']}</Seq><MUID>#{payer_id}</MUID><URL>#{merchant_url}</URL><Para>#{cmb_merchant_para}</Para></Protocol>"
  else
    cmb_reserved_xml = generate_cmb_card_bank_xml(card_bank)
    payee_id = nil
  end
  m_code = MerchantCode.generate(random: random, strkey: co_key, date: trade_date,
                                 branch_id: branch_id, co_no: co_no,
                                 bill_no: cmb_bill_no, amount: pay_amount,
                                 merchant_para: cmb_merchant_para, merchant_url: merchant_url,
                                 payer_id: payer_id, payee_id: payee_id, goods_type: encode_goods_type(goods_type),
                                 reserved: cmb_reserved_xml)
  uri_params = {
    'BranchID' => branch_id,
    'CoNo'     => co_no,
    'BillNo'   => cmb_bill_no,
    'Amount'   => pay_amount,
    'Date'     => trade_date,
    'ExpireTimeSpan' => expire_in_minutes,
    'MerchantUrl' => merchant_url,
    'MerchantPara' => cmb_merchant_para,
    'MerchantCode' => m_code
  }
  uri_params['MerchantRetUrl'] = merchant_ret_url unless merchant_ret_url.nil?
  uri_params['MerchantRetPara'] = Service.encode_merchant_para(merchant_ret_para) unless merchant_ret_para.nil?
  Service.request_uri(pay_type, uri_params)
end

.hash_and_direct_request_x(co_key, head_inner_xml, body_inner_xml) ⇒ Object 



235
236
237
238
239
240
241
 
# File 'lib/cmb_pay.rb', line 235

def self.hash_and_direct_request_x(co_key, head_inner_xml, body_inner_xml)
  co_key = CmbPay.co_key if co_key.nil?
  hash_input = "#{co_key}#{head_inner_xml}#{body_inner_xml}"
  hash_xml = "<Hash>#{Sign.sha1_digest(hash_input)}</Hash>"
  request_xml = "<Request><Head>#{head_inner_xml}</Head><Body>#{body_inner_xml}</Body>#{hash_xml}</Request>"
  HTTP.post(Service.request_gateway_url(:DirectRequestX), form: { 'Request' => request_xml })
end

.pay_message(query_string) ⇒ Object 



156
157
158
 
# File 'lib/cmb_pay.rb', line 156

def self.pay_message(query_string)
  PayMessage.new query_string
end

.query_order_by_cmb_command(cmb_command, begin_date, end_date, count, operator, pos, branch_id, co_no, co_key, time_stamp) ⇒ Object 



207
208
209
210
211
212
213
 
# File 'lib/cmb_pay.rb', line 207

def self.query_order_by_cmb_command(cmb_command, begin_date, end_date, count, operator, pos,
                                    branch_id, co_no, co_key, time_stamp)
  head_inner_xml = build_direct_request_x_head(cmb_command, branch_id, co_no, time_stamp)
  body_inner_xml = build_direct_request_x_query_body(begin_date, end_date, count, operator, pos)
  http_response = hash_and_direct_request_x(co_key, head_inner_xml, body_inner_xml)
  BillRecordsMessage.new(http_response)
end

.query_settled_order_by_merchant_date(begin_date:, end_date:, count:, operator: nil, pos: nil, branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil) ⇒ Object

按商户日期查询已结账订单接口



194
195
196
197
 
# File 'lib/cmb_pay.rb', line 194

def self.query_settled_order_by_merchant_date(begin_date:, end_date:, count:, operator: nil, pos: nil,
                                              branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil)
  query_order_by_cmb_command('QuerySettledOrderByMerchantDate', begin_date, end_date, count, operator, pos, branch_id, co_no, co_key, time_stamp)
end

.query_settled_order_by_settled_date(begin_date:, end_date:, count:, operator: nil, pos: nil, branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil) ⇒ Object

按结账日期查询已结账订单接口



200
201
202
203
 
# File 'lib/cmb_pay.rb', line 200

def self.query_settled_order_by_settled_date(begin_date:, end_date:, count:, operator: nil, pos: nil,
                                             branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil)
  query_order_by_cmb_command('QuerySettledOrderBySettledDate', begin_date, end_date, count, operator, pos, branch_id, co_no, co_key, time_stamp)
end

.query_single_order(bill_no:, trade_date: nil, branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil) ⇒ Object

单笔定单查询接口



176
177
178
179
180
181
182
183
 
# File 'lib/cmb_pay.rb', line 176

def self.query_single_order(bill_no:, trade_date: nil,
                            branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil)
  trade_date = Time.now.strftime('%Y%m%d') if trade_date.nil?
  head_inner_xml = build_direct_request_x_head('QuerySingleOrder', branch_id, co_no, time_stamp)
  body_inner_xml = "<Date>#{trade_date}</Date><BillNo>#{Util.cmb_bill_no(bill_no)}</BillNo>"
  http_response = hash_and_direct_request_x(co_key, head_inner_xml, body_inner_xml)
  SingleOrderMessage.new(http_response)
end

.query_transact(begin_date:, end_date:, count:, operator: nil, pos: nil, branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil) ⇒ Object

商户入账查询接口pos: 当<QryLopFlg>Y</QryLopFlg>续传标记为Y时（表示仍有后续的通讯包，采用多次通讯方式续传时使用)

填写<QryLopBlk>续传包请求数据</QryLopBlk>中的数据



188
189
190
191
 
# File 'lib/cmb_pay.rb', line 188

def self.query_transact(begin_date:, end_date:, count:, operator: nil, pos: nil,
                        branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil)
  query_order_by_cmb_command('QueryTransact', begin_date, end_date, count, operator, pos, branch_id, co_no, co_key, time_stamp)
end

.refund_no_dup(bill_no:, refund_no:, refund_amount_in_cents:, memo:, bill_date: nil, operator: nil, operator_password: nil, branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil) ⇒ Object

退款接口



161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cmb_pay.rb', line 161

def self.refund_no_dup(bill_no:, refund_no:, refund_amount_in_cents:, memo:,
                       bill_date: nil, operator: nil, operator_password: nil,
                       branch_id: nil, co_no: nil, co_key: nil, time_stamp: nil)
  refund_in_yuan, refund_in_cent = refund_amount_in_cents.to_i.divmod(100)
  refund_amount = "#{refund_in_yuan}.#{format('%02d', refund_in_cent)}"
  desc = memo.encode(xml: :text)
  bill_date = Time.now.strftime('%Y%m%d') if bill_date.nil?
  head_inner_xml = build_direct_request_x_head('Refund_No_Dup', branch_id, co_no, time_stamp,
                                               with_operator: true, operator: operator, operator_password: operator_password)
  body_inner_xml = "<Date>#{bill_date}</Date><BillNo>#{Util.cmb_bill_no(bill_no)}</BillNo><RefundNo>#{Util.cmb_bill_no(refund_no)}</RefundNo><Amount>#{refund_amount}</Amount><Desc>#{desc}</Desc>"
  http_response = hash_and_direct_request_x(co_key, head_inner_xml, body_inner_xml)
  RefundOrderMessage.new(http_response)
end

.uri_of_pre_pay_c2(bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil, merchant_ret_url:, merchant_ret_para: nil, card_bank: nil, options: {}) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/cmb_pay.rb', line 138

def self.uri_of_pre_pay_c2(bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil,
                           merchant_ret_url:, merchant_ret_para: nil, card_bank: nil,
                           options: {})
  generate_pay_link_of('PrePayC2',
                       nil, bill_no, amount_in_cents, merchant_url, merchant_para,
                       nil, merchant_ret_url, merchant_ret_para, card_bank,
                       options)
end

.uri_of_pre_pay_euserp(payer_id:, bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil, protocol:, merchant_ret_url:, merchant_ret_para: nil, options: {}) ⇒ Object 



129
130
131
132
133
134
135
136
 
# File 'lib/cmb_pay.rb', line 129

def self.uri_of_pre_pay_euserp(payer_id:, bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil,
                               protocol:, merchant_ret_url:, merchant_ret_para: nil,
                               options: {})
  generate_pay_link_of('PrePayEUserP',
                       payer_id, bill_no, amount_in_cents, merchant_url, merchant_para,
                       protocol, merchant_ret_url, merchant_ret_para, nil,
                       options)
end

.uri_of_pre_pay_wap(bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil, merchant_ret_url:, merchant_ret_para: nil, card_bank: nil, options: {}) ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/cmb_pay.rb', line 147

def self.uri_of_pre_pay_wap(bill_no:, amount_in_cents:, merchant_url:, merchant_para: nil,
                            merchant_ret_url:, merchant_ret_para: nil, card_bank: nil,
                            options: {})
  generate_pay_link_of('PrePayWAP',
                       nil, bill_no, amount_in_cents, merchant_url, merchant_para,
                       nil, merchant_ret_url, merchant_ret_para, card_bank,
                       options)
end