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.

Notes:
PayPal does not process duplicate payouts. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate sender_batch_id and includes a HATEOAS link to the original 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.
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.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Payout to a list of recipients.https://uri.paypal.com/payments/payouts

Header Parameters

PayPal-Request-Id?string

The server stores keys for 30 days.

Match^.*$

Length1 <= length <= 1000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v1/payments/v1/payments/payouts" \  -H "Content-Type: application/json" \  -d '{    "sender_batch_header": {},    "items": [      {        "amount": {          "currency": "string",          "value": "string"        },        "receiver": "string"      }    ]  }'

{
  "batch_header": {
    "payout_batch_id": "string",
    "batch_status": "DENIED",
    "time_created": "2019-08-24T14:15:22Z",
    "sender_batch_header": {
      "sender_batch_id": "string",
      "recipient_type": "EMAIL",
      "email_subject": "string",
      "email_message": "string"
    }
  },
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Notes:
PayPal does not process duplicate payouts. If you specify a sender_batch_id that was used in the last 30 days, the API rejects the request with an error message that shows the duplicate sender_batch_id and includes a HATEOAS link to the original 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.
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.

Header Parameters

PayPal-Request-Id?string

The server stores keys for 30 days.

Match^.*$

Length1 <= length <= 1000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sender_batch_header*

The sender-provided payout header for a payout request.

items*array<>

An array of individual payout items.

Items1 <= items <= 15000

curl -X POST "https://api-m.paypal.com/v1/payments/v1/payments/payouts" \ -H "Content-Type: application/json" \ -d '{ "sender_batch_header": {}, "items": [ { "amount": { "currency": "string", "value": "string" }, "receiver": "string" } ] }'

{ "batch_header": { "payout_batch_id": "string", "batch_status": "DENIED", "time_created": "2019-08-24T14:15:22Z", "sender_batch_header": { "sender_batch_id": "string", "recipient_type": "EMAIL", "email_subject": "string", "email_message": "string" } }, "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

{ "name": "string", "message": "string", "debug_id": "string", "information_link": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

Create batch payout

201application/json

400application/json

403application/json

500application/json

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Create batch payout

201application/json

400application/json

403application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`