Integration guide

This guide walks you through the whole integration process. Follow these steps to complete the integration and mark progress on the steps if necessary.

  1. 1

    Set up

    5 steps Collapse all Expand all
    1. 1. Sign up and log in to Alipay Developer Center

      Mark the card Unmark the card

      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.

    2. 2. Create an application

      Mark the card Unmark the card

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

    3. 3. Get sandbox client ID

      Mark the card Unmark the card

      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.

    4. 4. Set public key

      Mark the card Unmark the card

      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.

    5. 5. Set notification URL

      Mark the card Unmark the card

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

  2. 2

    Integrate in sandbox

    5 steps
    1. 1. Test APIs

      Mark the card Unmark the card

      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.

    2. 2. Implement system development and debugging

      Mark the card Unmark the card

      Implement system integration with Alipay SDKs or customized coding. The following 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.
    3. 3. Conduct the end-to-end test

      Mark the card Unmark the card

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

    4. 4. Complete acceptance testing

      Mark the card Unmark the card

      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.

    5. 5. View reports

      Mark the card Unmark the card

      Contact Alipay Technical Support to get reports.

  3. 3

    Go live

    5 steps
    1. 1. Get production client ID

      Mark the card Unmark the card

      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.

    2. 2. Set production public key

      Mark the card Unmark the card

      Generate your public key with the provided tool and submit the public key in Production 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.

    3. 3. Confirm the contract status

      Mark the card Unmark the card

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

    4. 4. Launch the application

      Mark the card Unmark the card

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

    5. 5. Update client ID and public key

      Mark the card Unmark the card

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

  4. 4

    Conduct pilot testing

    3 steps
    1. 1. Download wallet app

      Mark the card Unmark the card

      Download the wallet app from the app store.

    2. 2. Prepare live account

      Mark the card Unmark the card

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

    3. 3. Complete pilot testing

      Mark the card Unmark the card

      Ensure your applications are running smoothly end-to-end by performing test cases in the production environment with the live account.

  5. 5

    Start your business

    Collapse all Expand all

    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.