Skip to content
Browse files

[ADD] payment_alipay: added new Alipay payment acquirer

This commit introduces the Alipay payment provider, a popular acquirer
in the Chinese market.

There are 2 possible ways to use this acquirer:
- express checkout mode (only available for merchants located in CN)
- standard checkout mode (availabe for foreign merchants)

Note that this provider does not support server-to-server payments,
tokenization or any other bells and whistles besides fees. There are no
specific behaviours related to this acquirer, it behaves like most 'form
based' payment acquirers with a form submission, s2s notification from
the provider as well as redirect in case the s2s did not reach the
server in time.

closes #21855

Signed-off-by: Damien Bouvy (dbo) <>
  • Loading branch information...
nla-odoo authored and dbo-odoo committed Nov 21, 2017
1 parent 728ca33 commit e335d235f6465bcf6869254049d73237f5c6b290
@@ -265,4 +265,21 @@

<record id="payment_acquirer_alipay" model="payment.acquirer">
<field name="name">Alipay</field>
<field name="image" type="base64" file="payment_alipay/static/description/icon.png"/>
<field name="view_template_id" ref="default_acquirer_button"/>
<field name="module_id" ref="base.module_payment_alipay"/>
<field name="description" type="html">
Alipay is the most popular online payment platform in China. Chinese consumers can buy online using their Alipay eWallet.
<ul class="list-inline">
<li><i class="fa fa-check"/>Online Payment</li>
<li><i class="fa fa-check"/>Payment Status Tracking</li>
<!-- -->
<field name="payment_icon_ids" eval='[(6, 0, [ref("payment.payment_icon_cc_jcb"),ref("payment.payment_icon_cc_mastercard"),ref("payment.payment_icon_cc_western_union"),ref("payment.payment_icon_cc_webmoney"),ref("payment.payment_icon_cc_visa")])]'/>
@@ -54,4 +54,14 @@
<field name="name">Codensa Easy Credit</field>
<field name="image" type="base64" file="payment/static/img/codensa_easy_credit.png"/>

<record id="payment_icon_cc_western_union" model="payment.icon">
<field name="name">Western Union</field>
<field name="image" type="base64" file="payment/static/img/western_union.png"/>

<record id="payment_icon_cc_webmoney" model="payment.icon">
<field name="name">WebMoney</field>
<field name="image" type="base64" file="payment/static/img/webmoney.png"/>
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,5 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

from . import controllers
from . import models
@@ -0,0 +1,15 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

'name': 'Alipay Payment Acquirer',
'category': 'Accounting',
'summary': 'Payment Acquirer: Alipay Implementation',
'description': """Alipay Payment Acquirer""",
'depends': ['payment'],
'data': [
@@ -0,0 +1,4 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

from . import main
@@ -0,0 +1,63 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

import logging
import pprint
import requests
import werkzeug

from odoo import http
from odoo.http import request

_logger = logging.getLogger(__name__)

class AlipayController(http.Controller):
_notify_url = '/payment/alipay/notify'
_return_url = '/payment/alipay/return'

def _alipay_validate_data(self, **post):
resp = post.get('trade_status')
if resp:
if resp in ['TRADE_FINISHED', 'TRADE_SUCCESS']:'Alipay: validated data')
elif resp == 'TRADE_CLOSED':
_logger.warning('Alipay: payment refunded to user and closed the transaction')
_logger.warning('Alipay: unrecognized alipay answer, received %s instead of TRADE_FINISHED/TRADE_SUCCESS and TRADE_CLOSED' % (post['trade_status']))
if post.get('out_trade_no') and post.get('trade_no'):
post['reference'] = request.env['payment.transaction'].sudo().search([('reference', '=', post['out_trade_no'])]).reference
return request.env['payment.transaction'].sudo().form_feedback(post, 'alipay')
return False

def _alipay_validate_notification(self, **post):
if post.get('out_trade_no'):
alipay = request.env['payment.transaction'].sudo().search([('reference', '=', post.get('out_trade_no'))]).acquirer_id
alipay = request.env['payment.acquirer'].sudo().search([('provider', '=', 'alipay')])
val = {
'service': 'notify_verify',
'partner': alipay.alipay_merchant_partner_id,
'notify_id': post['notify_id']
response =, val)
response.raise_for_status()'Validate alipay Notification %s' % response.text)
# After program is executed, the page must print “success” (without quote). If not, Alipay server would keep re-sending notification, until over 24 hour 22 minutes Generally, there are 8 notifications within 25 hours (Frequency: 2m,10m,15m,1h,2h,6h,15h)
if response.text == 'true':
return 'success'
return ""

@http.route('/payment/alipay/return', type='http', auth="none", methods=['GET', 'POST'])
def alipay_return(self, redirect_url=False, **post):
""" Alipay return """'Beginning Alipay form_feedback with post data %s', pprint.pformat(post))
return werkzeug.utils.redirect(redirect_url or "/")

@http.route('/payment/alipay/notify', type='http', auth='none', methods=['POST'], csrf=False)
def alipay_notify(self, **post):
""" Alipay Notify """'Beginning Alipay notification form_feedback with post data %s', pprint.pformat(post))
return self._alipay_validate_notification(**post)
@@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo noupdate="1">
<record id="payment.payment_acquirer_alipay" model="payment.acquirer">
<field name="name">Alipay</field>
<field name="provider">alipay</field>
<field name="company_id" ref="base.main_company"/>
<field name="view_template_id" ref="alipay_form"/>
<field name="environment">test</field>
<field name="pre_msg" type="html">
You will be redirected to the Alipay website after clicking on the payment button.
<field name="alipay_merchant_partner_id">dummy</field>
<field name="alipay_md5_signature_key">dummy</field>
<field name="alipay_seller_email">dummy</field>
@@ -0,0 +1,4 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

from . import payment
@@ -0,0 +1,228 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

import logging

from hashlib import md5
from werkzeug import urls

from odoo import api, fields, models, _
from import float_compare
from odoo.addons.payment_alipay.controllers.main import AlipayController
from odoo.addons.payment.models.payment_acquirer import ValidationError

_logger = logging.getLogger(__name__)

class PaymentAcquirer(models.Model):
_inherit = 'payment.acquirer'

provider = fields.Selection(selection_add=[('alipay', 'Alipay')])
alipay_payment_method = fields.Selection([
('express_checkout', 'Express Checkout (only for Chinese Merchant)'),
('standard_checkout', 'Cross-border'),
], string='Account', default='express_checkout',
help=" * Cross-border: For the Overseas seller \n * Express Checkout: For the Chinese Seller")
alipay_merchant_partner_id = fields.Char(
string='Merchant Partner ID', required_if_provider='alipay', groups='base.group_user',
help='The Merchant Partner ID is used to ensure communications coming from Alipay are valid and secured.')
alipay_md5_signature_key = fields.Char(
string='MD5 Signature Key', required_if_provider='alipay', groups='base.group_user',
help="The MD5 private key is the 32-byte string which is composed of English letters and numbers.")
alipay_seller_email = fields.Char(string='Alipay Seller Email', groups='base.group_user')

def _get_feature_support(self):
res = super(PaymentAcquirer, self)._get_feature_support()
return res

def _get_alipay_urls(self, environment):
""" Alipay URLS """
if environment == 'prod':
return ''
return ''

def alipay_compute_fees(self, amount, currency_id, country_id):
""" Compute alipay fees.
:param float amount: the amount to pay
:param integer country_id: an ID of a, or None. This is
the customer's country, to be compared to
the acquirer company country.
:return float fees: computed fees
fees = 0.0
if self.fees_active:
country = self.env[''].browse(country_id)
if country and ==
percentage = self.fees_dom_var
fixed = self.fees_dom_fixed
percentage = self.fees_int_var
fixed = self.fees_int_fixed
fees = (percentage / 100.0 * amount + fixed) / (1 - percentage / 100.0)
return fees

def _build_sign(self, val):
# Rearrange parameters in the data set alphabetically
data_to_sign = sorted(val.items())
# Exclude parameters that should not be signed
data_to_sign = ["{}={}".format(k, v) for k, v in data_to_sign if k not in ['sign', 'sign_type', 'reference']]
# And connect rearranged parameters with &
data_string = '&'.join(data_to_sign)
data_string += self.alipay_md5_signature_key
return md5(data_string.encode('utf-8')).hexdigest()

def _get_alipay_tx_values(self, values):
base_url = self.env['ir.config_parameter'].sudo().get_param('web.base.url')

tx = self.env['payment.transaction'].search([('reference', '=', values.get('reference'))], limit=1)
alipay_tx_values = ({
'_input_charset': 'utf-8',
'notify_url': urls.url_join(base_url, AlipayController._notify_url),
'out_trade_no': values.get('reference'),
'partner': self.alipay_merchant_partner_id,
'return_url': urls.url_join(base_url, AlipayController._return_url) + '?' + urls.url_encode({'redirect_url': values.get('return_url')}),
'subject': values.get('reference'),
'total_fee': values.get('amount') + values.get('fees'),
if self.alipay_payment_method == 'standard_checkout':
'service': 'create_forex_trade',
'product_code': 'NEW_OVERSEAS_SELLER',
'currency': values.get('currency').name,
'service': 'create_direct_pay_by_user',
'payment_type': 1,
'seller_email': self.alipay_seller_email,
sign = self._build_sign(alipay_tx_values)
'sign_type': 'MD5',
'sign': sign,
return alipay_tx_values

def alipay_form_generate_values(self, values):
return values

def alipay_get_form_action_url(self):
return self._get_alipay_urls(self.environment)

class PaymentTransaction(models.Model):
_inherit = 'payment.transaction'

def _check_alipay_configuration(self, vals):
acquirer_id = int(vals.get('acquirer_id'))
acquirer = self.env['payment.acquirer'].sudo().browse(acquirer_id)
if acquirer and acquirer.provider == 'alipay' and acquirer.alipay_payment_method == 'express_checkout':
currency_id = int(vals.get('currency_id'))
if currency_id:
currency = self.env['res.currency'].sudo().browse(currency_id)
if currency and != 'CNY':"Only CNY currency is allowed for Alipay Express Checkout")
raise ValidationError(_("""
Only transactions in Chinese Yuan (CNY) are allowed for Alipay Express Checkout.\n
If you wish to use another currency than CNY for your transactions, switch your
configuration to a Cross-border account on the Alipay payment acquirer in Odoo.
return True

def write(self, vals):
if vals.get('currency_id') or vals.get('acquirer_id'):
for payment in self:
check_vals = {
'acquirer_id': vals.get('acquirer_id',,
'currency_id': vals.get('currency_id',
return super(PaymentTransaction, self).write(vals)

def create(self, vals):
return super(PaymentTransaction, self).create(vals)

# --------------------------------------------------
# --------------------------------------------------

def _alipay_form_get_tx_from_data(self, data):
reference, txn_id, sign = data.get('reference'), data.get('trade_no'), data.get('sign')
if not reference or not txn_id:'Alipay: received data with missing reference (%s) or txn_id (%s)' % (reference, txn_id))
raise ValidationError(_('Alipay: received data with missing reference (%s) or txn_id (%s)') % (reference, txn_id))

txs = self.env['payment.transaction'].search([('reference', '=', reference)])
if not txs or len(txs) > 1:
error_msg = _('Alipay: received data for reference %s') % (reference)
logger_msg = 'Alipay: received data for reference %s' % (reference)
if not txs:
error_msg += _('; no order found')
logger_msg += '; no order found'
error_msg += _('; multiple order found')
logger_msg += '; multiple order found'
raise ValidationError(error_msg)

# verify sign
sign_check = txs.acquirer_id._build_sign(data)
if sign != sign_check:'Alipay: invalid sign, received %s, computed %s, for data %s' % (sign, sign_check, data))
raise ValidationError(_('Alipay: invalid sign, received %s, computed %s, for data %s') % (sign, sign_check, data))

return txs

def _alipay_form_get_invalid_parameters(self, data):
invalid_parameters = []

if float_compare(float(data.get('total_fee', '0.0')), (self.amount + self.fees), 2) != 0:
invalid_parameters.append(('total_fee', data.get('total_fee'), '%.2f' % (self.amount + self.fees))) # mc_gross is amount + fees
if self.acquirer_id.alipay_payment_method == 'standard_checkout':
if data.get('currency') !=
invalid_parameters.append(('currency', data.get('currency'),
if data.get('seller_email') != self.acquirer_id.alipay_seller_email:
invalid_parameters.append(('seller_email', data.get('seller_email'), self.acquirer_id.alipay_seller_email))
return invalid_parameters

def _alipay_form_validate(self, data):
if self.state in ['done']:'Alipay: trying to validate an already validated tx (ref %s)', self.reference)
return True

status = data.get('trade_status')
res = {
'acquirer_reference': data.get('trade_no'),
if status in ['TRADE_FINISHED', 'TRADE_SUCCESS']:'Validated Alipay payment for tx %s: set as done' % (self.reference))
date_validate =
res.update(state='done', date=date_validate)
return True
elif status == 'TRADE_CLOSED':'Received notification for Alipay payment %s: set as Canceled' % (self.reference))
res.update(state='cancel', state_message=data.get('close_reason', ''))
return self.write(res)
error = 'Received unrecognized status for Alipay payment %s: %s, set as error' % (self.reference, status)
res.update(state='error', state_message=error)
return self.write(res)
Binary file not shown.
@@ -0,0 +1,4 @@
# -*- coding: utf-8 -*-
# Part of Odoo. See LICENSE file for full copyright and licensing details.

from . import test_alipay

0 comments on commit e335d23

Please sign in to comment.
You can’t perform that action at this time.