Create a Global Payout recipient with the APIPublic preview
Learn how to onboard recipients for Global Payouts using the Stripe API.
Build an information collection flow for your recipients to collect recipient and payout method details, and then pass that information to Stripe through our APIs.
Considerations
Your business is responsible for all interactions with your recipients and for collecting all the necessary information to verify them. Stripe updates recipient verification requirements as laws and regulations change around the world.
When building a payout integration, consider how to handle:
- Regularly reviewing changes to legal and regulatory requirements.
- Updating your application logic in response to these changes.
Plan to review and update onboarding requirements on a regular basis to avoid payout failures.
Create a recipient
When using a form to collect payout recipient information, use the Accounts API v2 to create a recipient. You must provide the following parameters to create the Account ID:
| Required information | Parameter |
|---|---|
| Recipient’s country | identity. |
| Recipient’s type of business | identity. |
| Recipient’s email | contact_ |
The display name for the Account. It appears in the Stripe Dashboard and on any invoices that you send to the Account. | display_ |
| Payout methods you want to enable | configuration. |
Public preview
Cross-border payouts for US senders is available in public preview.
You must specify your intended payout method types by requesting the corresponding capabilities when you create the Account.
| Payout method | API parameter | Description |
|---|---|---|
| Local bank | configuration. | Allows the Account to receive OutboundPayments over local bank networks, such as ACH or FPS. |
| Bank wire | configuration. | Allows the Account to receive OutboundPayments over wire networks, such as Fedwire or SWIFT. |
| Cards | configuration. | Allows the Account to receive OutboundPayments over debit card networks, such as Visa Direct or Mastercard Send. |
A recipient can have multiple payout method types enabled. Not all payout method types are available for recipients in all countries. See the full list of available payout methods by country.
Some capabilities require additional information about your recipient. For example, configuration. for a US recipient requires you to submit an account and routing number. After you request payout method capabilities, Stripe determines the additional information requirements that you need to submit to enable them and can identify it in the API response. To receive the requirements in the response, include requirements, configuration., and identity in the include array. Otherwise, Stripe returns a null response for those properties, regardless of their actual values.
Determine required fields to activate a recipient
To identify the specific requirements that you must submit, inspect the requirements.entries array in the Accounts API response. For the recipient to accept payouts, you must provide all requirements that have the restricts_ property.
{ "id": "{{CONNECTED_ACCOUNT_ID}}", "object": "v2.core.account", "applied_configurations": [ "recipient" ], "configuration": { "customer": null, "merchant": null, "recipient": {
Submit recipient information to Stripe
After you collect the required information, use the Accounts API to submit it.
Confirm that the recipient is enabled
Retrieve the Account and inspect the status of the capabilities you’ve requested. The status of a payout method capability must be active for the recipient to receive payouts by that method.
Create payout methods for your recipients
After enabling a payout method capability, use the Outbound Setup Intents API to create the recipient’s actual PayoutMethod.
The Stripe-Context header in this request must be the recipient’s account ID.
Note
The OutboundSetupIntent response contains the PayoutMethod. When making an OutboundPayment, use the PayoutMethod ID (for example, frba_), not the OutboundSetupIntent ID (osi_).
To send payouts by wire transfer, use the US Bank Accounts API to add the fedwire_ to the PayoutMethod. Additional fees apply. See pricing for details.
You can also use debit cards as a payout method. However, your recipients must submit their debit card information directly to Stripe. If you’re interested in enabling payouts by debit cards, use the Account Links API to create a shareable form for your user to submit their debit card credentials.
View all payout methods for a recipient
Use the Payout Methods API to retrieve a recipient’s PayoutMethods.
The Stripe-Context header in this request must be the recipient’s Account ID.
The response contains a list of PayoutMethod objects associated with the recipient. Use a PayoutMethod ID to make a payout using the Outbound Payments API. See Send money for more details.