Integration Guide
Integration Guide
This document provides detailed step-by-step instructions for the standard PayCools integration process, helping merchants complete the onboarding smoothly.
Business Engagement
To efficiently move forward with the partnership, please coordinate with our business team to create a technical integration group chat and invite both parties' technical contacts and relevant stakeholders.
After joining the group chat, please share the following key information:
- Merchant Background: Including industry and core business model
- Products to Integrate: Specific product types can be confirmed with our business team
Environment Information
Technical support will send the relevant environment details to the technical group chat. Please save this information securely. It includes:
- API Domain: API endpoints for both testing and production environments
- Merchant Dashboard URL: Login addresses for the management dashboard in both environments
- Platform Public Key: Used to verify signatures of data returned by PayCools
For complete environment details, please refer to Environment Information.
Technical Configuration
Log in to the merchant dashboard with your test account and complete the following setup:
- Download and install Authenticator based on your mobile OS (skip if already installed)
- Scan the QR code on the right side of the page with Authenticator to bind MFA
- Enter the MFA code from Authenticator to complete the setup
For subsequent logins, simply check the MFA code â no need to bind again. If you need to rebind, please contact technical support to reset.
After logging in to the merchant dashboard, go to Developer â App Details and complete the following:
- Public Key: Generate and upload your own. Make sure there are no spaces or line breaks. For details, see Technical Parameter Configuration (Public Key Setup)
- Webhook: Payout is the callback for the disbursement product. If you are not integrating disbursement, this can be skipped. Must use HTTPS protocol with a valid domain name â do not use IP + port format
- IP Whitelist: Not required for the test environment. For production, send your IPs to technical support for configuration
Start Integration
Once technical configuration is complete, select the relevant integration documentation based on your product:
| Product | Sub-Product | Integration Docs |
|---|---|---|
| Global Acquiring | Acquiring Core Product | Cashier Mode |
| Direct API Mode | ||
| Pay-by-Link Mode | ||
| Global Acquiring | Subscription Deduction | Coming Soon |
| Global Disbursement | API Payment | API Payment |
| Merchant Portal Batch Payment | Merchant Portal Payment | |
| Merchant Portal Single Payment | Merchant Portal Payment |
Testing & Verification
After integration development is complete, please complete the following verifications in order:
Connectivity Test
- Send a simple request to verify network connectivity and confirm that signature verification, IP whitelist, and other basic configurations are correct
- Initiate one successful transaction and one failed transaction respectively to verify that requests and responses match expectations
- Verify that payment result callback notifications can be received properly, callback data is complete, and signature verification passes
UAT Acceptance Testing: After the connectivity test passes, please perform complete testing according to the UAT acceptance criteria. Send the results to the technical support group chat for backend review. Contact technical support to obtain the acceptance criteria.
UAT Testing: Please test according to the UAT acceptance checklist, fill in the relevant information, and send it to the technical support group chat for backend review. Contact technical support to obtain the acceptance checklist.
Production Testing: After UAT review is completed, enter the production testing phase. Technical support will send production domain and other details to your email.
Log in to the Production Merchant Dashboard with your production credentials and complete the configuration. The process is the same as the test environment.
Ask technical support in the group chat whether the fee rates and IP whitelist have been configured. Technical support will complete the configuration in the backend and provide feedback.
Once all configurations above are complete, you can start production testing. Please record a video of the test and send it to the technical group chat for records.
After confirming that all tests have passed, the integration is successfully completed.