Alipay

A unofficial alipay ruby gem.

Alipay official document: https://b.alipay.com/order/techService.htm .

Installation

Add this line to your application's Gemfile:

gem 'alipay', '~> 0.8.0'

And then execute:

$ bundle

Configuration

Alipay.pid = 'YOUR_PID'
Alipay.key = 'YOUR_KEY'

#Alipay.sign_type = 'MD5' # Available values: MD5, RSA. Default is MD5
#Alipay.debug_mode = true # Enable parameter check. Default is true.

You can set default key, or pass a key directly to service method:

Service.create_partner_trade_by_buyer_url({
  out_trade_no: 'OUT_TRADE_NO',
  # Order params...
}, {
  pid: 'ANOTHER_PID',
  key: 'ANOTHER_KEY',
})

Service

担保交易收款接口

Name

create_partner_trade_by_buyer

Definition

Alipay::Service.create_partner_trade_by_buyer_url({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.create_partner_trade_by_buyer_url(
  out_trade_no: '20150401000-0001',
  subject: 'Order Name',
  price: '10.00',
  quantity: 12,
  logistics_type: 'DIRECT',
  logistics_fee: '0',
  logistics_payment: 'SELLER_PAY',
  return_url: 'https://example.com/orders/20150401000-0001',
  notify_url: 'https://example.com/orders/20150401000-0001/notify'
)
# => 'https://mapi.alipay.com/gateway.do?service=create_partner_trade_by_buyer&...'

Guide consumer to this address to complete payment

Arguments

Key	Requirement	Description
out_order_no	required	Order id in your application.
subject	required	Order subject.
price	required	Order item's price.
quantity	required	Order item's quantity, total price is price * quantity.
logistics_type	required	Logistics type. Available values: POST, EXPRESS, EMS, DIRECT.
logistics_fee	required	Logistics fee.
logistics_payment	required	Who pay the logistics fee. Available values: BUYER_PAY, SELLER_PAY, BUYER_PAY_AFTER_RECEIVE.
return_url	optional	Redirect customer to this url after payment.
notify_url	optional	Alipay asyn notify url.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/alipayescow.zip .

确认发货接口

Name

send_goods_confirm_by_platform

Definition

Alipay::Service.send_goods_confirm_by_platform({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.send_goods_confirm_by_platform(
  trade_no: '201504010000001',
  logistics_name: 'example.com',
  transport_type: 'DIRECT'
)
# => '<!xml version="1.0" encoding="utf-8"?><alipay><is_success>T</is_success></alipay>'

Arguments

Key	Requirement	Description
trade_no	required	Trade number in Alipay system, should get from notify message.
logistics_name	required	Logistics Name.
transport_type/create_transport_type	required	Allowed values: POST, EXPRESS, EMS, DIRECT.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/alipayescow.zip .

即时到账收款接口

Name

create_direct_pay_by_user

Definition

Alipay::Service.create_direct_pay_by_user_url({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.create_direct_pay_by_user_url(
  out_trade_no: '20150401000-0001',
  subject: 'Order Name',
  price: '10.00',
  quantity: 12,
  return_url: 'https://example.com/orders/20150401000-0001',
  notify_url: 'https://example.com/orders/20150401000-0001/notify'
)

Arguments

Key	Requirement	Description
out_order_no	required	Order id in your application.
subject	required	Order subject.
price	required *	Order item's price.
quantity	required *	Order item's quantity, total price is price * quantity.
return_url	optional	Redirect customer to this url after payment.
notify_url	optional	Alipay asyn notify url.

* Can be replaced by total_fee. When total_fee is set, price and quantity could not be set.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/alipaydirect.zip .

即时到账批量退款有密接口

Name

refund_fastpay_by_platform_pwd

Definition

Alipay::Service.refund_fastpay_by_platform_pwd_url

Example

batch_no = Alipay::Utils.generate_batch_no # refund batch no, you SHOULD store it to db to avoid alipay duplicate refund
Alipay::Service.refund_fastpay_by_platform_pwd_url(
  batch_no: batch_no,
  data: [{
    trade_no: '201504010000001',
    amount: '10.0',
    reason: 'REFUND_REASON'
  }],
  notify_url: 'https://example.com/orders/20150401000-0001/refund_notify'
)
# => https://mapi.alipay.com/gateway.do?service=refund_fastpay_by_platform_pwd&...

Arguments

Key	Requirement	Description
batch_no	required	Refund batch no, you should store it to db to avoid alipay duplicate refund.
data	required	Refund data, a hash array.
notify_url	required	Alipay notify url.

Data Item

Key	Requirement	Description
trade_no	required	Trade number in alipay system.
amount	required	Refund amount.
reason	required	Refund reason. Less than 256 bytes, could not contain special characters: ^ $ | #.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/alipaydirect.zip .

关闭交易接口

Name

close_trade

Definition

Alipay::Service.close_trade({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.close_trade(
  trade_no: '201504010000001'
)
# => '<?xml version="1.0" encoding="utf-8"?><alipay><is_success>T</is_success></alipay>'

# When fail
# => '<?xml version="1.0" encoding="utf-8"?><alipay><is_success>F</is_success> <error>TRADE_STATUS_NOT_AVAILD</error></alipay>'

ARGUMENTS

Key	Requirement	Description
out_order_no	optional *	Order number in your application.
trade_no	optional *	Trade number in alipay system.

* out_order_no and trade_no must have one.

单笔交易查询接口

Name

single_trade_query

Definition

Alipay::Service.single_trade_query({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.single_trade_query(
  trade_no: '201504010000001'
)
# => '<?xml version="1.0" encoding="utf-8"?><alipay><is_success>T</is_success>...

ARGUMENTS

Key	Requirement	Description
out_trade_no	optional *	Order number in your application.
trade_no	optional *	Trade number in alipay system.

* out_trade_no and trade_no must have one.

境外收单接口

Name

create_forex_trade

Definition

Alipay::Service.create_forex_trade_url({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.create_forex_trade_url(
  out_trade_no: '20150401000-0001',
  subject: 'Subject',
  currency: 'USD',
  total_fee: '10.00',
  notify_url: 'https://example.com/orders/20150401000-0001/notify'
)
# => 'https://mapi.alipay.com/gateway.do?service=create_forex_trade...'

ARGUMENTS

Key	Requirement	Description
out_trade_no	required	Order number in your application.
subject	required	Order subject.
currency	required	Abbreviated currency name.
total_fee	required *	Order total price.
notify_url	optional	Alipay asyn notify url.

* total_fee can be replace by rmb_fee.

境外收单单笔退款接口

Name

forex_refund

Definition

Alipay::Service.forex_refund_url({ARGUMENTS}, {OPTIONS})

Example

Alipay::Service.forex_refund_url(
  out_return_no: '20150401000-0001',
  out_trade_no: '201504010000001',
  return_amount: '10.00',
  currency: 'USD',
  reason: 'Reason',
  gmt_return: '20150401000000'
)

ARGUMENTS

Key	Requirement	Description
out_return_no	required	Refund no, you should store it to db to avoid alipay duplicate refund.
out_trade_no	required	Order number in your application.
return_amount	required	Refund amount.
currency	required	Abbreviated currency name.
reason	required	Refun reason.
gmt_return	required *	YYYYMMDDHHMMSS Beijing Time.

* Auto set Time.now if not set.

验证通知

Name

notify_verify

Definition

Alipay::Notify.verify?({PARAMS}, {OPTIONS})

Example

# Rails
# params except :controller_name, :action_name, :host, etc.
notify_params = params.except(*request.path_parameters.keys)

Alipay::Notify.verify?(notify_params)

Mobile::Service

移动支付接口

Name

mobile.securitypay.pay

Definition

Alipay::Mobile::Service.mobile_security_pay_string({ARGUMENTS}, {OPTIONS})

Example

Alipay::Mobile::Service.mobile_security_pay_string(
  out_trade_no: '20150401000-0001',
  notify_url: 'https://example.com/orders/20150401000-0001/notify'
  subject: 'subject',
  total_fee: '10.00',
  body: 'text'
)
# => service="mobile.securitypay.pay"&_input_charset="utf-8"&partner=...

ARGUMENTS

Key	Requirement	Description
out_trade_no	required	Order number in your application.
notify_url	required	Alipay asyn notify url.
subject	required	Order subject.
total_fee	required	Order total price.
body	required	Order body, less than 512 bytes.

* This service only support RSA sign_type.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/WS_MOBILE_PAY_SDK_BASE.zip .

Wap::Service

授权接口

Name

alipay.wap.trade.create.direct

Definition

Alipay::Wap::Service.trade_create_direct_token({ARGUMENTS}, {OPTIONS}}

Example

token = Alipay::Wap::Service.trade_create_direct_token(
  req_data: {
    seller_account_name: 'account@example.com',
    out_trade_no: '20150401000-0001',
    subject: 'Subject',
    total_fee: '10.0',
    call_back_url: 'https://example.com/orders/20150401000-0001',
    notify_url: 'https://example.com/orders/20150401000-0001/notify'
  }
)

ARGUMENTS

Key	Requirement	Description
req_data	required	See req_data ARGUMENTS

req_data ARGUMENTS

Key	Requirement	Description
seller_account_name	required	Alipay seller account.
out_order_no	required	Order id in your application.
subject	required	Order subject.
total_fee	required	Order total price.
return_url	optional	Redirect customer to this url after payment.
notify_url	optional	Alipay asyn notify url.

This is not a complete list of arguments, please read official document: http://download.alipay.com/public/api/base/WS_WAP_PAYWAP.zip .

交易接口

Name

alipay.wap.auth.authAndExecute

Definition

Alipay::Wap::Service.auth_and_execute_url({ARGUMENTS}, {OPTIONS})

Example

Alipay::Wap::Service.auth_and_execute_url(request_token: token)

ARGUMENTS

Key	Requirement	Description
request_token	required	Get from trade_create_direct_token

验证通知

Name

notify_verify

Definition

Alipay::Wap::Notify.verify?({PARAMS}, {OPTIONS})

Example

# Rails
# params except :controller_name, :action_name, :host, etc.
notify_params = params.except(*request.path_parameters.keys)

Alipay::Wap::Notify.verify?(notify_params)

Contributing

Bug report or pull request are welcome.

Make a pull request

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

Please write unit test with your code if necessary.

Donate

Donate to maintainer let him make this gem better.

Alipay donate link: http://chloerei.com/donate/ .