Skip to main content
POST
/
v1
/
payments
/
payouts
Create batch payout
curl --request POST \
  --url https://api-m.sandbox.paypal.com/v1/payments/payouts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sender_batch_header": {
    "sender_batch_id": "Payouts_2018_100007",
    "email_subject": "You have a payout!",
    "email_message": "You have received a payout! Thanks for using our service!"
  },
  "items": [
    {
      "recipient_type": "EMAIL",
      "amount": {
        "value": "9.87",
        "currency": "USD"
      },
      "note": "Thanks for your patronage!",
      "sender_item_id": "201403140001",
      "receiver": "receiver@example.com",
      "alternate_notification_method": {
        "phone": {
          "country_code": "91",
          "national_number": "9999988888"
        }
      },
      "notification_language": "fr-FR"
    },
    {
      "recipient_type": "PHONE",
      "amount": {
        "value": "112.34",
        "currency": "USD"
      },
      "note": "Thanks for your support!",
      "sender_item_id": "201403140002",
      "receiver": "91-734-234-1234"
    },
    {
      "recipient_type": "PAYPAL_ID",
      "amount": {
        "value": "5.32",
        "currency": "USD"
      },
      "note": "Thanks for your patronage!",
      "sender_item_id": "201403140003",
      "receiver": "G83JXTJ5EHCQ2"
    }
  ]
}'
{
  "batch_header": {
    "payout_batch_id": "<string>",
    "batch_status": "DENIED",
    "time_created": "2023-11-07T05:31:56Z",
    "sender_batch_header": {
      "sender_batch_id": "<string>",
      "recipient_type": "EMAIL",
      "email_subject": "<string>",
      "email_message": "<string>"
    }
  },
  "links": [
    {
      "href": "<string>",
      "rel": "<string>",
      "method": "GET"
    }
  ]
}

Authorizations

Authorization
string
header
required

Oauth 2.0 authentication

Headers

PayPal-Request-Id
string

The server stores keys for 30 days.

Required string length: 1 - 1000

Body

application/json

The create payout request.

sender_batch_header
object
required

The sender-provided payout header for a payout request.

items
Payout Item · object[]
required

An array of individual payout items.

Required array length: 1 - 15000 elements

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.

The create payout response.

batch_header
object

The payout header.

An array of request-related HATEOAS links.

Required array length: 1 - 15000 elements
I