Payout API Overview
Product Introduction
Payout API provides cross-border and local payment capabilities to help businesses or platforms efficiently complete global fund distribution. Through a unified interface, you can conduct secure and compliant fund disbursement operations in different countries and regions.
Business Scenarios
Pay to Individual
Description: Directly transfer funds to a designated individual's account, used for salary payments, refunds, compensation, and other scenarios.
Pay to Business
Description: Transfer funds to a corporate or institutional account, used for supplier settlements, service fee payments, and other business-to-business payment scenarios.
Payout on Behalf Of
Description: Initiate payments on behalf of a specified individual or entity (individual, business, creator, etc.), i.e., platform or agent disbursement. Commonly used for platforms to distribute earnings on behalf of creators, or third-party agents to complete external payments on behalf of clients.
Environment Description
Production and Sandbox environments differ only in domain names.
Recommendation
It is recommended that you first test the Payout API in the Sandbox environment, confirm the business process is correct, and then switch to the Production environment.
| Environment Type | Base Domain | Usage |
|---|---|---|
| Sandbox (Test Environment) | https://api-sandbox.example.com | Simulate payout process, no actual charges |
| Production (Production Environment) | https://api.example.com | Formal transactions and production environment |
Integration Steps
Step 1: Provide Account Opening Information
- Provide email for creating sandbox account
- Provide domain for testing environment integration
- Domain will be added to whitelist
Note
Only whitelisted domains can call Onerway API, please ensure your domain has been added.
Step 2: Login to Merchant Client
- Receive login link in email
- Reset password after first login
- Normal use after completing password setup
Step 3: Obtain Merchant Information
After login, you can obtain the following important information:
| Information Item | Description | Purpose |
|---|---|---|
| Merchant ID | Merchant ID | Used to identify merchant |
| Private Key | Private Key | Used for API request signing |
Security Reminder
This information will be used for subsequent API calls and request signing, please keep it safe and do not disclose.
Step 4: Start Testing
- Fully test in Sandbox environment
- Verify business process correctness
- Switch to Production environment
- Official launch
Pre-launch Checklist
- All business process tests passed
- Signature mechanism verified correctly
- Callback address configured correctly
- Error handling logic complete
Important Reminders
Please Note
- Sandbox environment is for testing and debugging, no real transactions will occur
- Before switching to Production environment, please ensure all parameters, signatures and callback addresses are correctly configured
- All API requests must carry valid merchant ID and signature information for authentication
- Please keep your private key safe and avoid security risks from disclosure