Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

API change history

2022.8

Modifications

  • For the alipay.acquire.overseas.query interface:
    • Modified the partner_trans_id field from Required to Optional.
    • Modified the field description of partner_trans_id and alipay_trans_id.

2022.4

Modifications

  • Modified Customs codes and places in the following interfaces:
    • alipay.acquire.customs: modified ZHENGZHOU and HANGZHOU to ZONGSHU
    • alipay.overseas.acquire.customs.query: modified hangzhou to ZONGSHU

V13.16

Release Date: 2021-3-31

Enhanced features

  • Removed the error code MCC_CAN_NOT_MODIFY for the following docs:
    • alipay.overseas.secmerchant.online.maintain
    • alipay.overseas.secmerchant.offline.maintain

2020.12

Modifications

  • Modified the contact_no field from Required to Optional for the following interfaces:
    • alipay.overseas.secmerchant.online.maintain
    • alipay.overseas.secmerchant.offline.maintain

2020.11

Modifications

  • For create_forex_trade_wap_cn, added the following parameter:
    • Request parameter: order_create
  • For alipay.overseas.secmerchant.offline.maintain, modified the operation_id and contact_person fields from Required to Optional.

2020.10

Modifications

  • Updated the description of trade_status_error in alipay.acquire.customs API.
  • Updated the description of price in the following documents:
    • alipay.acquire.overseas.spot.pay
    • alipay.acquire.overseas.spot.pay
  • Added a new API alipay.acquire.refund.query. The API list is also updated.
  • For alipay.system.oauth.token, added the following parameters:
    • Request parameters: app_id, method, format, charset, sign_type, sign, timestamp, version and app_auth_token.
    • Response parameters: code, msg, sub_code, sub_msg, and sign.
  • Added Chinese version doc for the alipay.acquire.refund.query API.
  • For alipay.dut.customer.agreement.page.sign, added the following parameters:
    • Asynchronous response parameters: notify_time, notify_type, and notify_id.
  • Modified the notify_url field from Optional to Required for the following interfaces:
    • alipay.acquire.overseas.spot.pay
    • alipay.acquire.overseas.spot.refund
    • alipay.acquire.precreate (for transaction QR code payment)
    • alipay.acquire.precreate (for third-party QR code payment)
    • alipay.acquire.create
  • Modified the registration_no and contact_no fields from Optional to Required for the following interfaces:
    • alipay.overseas.secmerchant.online.maintain
    • alipay.overseas.secmerchant.offline.maintain
  • For alipay.acquire.overseas.spot.pay, add a new parameter terminal_create_time in extend_info.
  • For forex_rate_file, added the following parameter:
    • Request parameter: _input_charset
  • For single_trade_query, removed the following transaction status:
    • Transaction status: WAIT_SELLER_SEND_GOODS, WAIT_BUYER_CONFIRM_GOODS, SYS_CONFIRM_PAY, WAIT_SYS_PAY_SELLER, TRADE_REFUSE, TRADE_REFUSE_DEALING, TRADE_CANCEL, TRADE_PENDING, TRADE_SUCCESS, BUYER_PRE_AUTH, COD_WAIT_SELLER_SEND_GOODS, COD_WAIT_BUYER_PAY, COD_WAIT_SYS_PAY_SELLER
  • For alipay.intl.merchant.common.indirectMerchant.maintain (for offline payments), modified the registrationAddress field from Optional to Required.
  • For alipay.overseas.secmerchant.offline.maintain, modified the register_address field from Optional to Required.

2020.04

Modifications

  • For alipay.acquire.overseas.spot.pay, under extend_info, added subfields  terminal_create_time and last_payment_info.
  • For alipay.intl.acquiring.offline.pay，under extend_info, added subfields storeTerminalRequestTime and last_payment_info.
  • Removed an API: alipay.intl.merchant.common.indirectMerchant.maintain (for online payments)
  • For alipay.intl.acquiring.offline.pay, added two sub-fields for extendInfo: storeTerminalRequestTime and last_payment_info.
  • For alipay.acquire.overseas.spot.pay, added two sub-fields for entend_info:  terminal_create_time and last_payment_info; removed the extra_common_param field from the Asynchronous response

For alipay.intl.merchant.common.indirectMerchant.maintain (for offline payments), and alipay.intl.merchant.common.indirectMerchant.query, registerAddress is changed to registrationAddress

  • Added a new API: Alipay global heartbeat interface
  • For alipay.acquire.overseas.spot.pay, updated the length and format of trans_create_time and terminal_create_time.
  • Added rules about the length and contents of secondary_merchant_id and store_id in the following APIs:
    • alipay.overseas.secmerchant.offline.maintain
    • alipay.overseas.secmerchant.maintain.queryStatus
    • alipay.overseas.secmerchant.online.maintain
    • alipay.overseas.secmerchant.maintain.queryStatus
  • For alipay.overseas.secmerchant.offline.maintain, registration_no is now Required.
  • For alipay.acquire.precreate (for transaction QR code payment), removed notify_action_type from the asynchronous response.
  • For alipay.intl.acquiring.offline.pay, removed error codes OAUTH_FAILED, CLIENT_FORBIDDEN_ACCESS_API, SIGN_TYPE_NOT_SUPPORT, MERCHANT_HAS_REGISTER, and USER_BALANCE_PAY_OFF.
  • For alipay.intl.acquiring.offline.payQuery, alipay.intl.acquiring.common.refund, and alipay.intl.acquiring.common.payCancel, removed error codes OAUTH_FAILED, CLIENT_FORBIDDEN_ACCESS_API, SIGN_TYPE_NOT_SUPPORT, and MERCHANT_HAS_REGISTER.
  • Added RSA2 as the supported value to sign_type in the following APIs:
    • mobile.securitypay.pay
    • mobile.securitypay.pay
  • For alipay.dut.customer.agreement.unsign, added information about the asynchronous response. 
  • Added order_create and updated the description of timeout_rule in the following APIs:
    • create_forex_trade_wap
  • Updated the enum of Site in the following APIs:
    • alipay.intl.acquiring.offline.pay
    • alipay.intl.acquiring.offline.payQuery

2019.12

Modifications

  • Removed the forex_compare_file and forex_liquidation_file APIs. If you need information about these two APIs, contact Alipay technical support.
  • Updated the description of product_code for the following APIs to clarify that this field is not required for the old cross-border website payment product. Contact technical support if you are not sure about your product type.
    • create_forex_trade
    • create_forex_trade_wap
    • mobile_securitypay_pay
  • Added the new production gateway URL(https://globalmapi.alipay.com/gateway.do) in the following APIs:
    • alipay.acquire.overseas.spot.pay
    • alipay.acquire.precreate (for third-party QR code payment)
    • alipay.acquire.precreate (for transaction QR code payment)
    • alipay.acquire.create
    • alipay.commerce.qrcode.create
    • alipay.commerce.qrcode.modify
    • alipay.commerce.qrcode.modifyStatus
    • alipay.system.oauth.token
    • alipay.acquire.cancel
    • alipay.acquire.overseas.spot.refund
    • alipay.acquire.overseas.query
    • alipay.overseas.secmerchant.offline.maintain
    • alipay.overseas.secmerchant.maintain.queryStatus
  • Modified the notifyUrl field of alipay.intl.acquiring.offline.pay from Optional to Required.
  • Modified the value of result_code from FAIL to FAILED in alipay.acquire.overseas.spot.refund.
  • Modified split_fund_info from Required to Optional in create_forex_trade_wap.
  • Modified notifyUrl from Optional to Required in alipay.intl.acquiring.offline.pay.

2019.10

Modifications

  • Added the notify_url field to alipay.acquire.overseas.spot.pay.
  • Modified the description of the trans_currency field of the following APIs:
    • alipay.commerce.qrcode.create
    • alipay.acquire.precreate (for third-party QR code payment)
    • alipay.acquire.precreate (for transaction QR code payment)
    • alipay.commerce.qrcode.modify
    • alipay.acquire.create
    • alipay.acquire.overseas.query

2019.09

Modifications

  • Added the is_show_memo and notify_charset fields to the following APIs:
    • alipay.commerce.qrcode.create
    • alipay.commerce.qrcode.modify
  • The value of sign_type field is changed to RSA, RSA2, or MD5 for all APIs, except for mobile.securitypay.pay.
  • For the following APIs, the secondary_merchant_name, secondary_merchant_id, and secondary_merchant_industry fields are required for acquirers and system integrators with secondary merchants, and are not required for merchants that are directly integrated with Alipay:
    • create_forex_trade
    • create_forex_trade_wap
    • mobile.security.pay

2019.08

Modifications

  • The value of secondary_merchant_name, secondary_merchant_type, registration_no, register_country, representative_name, and representative_id fields of the secondary merchant registration interfaces cannot be modified once specified. Now this restriction is cancelled. The secondary merchant registration interfaces include:
    • alipay.overseas.secmerchant.online.maintain
    • alipay.overseas.secmerchant.offline.maintain
  • Added an error code MORE_THAN_ALLOW_REFUND_FOREX_FEE to the forex_refund interface.

2019.07

Modifications

  • Added the notify_sign_type field to the alipay.commerce.qrcode.modify interface.
  • Added error codes SECONDARY_MERCHANT_ID_BLANK, SECONDARY_MERCHANT_ID_INVALID, and SECONDARY_MERCHANT_STATUS_ERROR to the following APIs:
    • alipay.acquire.overseas.spot.pay
    • alipay.acquire.precreate (for third-party QR code payment)
    • alipay.acquire.precreate (for transaction QR code payment)
    • alipay.acquire.create
    • create_forex_trade
    • create_forex_trade_wap
    • mobile.securitypay.pay

2019.06

Modifications

Modified the value of store_status field to ARCHIVED, ACTIVATED, or INACTIVATE of the alipay.overseas.secmerchant.maintain.queryStatus interface.

2019.05

Modifications

  • alipay.acquire.precreate (for transaction QR code payment): added a new parameter of qr_code_it_b_pay, and updated the it_b_pay parameter.
  • alipay.acquire.overseas.spot.refund: added an error code BUYER_NOT_EXIST; added async notification.
  • forex_refund: added an error code BUYER_NOT_EXIST.

2019.04

Modifications

Added the trade_information field and its sub fields to the following APIs:

  • alipay.acquire.overseas.spot.pay
  • alipay.acquire.precreate for the transaction QR code payment

alipay.overseas.secmerchant.online.maintain: 

  • Added the service of modifying the registed information of secondary merchants.
  • Modified the length of the shareholder_name and representative_name parameters to 64 bytes.
  • Modified the following required parameters to optional parameters:
    • registration_no
    • representative_name
    • representative_id
    • settlement_no
    • contact_no
    • contact_email
  • Added the following error codes:
    • BUSINESS_NAME_UPDATE_FORBIDDEN
    • REGISTRATION_NO_UPDATE_FORBIDDEN
    • REGISTER_COUNTRY_UPDATE_FORBIDDEN
    • MERCHANT_TYPE_UPDATE_FORBIDDEN
    • REPRESENTATIVE_NAME_UPDATE_FORBIDDEN
    • REPRESENTATIVE_ID_UPDATE_FORBIDDEN

alipay.overseas.secmerchant.offline.maintain:

  • Added the function of modifying the registed information of secondary merchants.
  • Modified the length of the shareholder_name and representative_name parameters to 64 bytes.
  • Modified the following required parameters to optional parameters:
    • registration_no
    • register_address
    • representative_name
    • representative_id
    • settlement_no
    • contact_no
    • contact_email
  • Added the following error codes:
    • BUSINESS_NAME_UPDATE_FORBIDDEN
    • REGISTRATION_NO_UPDATE_FORBIDDEN
    • REGISTER_COUNTRY_UPDATE_FORBIDDEN
    • MERCHANT_TYPE_UPDATE_FORBIDDEN
    • REPRESENTATIVE_NAME_UPDATE_FORBIDDEN
    • REPRESENTATIVE_ID_UPDATE_FORBIDDEN

For the alipay.overseas.secmerchant.maintain.queryStatus (online) and alipay.overseas.secmerchant.maintain.queryStatus (offline) interfaces, the updates are as follows:

  • Added the following parameters in synchronous response:
    • payment_method
    • partner
    • secondary_merchant_name
    • secondary_merchant_type
    • secondary_merchant_industry
    • registration_no
    • register_country
    • register_address
    • shareholder_name
    • shareholder_id
    • representative_name
    • representative_id
    • settlement_no
    • contact_no
    • contact_email
    • cs_no
    • cs_email
    • site_infos
  • Modified the description of the status parameter.