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

      Alipay developers center user guidance

      The Alipay Developers Center helps you to integrate with Alipay products. This section provides information about how use the Alipay Developers Center to perform self-integration process. Contact overseas_support@service.alibaba.com if you face issues with logging in.


      #Integration process

      Integration with Alipay product via Alipay Developers Center consists of the following steps:

      image

      Figure 1. Integration process


      #1. Register & Log in:

      Register on the Alipay portal to become an Alipay business partner, and get your Alipay account to log in to the Alipay Developers Center to start your integration process.


      Note:

      The account for logging in to the Alipay Developers Center needs to be the same account as the one used in the signed Alipay contract. 


      #2. Become a developer:

      After you log in to the Alipay Developers Center, read and agree to Alipay Developers Terms of Use. Then specify your role to set the integration mode.

      Types of roles:

      • Merchant

      Choose this if you are making the integration for your company in-house.

      • Acquirer

      Choose this if you are making the integration for your company in-house.

      • System Integrator/Independent Software Vendor  

      Choose this if you are a merchant who is outsourcing the integration to a system integrator.  

      Choose this if you are an ISV that has signed a contract with Alipay to provide integration services for merchants.  


      Dingtalk_20210220103940.jpg

      Figure 2. Specify the role


      After you select the role, select one of the listed countries/regions to indicate the business registration country/region. Please choose carefully as the business registration country/region determines Alipay integration settings, and this cannot be changed later in the integration process.


      Dingtalk_20210220103834.jpg

      Figure 3. Specify the business registration country/region


      Once you have completed the above steps and have successfully onboarded as an Alipay developer, read the Quick Start guide to quickly familiarize yourself with the upcoming steps and click Get Started to continue.


      Dingtalk_20210220110835.jpg

      Figure 4. Quick start guide


      #3. Create application & Select product:

      Create an application in the home page of Alipay Developers Center and provide basic information about the application, such as the application name, application type, and application description.


      Dingtalk_20210220111008.jpg

      Figure 5. Enter application information


      Select the product and scenarios to integrate with and specify the test currency. Each application supports only one product and one test currency. However, multiple scenarios of one product can be supported. If you want to integrate with more than one product, you need to create several applications.


      Dingtalk_20210220114418.jpg

      Figure 6. Select the product and scenarios


      After creating the application, you can check your Client ID and other related information about the application on the Basic Information page:


      Dingtalk_20210220115514.jpg

      Figure 7. Check the application's basic information


      You can also see all the created applications and its corresponding statuses on the home page of Alipay Developers Center.


      Dingtalk_20210220115646.jpg

      Figure 8. Home page of Alipay Developers Center


      #4. Receive sandbox resources

      After creating the application and selecting the product, sandbox resources are automatically allocated to you. You can check the sandbox resources on the Sandbox page. Sandbox resources include:

      • Sandbox Client ID
      • Buyer account and password of the Alipay China wallet. You can top up the wallet's balance.
      • Merchant account


      Dingtalk_20210220134258.jpg

      Figure 9. Sandbox resources


      #5. Configure in sandbox:

      On the Integration Settings page, you can check your sandbox Client ID, configure sandbox keys, and set the gateway URL.


      Dingtalk_20210220134836.jpg

      Figure 10. Integration Settings page


      To make your integration safer, Alipay uses asymmetric keys. You need to upload your public key on Alipay Developers Center to get the Alipay public key.


      Dingtalk_20210220135145.jpg

      Figure 11. Set the public key


      Dingtalk_20210220135247.jpg

      Figure 12. View the Alipay public key


      #6. Test in sandbox:

      After configuring sandbox environment, you need to develop and integrate with Alipay services in the test environment. A production environment is simulated with the sandbox resources you obtained in step 4. Integrating in the test environment consists of the following parts: 

      • Calling APIs 
      • Processing reconciliation files 
      • Testing and acceptance


      For more information about testing, see Testing.


      #7. Go live and launch:

      Once you have completed tests in sandbox and are ready to go live, you can enter the Integration Settings page, click on the Live tab, and make the following configurations:

      • Get your production Client ID on the page.
      • Set your public key and then get the Alipay public key. The keys are to be used for signing the request and verifying the signature after the application rollout.
      • Set the gateway URL for the production environment.


      Dingtalk_20210220135457.jpg

      Figure 13. Configure the production environment


      After configuring for the production environment, you can launch your application by clicking the Launch button.


      Note:

      You can only launch an application after you have signed the business contract with Alipay. After the application has launched, email verification is needed if you need to modify configuration details such as the public key or notification URL.


      Dingtalk_20210220140736.jpg

      Figure 14. Launch the application


      For more information about going live, see Going live.