Merchant Payout API
The Merchant Payout API (also called Payout API or 代付 API in Chinese documentation) lets platforms send funds to end users, creators, or suppliers. SoPay documents payout integration for multiple countries under a shared security model—RSA2 signing and signed webhooks—while keeping beneficiary fields and currencies market-specific.
Use this page to understand payout architecture across regions. Country-specific paths, headers, and JSON fields are in each Payment API documentation overview and dedicated payout chapters.
What payout APIs include
A production Payout API integration typically implements:
- Create payout — amount, merchant order ID, beneficiary details, notification URL
- Query payout — status polling by platform or merchant reference
- Webhook handler — verify signature, update ledger, respond
OK - Idempotency — safe replays when the platform retries notifications
SoPay Merchant Payout API is a platform boundary. Banks, wallets, and local clearing networks sit behind it—you do not call those rails directly.
Country documentation map
| Country | Solution overview | Payout reference |
|---|---|---|
| India | India Payment API | India Payment API documentation (payout) |
| Thailand | Thailand Payment API | Thailand Payout API |
| Pakistan | Pakistan Payment API | Pakistan Payout API |
| China | — | China payout |
Field highlights differ: IFSC in India, payee_bank_code in some Thailand Open API examples, wallet metadata in Pakistan. Never assume one beneficiary schema works in all markets.
Typical server-side flow
- Build JSON on your backend (never expose private keys to clients)
- Sign the request per Merchant Signature Verification
POSTto the country-specific payout create path documented in that market’s overview- Persist platform order identifiers; expect
processingintermediate states - Finalize business state from signed webhooks (Merchant Callback API) or query endpoints
Relationship to Merchant Collection API
Payin (collection) increases merchant-available balance; payout decreases it. Some countries expose wallet query APIs on the overview page—for example India Payment API documentation. Funding rules and fees are configured per merchant in the platform back office.
Security and compliance
- Run payout create only from trusted servers
- Reject unsigned or failed-verification webhooks
- Do not promise users fixed arrival times, success rates, or fees in UI copy
- Follow KYC/AML obligations in your jurisdictions and in your SoPay agreement
Cross Border Payment API
Global platforms treat SoPay as a Cross Border Payment API partner: one engineering pattern for signatures and callbacks, multiple country modules for currency and beneficiary validation. See also Payment Gateway API for the full payin + payout picture.
Frequently Asked Questions
What fields are required to create a payout?
They vary by country. India: see payout section in India overview. Thailand: Thailand Payout API. Pakistan: Pakistan Payout API.
Which order ID should queries use?
Many Open API docs accept platform_order_no or merchant_order_no (one required). Header-signed merchant APIs may differ—follow the country overview.
How do I stop duplicate webhook processing?
Key business updates on merchant order number (or platform order number) with idempotent writes. Return OK only after persistence succeeds. Details: Callback guide.
Is there a single global payout endpoint?
No. Cross Border Payment API support is implemented as separate country configurations, not one universal URL.
Where do sandbox credentials live?
Environment bases and keys are described per country overview and Quick Start.