You can make payouts to multiple PayPal accounts or to a single PayPal account.
By default, a payout API call is asynchronous, which means you retrieve the results of the payout at a later time. See Create a batch payout.
If you are submitting a single payout, you can make a synchronous payout call, which immediately returns the results of the payout. In a synchronous payout call, the response is similar to a batch payout status response. To make a synchronous payout, specify
sync_mode=true in the URL:
The asynchronous payout mode (
sync_mode=false, which is the default) enables a maximum of 500 individual payouts to be specified in one API call. Exceeding 500 payouts in one call returns an HTTP response message with status code 400 (Bad Request).
PayPal prevents duplicate batches from being processed. If you specify a
sender_batch_id that was used in the last 30 days, the batch request is rejected with an error message:
Batch with given sender_batch_id already exists. The error response includes a HATEOAS link to the original batch payout with the same
Note: Payouts does not currently support BN Codes. In a future release of Payouts, BN Codes optionally can be provided in the
PayPal-Partner-Attribution-Id header of the request. For information about the
PayPal-Partner-Attribution-Id header, see Authentication & Headers. To learn more or to request a BN Code, contact your Partner Manager or visit the following location: PayPal Partner Portal.