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

      Integration guide

      This guide talks you through the whole integration process. Follow these steps to complete the integration.


      #Step 1: Set up

      1. Sign up and log in to Alipay Developer Center:

      Use the account that has signed the contract with Alipay to log in to Alipay Developer Center. If you don't have such an account, sign up at Alipay Developer Center.

      1. Create an application:

      Create an application and specify the product to be integrated. One application corresponds to one integration project.

      1. Get sandbox client ID:

      Get the client ID for sandbox environment in the Sandbox section of Integration Settings in Alipay Developer Center. Each application is assigned with a unique sandbox client ID.

      1. Set public key:

      Generate your public key with the provided tool and submit the public key in the Sandbox section of Integration Settings in Alipay Developer Center. After submission, Alipay public key will be generated and shown in Integration Settings. Public keys will be used in data transmission.

      1. Set notification URL:

      Specify the notification URL so that Alipay notifications can be received.


      #Step 2: Integrate in sandbox

      1. Test APIs:

      Use the iTest tool or create a request by yourself to test APIs. The clientId and public key obtained from Step 1 will be used in this step.

      1. Implement system development and debugging:

      Implement system integration with Alipay SDKs or customized coding. The following developer tools will facilitate the integration process:

        • iMock: This tool helps to test for exceptional cases.
        • iDiagnose: This tool helps to identify issues.
        • iNotify: This tool helps to simulate asynchronous notification.
      1. Conduct the end-to-end test:

      Use the test wallet and account to make an end-to-end test. To get the test wallet and account, contact Alipay Technical Support.

      1. Complete acceptance testing:

      Execute and pass all mandatory test cases in Test Suites of Alipay Developer Center. Complete acceptance testing to increase the quality, robustness, and usability of your application systems.

      1. View reports:

      Contact Alipay Technical Support to get reports.


      #Step 3: Go live

      1. Get production client ID:

      Get the client ID for production environment in the Production section of Integration Settings in Alipay Developer Center. Each application is assigned with a unique production client ID.

      1. Set production public key:

      Generate your public key with the provided tool and submit the public key in the Production section of Integration Settings in Alipay Developer Center. After submission, Alipay public key will be generated and shown in Integration Settings. Public keys will be used in data transmission.

      1. Confirm the contract status:

      Ensure Alipay contract is signed before going live. Otherwise, your company representative needs to contact Alipay.

      1. Launch the application:

      Click Launch in Alipay Developer Center, after which the application and the production clientId become valid for the production environment.

      1. Update client ID and public key:

      Use the production client ID and public key instead of the sandbox client ID and public key in your coding project.


      #Step 4: Conduct pilot testing

      1. Download wallet app:

      Download the wallet app from the app store.

      1. Prepare live account:

      Prepare the live account. Contact Alipay Technical Support if you need help creating a live wallet account.

      1. Complete pilot testing:

      Ensure your applications are running smoothly end-to-end by performing test cases in the production environment with the live account. After completing the pilot testing, click Complete in Integration Progress of Alipay Developer Center to notify the system of your pilot testing process.


      #Step 5: Start your business

      Once your application has been activated for business, notify Alipay so that we can monitor your system's behavior and check for any unpredictable errors that might affect your business.