Public preview

Test sending payouts Public preview

Learn how to test Global Payouts in a sandbox environment.

To confirm your integration works, you can simulate sending payouts in a test environment.

Use API keys

You must use restricted API keys to make live requests to the Global Payouts APIs. For a standard integration, create a restricted key with the following permissions:

• Recipient Configuration: Write
• Money Management Financial Accounts: Read
• Money Management Payout Methods: Write
• Money Management Outbound Payments: Write

Grant additional permissions for these scenarios:

• For UK Confirmation of Payee or the related setting/Eurozone payments that require Recipient Verifications, grant Money Management Recipient Verifications: Write .
• If you use the gated Payout Intents API path, grant Money Management Payout Intents: Write .

Sandboxes

In the Stripe Dashboard, go to a Sandbox to test functionality without affecting your live integration. Learn more about Sandboxes.

Use sandbox API key

Use a sandbox API key to test your integration. Sandbox API keys contain the sk_test_ prefix and live mode secret keys contain the sk_live_ prefix. Keys associated with a sandbox can only operate on objects in that sandbox.

1. Navigate to Developers , and click API keys .
2. Under Standard keys , locate your secret test key.

Set up your sandbox

1. In the Dashboard, click the account picker, and choose Create sandbox . If you have an existing sandbox, select that sandbox.
2. On the Global Payouts page, click Get started to begin testing.

You can exit the sandbox and return to your live mode account from the account picker.

Additional sandboxes

You can create additional sandboxes using the instructions above. Additional sandboxes that you create don’t have payouts activated by default.

Fund your sandbox

You can use your sandbox financial account to test the funding options for Global Payouts.

Send funds from your external bank account

Use the Dashboard or a test helper API with your sandbox API key to simulate receiving funds into your financial account from an external bank account.

If you don’t see a sandbox banner at the top of the Dashboard, use the account picker to select a sandbox to use.

1. On the Balances page, click Add funds .
2. Select the financial account to fund.
3. Select Manually transfer from your bank account , then click Continue .
4. In Sandbox shortcut , enter an amount, then click Add money .

Pull funds from your external bank account US only

Stripe attaches a verified bank account to your sandbox that you can use to fund your account through the Dashboard or API. Follow the instructions to pull funds from your external bank account using the test credentials in your sandbox, or using the sandbox API key.

Transfer funds from your Stripe balance

Use the Dashboard or API to create a test charge on your account using a test card that bypasses your pending balance. The test charge settles immediately into the available balance to avoid simulated delays.

You can transfer funds following the instructions to transfer funds from your Stripe balance.

Create recipient and send money

After enabling Global Payouts on your sandbox and funding the sandbox financial account, you can create recipients and send money to them. Use test payout credentials to test different scenarios in your sandboxes. You can’t use these test accounts in live mode.

Test bank account numbers

If you’re in a sandbox, you can use the related setting as the verification code.

Recipient country:

Test debit cards for Instant Payouts

Only non-prepaid debit cards are supported. Use test debit cards to test different scenarios in your sandboxes. These test accounts don’t work in live mode.