Use the Payouts API to create and show details for batch and single payouts.
Use the Payouts API to send multiple individual payouts in one API call to an email address or US mobile phone number.
Note: Payouts are available everywhere that Mass Payments are available. Any payouts that you send through the Payouts API appear as Mass Payments in your PayPal account and in Mass Payment reports.
Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations. A synchronous mode payout immediately returns the results of the payout.
The Payouts API processes payouts in either asynchronous or synchronous mode:
|Payout mode||Applies to||Parameter||Description|
|Asynchronous||Batch or single payouts||
Specify multiple individual payouts in one API call. You can show the payout status at a later time.
||Specify one payout. Payout status appears immediately at time of payout.
Note: (Deprecation notice) Synchronous mode will soon be deprecated and is no longer available for new integrations but continues to be supported for existing integrations.
Payout requests in either mode accept the same request data.
Duplicate payout requests
PayPal prevents duplicate batches from being processed. If you specify a
sender_batch_id that was used in the last 30 days, the API rejects the request and returns an error message that indicates the duplicate
sender_batch_id and includes a HATEOAS link to the original batch payout with the same
sender_batch_id. If you receive an HTTP
5nn status code, you can safely retry the request with the same
sender_batch_id. In any case, the API completes a payment only once for a specific
sender_batch_id that is used within 30 days.
The sender pays payout fees at transaction time. Fees vary by sending country, are calculated as a percentage of each transaction, and are capped. Typically, the variable component is 2% and the domestic payments cap differs from the international payments cap. For detailed information about payout fees, see the PayPal Merchant Fees page.
The funding PayPal account for a payout request must hold the total payout amount plus any fees in the currency being sent. A payout item has these limits but the maximum total payout amount is unlimited:
|Country||Individual payout maximum||Total payout maximum|
|Other countries||Depends on the payments standard sending limit||Unlimited.|
By default, the Payouts feature is enabled in the sandbox environment. Merchants in the U.S. with a business account can enable Payouts in the live environment.
Note: Merchants in other countries must contact their account manager or customer service to enable Payouts in the live environment.
To enable payouts:
Go to My Account and log in.
Click the Enable link to enable Payouts. Complete the questionnaire.
After you are approved for Payouts, create a PayPal app or navigate to your apps.
Enable Payouts for your app.
You can show details for all items in a batch payout or an individual payout. Payout details include the payout status.
To show details for all items in your batch payout, use the
payout_batch_id from the batch response.
To show details for an individual payout item, use the
payout_item_id for an item from the batch response. You can show item details even if the transaction failed, such as when PayPal declines the payout.