We recommend you read through the API Documentation in full to familiarise yourself with the features and workflows associated with the product.I. Development Environment Description#
UseePay provides developers with two independent development environments: the SandBox test environment and the Prod production environment:Test environment, allows free access from any IP
Production environment, only whitelisted IPs are allowed through the firewall. Therefore, before accessing the production environment, please provide your production server IPs to UseePay, and we will add the provided IPs to the firewall whitelist.
II. UseePay Egress IP Description#
UseePay will only access your server through egress IPs. To ensure proper interaction between both parties' interfaces, your server should keep the following IPs open:III. Integration Steps#
1. Activate Sandbox Environment#
Provide an email to activate the account
Please provide your email to the UseePay operations team in the customer support group.
(There is no special requirement for this email, just ensure that you can receive the activation email normally.)
The operations team will send an activation email to this address. After receiving the email, please follow the instructions in the email to activate the merchant back-office management system for the SandBox environment.
Please obtain the 3 required parameters in the request header as described below:2.1 x-merchant-no#
MC β Configuration Center β Secret Management β First row data2.2 x-api-key#
MC β Configuration Center β Secret Management β OpenApi Secret Key β Private Key (UseePay_SK_xxx)2.3 x-app-id#
MC β Configuration Center β Secret Management β Domain Management, the website domain/App English name added here is the appId.The appId must be approved by UseePay before you can call the APIs.
3. Integrate API Interfaces#
3.1 Integrate Interfaces#
Please integrate the payment interfaces according to your actual business requirements.3.2 Enable Webhook#
3.3 Obtain Reconciliation Files#
If you wish to pull detailed transaction reconciliation data in an automated manner, you can retrieve your transaction reconciliation files via SFTP from the UseePay file server.| host | port | username | password |
|---|
| sftp.useepay.com | 22 | Please contact UseePay to activate | Please contact UseePay to activate |
Transaction data for the current day will be generated on the next day. Under normal circumstances, yesterday's transaction data can be queried after 8:00 AM Beijing time.
Historical transaction data needs to be manually generated by contacting the operations team.
4. Complete System Testing#
Complete the full-process testing by referring to the test cases.
5. Activate Production Environment#
The process is the same as the SandBox environment:
Please provide an email address to the UseePay operations team in the customer support group for activating the production environment MC system. After receiving the email, the UseePay operations team will send a Prod environment MC system activation email to that address. Please follow the instructions in the email to activate the production merchant back-office management system.
6. Start Production Transactions#
First, conduct small-scale transaction tests to confirm that business processes such as payment are working correctly, then start full-scale production transactions.
