Before calling the Transfer API, complete sandbox onboarding, whitelist setup, and merchant credential preparation. It is recommended that you prepare the environment and merchant information first, and then proceed to request signing and the integration flow.
Overview
Setup mainly includes the following items:
- Provide the onboarding email
- Provide the test integration domain
- Wait for the activation email
- Log in to the merchant portal to obtain merchant credentials
- Complete whitelist and follow-up configuration
Environment Description
The request URLs for the Production and Sandbox environments differ only in domain names. In practice, the integration process is usually:
- Complete integration testing in the Sandbox environment
- Verify signing and payout flow
- Switch to the Production domain and Production configuration
This helps expose issues in the test environment first, instead of mixing environment issues with business issues during production cutover.
Environment Domains
| Environment | Domain |
|---|---|
| Sandbox | https://sandbox-api.onerway.com/payout |
| Production | https://api.onerway.com/payout |
Merchant Onboarding and Whitelist
Before creating a sandbox test merchant, please prepare:
- Onboarding email
- Domain used for test integration
The onboarding email is used to create the sandbox account. The submitted domain will be added to the whitelist, and only whitelisted domains can call the Onerway API.
This means that during setup, in addition to “whether an account exists,” you should also confirm:
- Whether the domain has been submitted
- Whether the domain has been added to the whitelist
- Whether the actual request origin matches the whitelist configuration
If the domain has not completed whitelist configuration, the API may still fail even if the request payload itself is correct.
Merchant Credentials
After receiving the activation email, log in through the merchant portal link in the email. On first login, you need to reset the password and then obtain the merchant credentials.
In Transfer, use the actual request field name merchantNo.
You will typically need to prepare:
merchantNo- The key or private key corresponding to the signing method
merchantNo. Do not replace it with merchantId.Required Field Markers
Field tables use the following markers:
| Marker | Meaning |
|---|---|
M | Required |
C | Conditionally required |
N | Optional |
Pre-Integration Checklist
Before you start building request payloads, creating beneficiaries, or initiating payouts, confirm that:
- The sandbox account has been activated
- The integration domain has been added to the whitelist
- Merchant credentials have been obtained from the merchant portal
- The signing method has been confirmed
- Required fields for the target country, currency, payout method, and entity type have been confirmed
After completing this preparation, the next steps are usually:
- Request signing preparation
- Integration flow confirmation
- Sandbox testing and go-live preparation