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

Release notes

September 2022

Enhanced

Deprecated

Document improvements

  • Modified the description of the paymentOptions.paymentMethodRegion field in the response parameters of the consult (Cashier Payment) API.
  • Modified the minimum length of the paymentOptions.logo.logoName field in the response parameters of the consult (Cashier Payment) API.
  • Modified the description of the result.resultStatus field in the response parameters of the pay (Cashier Payment) API.
  • Modified the name of the error code PAYMENT_METHOD_NOT_SUPPORTED in the refund API.
  • Updated the result process logic of the pay (Cashier Payment) API.
  • Modified the description of the transactions field in the response parameters of the inquiryPayment API.
  • Updated the payment result codes of the inquiryPayment API.
  • Modified the description of the file path naming rule and the field seq. For more information, see the following documents:
  • Modified the description of the field customerId. For more information, see the following documents:
  • Added the field acquirer. For more information, see the following documents:
  • Added the field acquirerReferenceNo. For more information, see the following documents:
  • Modified the description of the fields transactionId, originalTransactionId, transactionRequestId, referenceTransactionId, paymentMethodType, and transactionType. For more information, see the following documents:
  • Modified the description of the field settlementBatchId. For more information, see the following documents:
  • Added the fields taxFeeAmountValue and taxFeeCurrency. For more information, see the following documents:

August 2022

Enhanced

  • Deprecated the Data dictionary for APIs.
  • Deprecated the APIs about registration for online payments: registration, notifyRegistrationStatus, inquiryRegistrationStatus, inquiryRegistrationInfo.

Document improvements

  • Modified the description of the referenceTransactionId field. For more information, see the following documents:
  • Added the fields processingFeeAmountValue and processingFeeCurrency to the Settle and reconcile documents. For more information, see the following documents:
  • Modified the description of the feeAmountValue field. For more information, see the following documents:

July 2022

Enhanced

  • Added the userRegion field in the request parameters and the paymentData field in the response parameters of the pay (Cashier Payment) API.
  • Added two error codes REFUND_NOT_SUPPORTEDand PARTIAL_REFUND_NOT_SUPPORTED in the refund API.
  • Added Best practices for BNPL channels for Cashier Payment.
  • Added the goodsCategory field to pay (Cashier Payment) and pay (Auto Debit) APIs.
  • Added Akulaku PayLater payment method to Cashier Payment, and Boost eWallet to Cashier Payment and Auto Debit. For more information, see the following documents:

Document improvements

  • Updated the result process logic in the pay (Cashier Payment) API.
  • Updated the error codes in the interfaces: consult, applyToken, revoke, pay (Cashier Payment), pay (Auto Debit), notifyPayment, inquiryPayment, cancel, refund, inquiryRefund, notifyRefund, declare, inquiryDeclarationRequests, pay (User-presented Mode Payment), pay (Order Code Payment), pay (Entry Code Payment).

May 2022

Added the consult (Cashier Payment) and notifyRefund interfaces.

Updated the pay (Cashier Payment) document:

  • Added the paymentMethod.paymentMethodMetaData field in Request parameters.
  • Added some new enumeration values in the paymentMethod.paymentMethodType field.
  • Modfied the field description of settlementStrategy.settlementCurrency.
  • Added the following error codes:
    • INVALID_PAYMENT_METHOD_META_DATA
    • INCORRECT_BLIKCODE
    • SETTLE_CONTRACT_NOT_MATCH

Updated the notifyPayment document:

  • Added the new enumeration value of PAYMENT_PENDING in the notifyType field.

Updated the inquiryPayment document:

  • Added the new enumeration value of PENDING in the paymentStatus field.

Updated the refund document:

  • Added the refundNotifyUrl field in Request parameters.
  • Added the error code: REFUND_IN_PROCESS

Updated the Transaction Items, Settlement Items, and Settlement Summary documents under Cashier Payment:

  • Added the following new enumeration values in the paymentMethodType field in Transaction Items and Settlement Items:
    • IDEAL
    • GIROPAY
    • SOFORT
    • PAYU
    • P24
    • BLIK
    • EPS
    • BANCONTACT
    • PIX
  • Added the following fields in Settlement Items and Settlement Summary:
    • processingFeeAmountValue
    • processingFeeCurrency
  • Modified the Report path and name parts in Settlement Items and Settlement Summary.

April 2022

  • Added the merchantRegion field in the request parameters of the following interfaces:
    • pay (Cashier Payment)
    • consult
    • applyToken
    • pay (User-presented Mode Payment)
    • pay (Order Code Payment)
    • pay (Entry Code Payment)
  • Modified Customs codes in the sample codes of the following interfaces:
    • declare: modified ZHENGZHOU to ZONGSHU
    • inquiryDeclarationRequests: modified shenzhen to ZONGSHU
  • The Business Registration Country/Region field is moved from the Welcome page to the Create New Application page.

March 2022

  • Added the Sandbox documentation.
  • Added a new version of the Cashier Payment documentation.
  • Added a new version of the Auto Debit documentation.
  • Added the redirectActionForm field in the response parameters of the inquiryPayment interface.

February 2022

  • Deleted the initAuthentication and verifyAuthentication interfaces.
  • Added the USER_NOT_EXIST error code in the pay (Auto Debit).

January 2022

Added the grossSettlementAmount and settlementQuote fields in the following interfaces:

  • notifyPayment
  • inquiryPayment
  • refund
  • inquiryRefund

Updated the pay (Cashier Payment) document:

  • Added the following error codes:
    • INVALID_MERCHANT_STATUS
    • MERCHANT_KYB_NOT_QUALIFIED
    • NO_PAY_OPTIONS
  • Deleted the following error codes:
    • SUCCESS
    • ORDER_NOT_EXIST

Updated the pay (Auto Debit) document:

  • Deleted the following fields:
    • Request parameters:
      • merchant.store
      • order.env.storeTerminalId
      • order.env.storeTerminalRequestTime
      • payToMethod
      • paymentMethod.paymentMethodMetaData
      • isAuthorization
      • paymentVerificationData
      • paymentFactor
    • Response parameters:
      • authExpiryTime
      • challengeActionForm
      • redirectActionForm
      • orderCodeForm
  • Modified the following fields from Optional to Required:
    • Request parameters:
      • paymentMethod.paymentMethodId
      • env
      • env.terminalType
      • settlementStrategy.settlementCurrency
    • Response parameters:
      • result.resultMessage
  • Added the following error codes:
    • INVALID_MERCHANT_STATUS
    • MERCHANT_KYB_NOT_QUALIFIED
    • USER_PAYMENT_VERIFICATION_FAILED
  • Deleted the following error codes:
    • USER_NOT_EXIST
    • ORDER_NOT_EXIST

Updated the notifyPayment document:

  • Deleted the following fields:
    • Request parameters:
      • notifyType: OFFLINE_PAYMENT_CODE
      • result.resultStatus: U
  • Modified the following fields from Optional to Required:
    • Request parameters:
      • paymentCreateTime
      • paymentId
      • result.resultMessage
  • Added the error codes of pay (Cashier Payment) and pay (Auto Debit).

Updated the inquiryPayment document:

  • Deleted the following fields:
    • Response parameters:
      • authExpiryTime
      • redirectActionForm
      • transaction.transactionType: PAYMENT, CANCEL, AUTHORIZATION, CAPTURE, VOID
      • transactionTime
  • Modified the following fields from Optional to Required:
    • Response parameters:
      • result
      • result.resultMessage
      • transactions.transactionId
  • Added the following two result codes tables:
    • Payment result codes
    • Transaction result codes
  • Deleted the following error codes:
    • RISK_REJECT
    • USER_KYC_NOT_QUALIFIED

Updated the cancel document:

  • Modified the following field from Optional to Required:
    • Response parameters:
      • result.resultMessage

Updated the refund document:

  • Modified the following field from Optional to Required:
    • Response parameters:
      • result.resultMessage
  • Added the following error codes:
    • INVALID_MERCHANT_STATUS
    • ORDER_IS_CLOSED

Updated the inquiryRefund document:

  • Added the following field:
    • Response parameters:
      • refundStatus: FAIL
  • Deleted the following error codes:
    • RISK_REJECT
    • MERCHANT_NOT_REGISTERED
    • INVALID_CONTRACT
  • Added a Refund result codes table.

Updated the consult document:

  • Modified the following field from Optional to Required:
    • Response parameters:
      • result.resultMessage
  • Added the following error codes:
    • INVALID_CLIENT_STATUS
    • OAUTH_FAILED
    • UNKNOWN_CLIENT

Updated the applyToken document:

  • Modified the following field from Optional to Required:
    • Response parameters:
      • result.resultMessage
  • Added the following error codes:
    • INVALID_CLIENT_STATUS
    • OAUTH_FAILED
    • UNKNOWN_CLIENT
    • USER_NOT_EXIST
    • USER_STATUS_ABNORMAL

Updated the revoke document:

  • Modified the following field from Optional to Required:
    • Response parameters:
      • result.resultMessage
  • Added the following error codes:
    • CLIENT_FORBIDDEN_ACCESS_API
    • INVALID_CLIENT_STATUS
    • OAUTH_FAILED
    • UNKNOWN_CLIENT

Added the grossSettlementAmount and settlementQuote fields in the inquiryRefund interface.

Updated the pay (User-presented Mode Payment) document:

  • Deleted the following fields:
    • Request parameters:
      • isAuthorization
      • paymentFactor.isPaymentEvaluation
      • paymentMethod.paymentMethodMetaData
      • paymentRedirectUrl
      • paymentVerificationData
      • payToMethod
    • Response parameters:
      • authExpiryTime
      • challengeActionForm.challengeRenderValue
      • orderCodeForm
  • Added the settlementStrategy field.
  • Modified the paymentMethod.paymentMethodId field from Optional to Required.

Updated the pay (Order Code Payment) document:

  • Deleted the following fields:
    • Request parameters:
      • isAuthorization
      • paymentFactor.isPaymentEvaluation
      • paymentMethod.paymentMethodMetaData
      • paymentVerificationData
      • payToMethod
    • Response parameters:
      • authExpiryTime
      • challengeActionForm.challengeRenderValue
  • Added the settlementStrategy field.
  • Modified the orderCodeForm field from Optional to Required.

Updated the pay (Entry Code Payment) document:

  • Deleted the following fields:
    • Request parameters:
      • isAuthorization
      • paymentFactor.isPaymentEvaluation
      • paymentMethod.paymentMethodMetaData
      • paymentVerificationData
      • payToMethod
    • Response parameters:
      • authExpiryTime
      • challengeActionForm.challengeRenderValue
      • orderCodeForm
  • Added the settlementStrategy field.
  • Modified the order.env and the order.env.userAgent fields from Optional to Required.

December 2021

  • Auto Debit added the authorization result notification functionality. Therefore, the following documentation are reorganized:

For Online payment and In-store payment:

  • Added the refund inquiry functionality in the following products:
    • Cashier Payment
    • Auto Debit
    • User-presented Mode Payment
    • Order Code Payment
    • Entry Code Payment
  • Therefore, the following documentation are reorganized:
    • Post-payment service
    • Best practice
    • API list

Updated the pay (Cashier Payment) document:

Request parameters

  • Deleted the following fields:
    • merchant.store
    • order.env.storeTerminalId
    • order.env.storeTerminalRequestTime
    • payToMethod
    • paymentMethod.paymentMethodId
    • paymentMethod.paymentMethodMetaData
    • isAuthorization
    • paymentVerificationData
    • paymentFactor
  • Modified the following fields from Optional to Required:
    • order.env
    • settlementStrategy.settlementCurrency

Response parameters

  • Deleted the following fields:
    • result.resultStatus: S 
    • paymentTime
    • authExpiryTime
    • challegeActionForm
    • redirectActionForm.method: SCAN
    • orderCodeForm.paymentMethodType
    • settlementQuote
    • grossSettlementAmount
  • Modified the following fields from Optional to Required:
    • orderCodeForm.expireTime
    • orderCodeForm.codeDetails
    • result.resultMessage

Added the userLoginId field in the applyToken interface.

Added the following fields in the pay (Cashier Payment) and pay (Auto Debit) interfaces:

  • schemeUrl
  • applinkUrl
  • normalUrl
  • appIdentifier

Added the new enumeration values of BPI and RABBIT_LINE_PAY in the following APIs:

  • pay (Cashier Payment): paymentMethod.paymentMethodType

Added the new enumeration value of RABBIT_LINE_PAY in the following APIs:

  • pay (Auto Debit): paymentMethod.paymentMethodType
  • consult: customerBelongsTo
  • applyToken: customerBelongsTo

November 2021

October 2021

  • Auto Debit added the payment result notification functionality. Therefore, the following documentation are reorganized:
  • Added the following new APIs in online payments:
  • Added the following new API in in-store payments:

September 2021

  • The following terms are renamed:

Obsolete term

Current term 

Comments

PMP

Alipay+ MPP

The meaning of the current term is the same as the obsolete term.

Connect Wallet

H5

WAP

mobile website

  • New introduction videos of online payment and in-store payment scenarios are added. You can go to Online payment and In-store payment to view details.

August 2021

  • Added MULTIPLE_REFUNDS_NOT_SUPPORTED of error code in the following APIs:
  • Removed the inquiryUserInfo interface is removed.

July 2021

  • Added the error code of USER_KYC_NOT_QUALIFIED in the following APIs:
  • Modified the orderCodeForm.codeDetails field from Required to Optional for the following interfaces:
  • Deleted the orderCodeForm.codeDetails.codeValueType field in the following APIs:

May 2021

  • Alipay Docs redesigned with improved user experience and new information architecture. New docs to assist new users:
  • Reorganized the structure of API-related instruction documentation.
    • Added the following documentation:
    • Renamed the following documentation titles:
  • Removed the following documentation to the corresponding product documentation:
    • Settlement Items
    • Settlement Summary
    • Transaction Items

For example, you can go to Cashier Payment > Reports and reconciliation > Settlement Items (https://global.alipay.com/docs/ac/cashierpayment/settlementitems_online) to view details.

  • Terminology renaming. The following term is renamed:
    • Consumer-presented Mode Payment -> User-presented Mode Payment

April 2021

  • Added a new field and enum (appId and MINI_APP) to the following APIs:

March 2021

  • Added new settlement modes to the following products:

Removed the following fields from the Settlement Summary file for each product:

    • transactionAmountValue
    • transactionCurrency
  • Deleted INVALID_CODE of error code in the following APIs:
  • Added INVALID_PAYMENT_CODE of error code in the following API:

December 2020

  • Renamed the following term:

Obsolete term

Current term 

Comments

PSP

PMP

The obsolete term might be still displayed in codes, for example, API specifications, Java code specifications, or other places where technical elements exist. The meaning of the obsolete term is not changed.

  • New versions of Product APIs for online payment and in-store payment products are released in December. The API documentation format has been updated to a new version for better user experience. You can now access subfields in the same documentation. Previously, subfields were only available in data dictionary. You can go to API Reference > Product APIs > Online payments (https://global.alipay.com/docs/ac/ams/payment_cashier) to explore the new version.

May 2020

A new version of Alipay Docs is released in May. Technical documentation on original portal (https://global.alipay.com/open/doc.htm) is merged to this new site for a better user experience. You can go to Documentation > Legacy Documentation (https://global.alipay.com/docs/ac/legacy/legacydoc) to view details.