Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onswitch.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
Step 1: Get your service key

  1. Go to Switch dashboard.
  2. Create an account or sign in.
  3. Go to the API keys section.
  4. Copy your service key (sandbox or live).
Keep your service key secret. Do not expose or share it publicly.

​
Step 2: Fetch beneficiary fields

Before you build your payout form, call GET /requirement with the country, direction, and channel so you know which fields belong in the beneficiary object for Initiate a payout.Allowed values are listed under Countries.

​
Step 3: Initiate a payout

Initiate a payout creates a payout instance and returns a stabelcoin deposit address. Send exactly deposit.amount of deposit.asset to deposit.address to complete the payment automatically.See Stablecoin to NGN guide for more details.

​
Next steps

You have called the API end-to-end. From here, deepen your integration:

Countries

Payout and top-up rails, currencies, and channels by market.

Stablecoins

How we handle supported assets and networks.

Webhooks

Subscribe to status updates for payouts and other events.

Guides

Step-by-step guides for different payout scenarios.

​
Need Help?

Email Support

Send us a message.

Book a call

Hop on a call with us.