Circle APIs Documentation

Learn how to integrate with Circle APIs to accept traditional and USDC payments, automate payouts, embed multi-asset accounts into your product or service, or power your internet marketplace.

Get Started    API Reference

Wire Payouts Testing

You can use the Circle API sandbox environment to exercise various types of payout behaviors, such as transaction failure or transaction returned.


No Real Payouts

The sandbox environment will allow any payout amount (except magic amounts specified below) to any bank account. Successful requests will never send money to a bank account.

Error Code

To trigger a specific error code for payouts, use the corresponding amounts below when creating a wire payout. Any amount not specified will result in a Successful payout.


Status Code

Error Code

Error Code Reason




Payout transaction is returned from the bank. This might be due to incorrect bank information provided. Note that fee could be incurred if this happens. For actual amount being returned to the payout wallet, please refer to Payout API documentation for more detailed information.




Payout transaction failed due to unspecified error.

Updated about a year ago

Wire Payouts Testing

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.