Qodex.ai

Create batch payout

POST {{base_url}}/v1/payments/payouts

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.

Notes:

  • PayPal does not process duplicate payouts. If you specify a senderbatchid that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate senderbatchid and includes a HATEOAS link to the original payout with the same senderbatchid.

    If you receive an HTTP 5nn status code, you can safely retry the request with the same senderbatchid.

  • The Payouts API does not support build notation (BN) codes. In a future Payouts release, you can optionally provide BN codes in the PayPal-Partner-Attribution-Id request header.

    For information about the PayPal-Partner-Attribution-Id header, see HTTP request headers. To learn about or request a BN code, contact your partner manager or see PayPal Partner Program.

Request Body

{"sender_batch_header"=>{"sender_batch_id"=>"Payouts_{{$timestamp}}", "email_subject"=>"You have a payout!", "email_message"=>"You have received a payout! Thanks for using our service!"}, "items"=>[{"recipient_type"=>"EMAIL", "amount"=>{"value"=>"10.00", "currency"=>"USD"}, "note"=>"Thanks for your patronage!", "sender_item_id"=>"201403140001", "receiver"=>"{{$randomEmail}}", "notification_language"=>"en-US"}, {"recipient_type"=>"PHONE", "amount"=>{"value"=>"20.00", "currency"=>"USD"}, "note"=>"Thanks for your support!", "sender_item_id"=>"201403140002", "receiver"=>"1-{{$randomPhoneNumber}}"}, {"recipient_type"=>"PAYPAL_ID", "amount"=>{"value"=>"30.00", "currency"=>"USD"}, "note"=>"Thanks for your patronage!", "sender_item_id"=>"201403140003", "receiver"=>"G83KXTJ5EHCQ2"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-TypestringThe Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.
PayPal-Request-IdstringThe server stores keys for 30 days.
PayPal-Client-Metadata-IdstringOptional. Verifies that the payment originates from a valid, user-consented device and application. Reduces fraud and decreases declines. Transactions that do not include a client metadata ID are not eligible for PayPal Seller Protection.
PayPal-Partner-Attribution-IdstringOptional. Identifies the caller as a PayPal partner. To receive revenue attribution, specify a unique build notation (BN) code. BN codes provide tracking on all transactions that originate or are associated with a particular partner. To find your BN code, see Code and Credential Reference.
PayPal-Auth-AssertionstringAn API client-provided JSON Web Token (JWT) assertion that identifies the merchant. To use this header, you must get consent to act on behalf of a merchant.
PreferstringThe preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>
PreferstringThe preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>

RESPONSES

status: Created

{&quot;batch_header&quot;:{&quot;payout_batch_id&quot;:&quot;42WWRAXUXYSQQ&quot;,&quot;batch_status&quot;:&quot;PENDING&quot;,&quot;sender_batch_header&quot;:{&quot;sender_batch_id&quot;:&quot;Payouts_1643784368&quot;,&quot;email_subject&quot;:&quot;You have a payout!&quot;,&quot;email_message&quot;:&quot;You have received a payout! Thanks for using our service!&quot;}},&quot;links&quot;:[{&quot;href&quot;:&quot;https://api.sandbox.paypal.com/v1/payments/payouts/42WWRAXUXYSQQ&quot;,&quot;rel&quot;:&quot;self&quot;,&quot;method&quot;:&quot;GET&quot;,&quot;encType&quot;:&quot;application/json&quot;}]}