Paypal Payments Payouts Batch V1
PayPal Payments Payouts Batch is a PayPal API for sending payments in bulk to multiple recipients.
- Base URL:
https://api-m.sandbox.paypal.com - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
/v1/oauth2/tokenusing yourclientId/clientSecret, then calls the API.
Operations
payouts_get— GET /v1/payments/payouts/{id} — Show payout batch detailspayouts_item_get— GET /v1/payments/payouts-item/{payout_item_id} — Show payout item detailspayouts_post— POST /v1/payments/payouts — Create batch payoutpayouts_item_cancel— POST /v1/payments/payouts-item/{payout_item_id}/cancel — Cancel unclaimed payout item
Inputs
clientId/clientSecret— your paypal-payments-payouts-batch-v1 OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: payouts_get
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for paypal-payments-payouts-batch-v1. |
clientSecret |
string | yes | — | OAuth client secret for paypal-payments-payouts-batch-v1. |
operation |
string | yes | — | One of: payouts_get, payouts_item_get, payouts_post, payouts_item_cancel |
scope |
string | no | https://uri.paypal.com/payments/payouts https://uri.paypal.com/services/payments/payouts-item/reverse https://uri.paypal.com/services/payments/payout-applications/status https://uri.paypal.com/services/payments/payout-applications/update-status |
OAuth scopes (space-separated); default from the spec. |
id |
string | no | — | Path parameter id (required by some operations). |
payout_item_id |
string | no | — | Path parameter payout_item_id (required by some operations). |
body |
string | no | — | Request body as a JSON object string (for create/update operations). |
query |
string | no | — | Query-string parameters as a JSON object string, e.g. {"limit": 50}. Parsed and url-encoded onto the request. |