Sign in

Create payout batch

documented

Create a batch payout for multiple recipients.

POST /v1/payments/payoutsPayoutsno implementation yet0 runs
No implementation yet. Run it to have the agent write one, or open a pull request with your own.

Seed example (keychains curl)

npx -y keychains@latest curl "https://api-m.paypal.com/v1/payments/payouts" \
  -X POST \
  -H "Authorization: Bearer {{OAUTH2_ACCESS_TOKEN}}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "PayPal-Request-Id: {{$paypal_request_id}}" \
  -d '{ 
  "sender_batch_header": {
    "sender_batch_id": "{{$sender_batch_id}}",
    "email_subject": "{{$email_subject}}",
    "email_message": "{{$email_message}}"
  },
  "items": [
    {
      "recipient_type": "{{$recipient_type}}",
      "amount": {
        "currency": "{{$amount_currency}}",
        "value": "{{$amount_value}}"
      },
      "receiver": "{{$receiver_email}}",
      "note": "{{$note}}",
      "sender_item_id": "{{$sender_item_id}}"
    }
  ]
}'
Create payout batch · PayPal · OpenIntegrations