Test Global PayoutsPublic 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.

Note

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

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

Create a new restricted key with these permissions.

Grant additional permissions for these scenarios:

For UK payments, grant Vault GB Bank Accounts: Write.
For SEPA or 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.

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

Set up your sandbox

In the Dashboard, click the account picker, and choose Create sandbox. If you have an existing sandbox, select that sandbox.
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.

On the Balances page, click Transfer.
Click View external funding instructions.
Click Request account details to see where to send funds. Stripe generates your account details within a few minutes and emails you when they’re ready.
When the sandbox shortcut is enabled, add 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. The test charge settles immediately into the available balance to avoid simulated delays.

Make sure to use:

A valid future date, such as 12/34
Any 3-digit number for the CVC field
Any value you want for the other form fields

Description	Number	Details
Bypass pending balance		The US charge succeeds. Funds are added directly to your available balance, bypassing your pending balance.
Bypass pending balance		The international charge succeeds. Funds are added directly to your available balance, bypassing your pending balance.

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 SM11AA as the verification code.

Recipient country:

SWIFT / BIC Code	IBAN	Behavior
`AAAAALTXXXX`	`AL35202111090000000001234567`	Payout succeeds.
`AAAAALTXXXX`	`AL45203212081330011330011330`	Payout fails with a `no_account` code.
`AAAAALTXXXX`	`AL31203212081330021330021330`	Payout fails with an `account_closed` code.
`AAAAALTXXXX`	`AL17203212081330031330031330`	Payout fails with a `insufficient_funds` code.
`AAAAALTXXXX`	`AL03203212081330041330041330`	Payout fails with a `debit_not_authorized` code.
`AAAAALTXXXX`	`AL86203212081330051330051330`	Payout fails with an `invalid_currency` code.

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.

Brand	Number	CVC	Date	Behavior
Visa (debit)	4000056655665556	Any 3 digits	Any future date	Payout succeeds.
Mastercard (debit)	5200828282828210	Any 3 digits	Any future date	The `OutboundPayment` succeeds.
Discover (debit)	6011981111111113	Any 3 digits	Any future date	The `OutboundPayment` succeeds.
Visa (debit)	4000056655665572	Any 3 digits	Any future date	The OutboundPayment fails after being sent. Only works with test secret keys.
Visa (credit)	4242424242424242	Any 3 digits	Any future date	The payout fails because the card isn’t eligible for a payout.
Mastercard (prepaid)	5105105105105100	Any 3 digits	Any future date	The payout fails because the card isn’t eligible for a payout.