Create batch payout

Creates a batch payout. In the JSON request body, pass a sender_batch_header and an items array. The sender_batch_header defines how to handle the payout. The items array defines the payout items. You can make payouts to one or more recipients.<blockquote>Notes: <ul><li>PayPal does not process duplicate payouts. If you specify a <code>sender_batch_id</code> that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate <code>sender_batch_id</code> and includes a HATEOAS link to the original payout with the same <code>sender_batch_id</code>.If you receive an HTTP <code>5nn</code> status code, you can safely retry the request with the same <code>sender_batch_id</code>.</li><li>The Payouts API does not support build notation (BN) codes. In a future Payouts release, you can optionally provide BN codes in the <code>PayPal-Partner-Attribution-Id</code> request header.For information about the <code>PayPal-Partner-Attribution-Id</code> header, see <a href="/api/rest/requests/#http-request-headers">HTTP request headers</a>. To learn about or request a BN code, contact your partner manager or see <a href="https://www.paypal.com/us/webapps/mpp/partner-program">PayPal Partner Program</a>.</li></ul></blockquote>

post/v1/payments/payouts

Request

Base URL
https://api-m.paypal.com
Auth
OAuth 2
Client credentials
Token URL/v1/oauth2/token
Scopeshttps://uri.paypal.com/payments/payouts
TypeScript
https://skmtc.dev/paypal/apis/payments/docs/v1/payments/payouts/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

PayPal-Request-Idstring

The server stores keys for 3 hours.

Request body

Response

A successful request returns the HTTP <code>201 Created</code> status code and a JSON response body that shows the ID for the payout and payout details. To show payout status, use the <code>payout_batch_id</code> value that appears in the response. If the initial scan that checks for syntax errors, missing or duplicated keywords, and more succeeds, the <code>batch_status</code> is <code>PENDING</code>. The initial scan checks for syntax errors and missing or duplicated keywords. The API does not immediately validate some payout item values, such as the receiver phone numbers.

Changes

No recorded changes to this operation across all 1 revision of this API.