How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
PayPal

PayPal Payouts API

Use the `/payouts` resource to create a batch payout, update the status for a batch payout, show the status of a batch payout with the transaction status and other data for individual payout items, and request approval for a batch payout.

Documentation Provider Profile APIs.io OpenAPI GitHub

PayPal Payouts API is one of 37 APIs that PayPal publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Payouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 26 schemas. It is described by OpenAPI 3.0.3, at version 1.6.

Requests are made against 2 base URLs: https://api-m.sandbox.paypal.com, https://api-m.paypal.com.

2 operations 2 paths 26 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.6
Servers
https://api-m.sandbox.paypal.com
https://api-m.paypal.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

PayPal Payouts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (Oauth2) using the clientCredentials flow, exposing 1 scope.

  • Oauth2 — Oauth 2.0 authentication

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Payouts 2

Use the /payouts resource to create a batch payout, update the status for a batch payout, show the status of a batch payout with the transaction status and other data for individu…

POST
/v1/payments/payouts
Paypal Create batch payout
payouts.post 1 param body → 201400403500default
GET
/v1/payments/payouts/{id}
Paypal Show payout batch details
payouts.get 5 params → 200404500default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are payout_batch_items (11 properties), payout_item (10 properties), payout_batch_header (9 properties), payout_item_detail (8 properties). Each schema is shown below with its type and property counts.

purpose_enum
string
The purpose of the transaction.
language
string
The [language tag](https://tools.ietf.org/html/bcp47section-2) for the language in which to localize the error-related strings, such as messages, issues, and s…
payout_item_detail
object
The details for a sender-created payout to a single recipient.
8 properties 2 required
currency
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties 2 required
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties 2 required
payout_batch_items
object
The payout item status and other details.
11 properties 3 required
payout_sender_batch_header
object
The sender-provided header for a payout request.
4 properties
application_context
object
Metadata for Venmo transactions.
3 properties
payout_batch
object
The PayPal-generated batch status.
5 properties
batch_enum
string
The payouts status.
name
object
The name of the party.
7 properties
phone
object
The phone number in its canonical international [E.164 numbering plan format](https://www.itu.int/rec/T-REC-E.164/en).
3 properties 2 required
payout
object
The create payout response.
2 properties
payout_batch_header
object
The payout header that is returned in response to a payout header request. Shows details for an entire payout request.
9 properties 3 required
recipient_wallet_enum
string
The wallet where the recipient receives the payout. Payouts to Venmo recipients require a 'note' string and a US mobile phone number.
sender_batch_header
object
The sender-provided payout header for a payout request.
5 properties
payout_currency_conversion
object
The currency conversion resource.
3 properties
recipient_enum
string
The ID type that identifies the payment receiver.
alternate_notification_method
object
Captures additional notification modes to reach out to the receiver regarding this payment.
1 property
funding_source
string
Identifies a funding source type.
transaction_enum
string
The item transaction status. Note: For POST/v1/payments/payouts-item/{payoutitemid}/cancel , the only possible transactionstatus value is RETURNED .
payout_header
object
The payout header that is returned in response to a payout header request. Shows details for an entire payout request.
4 properties 3 required
error
object
The error details.
6 properties 3 required
create_payout_request
object
The create payout request.
2 properties 2 required
error_details-2
object
The error details. Required for client-side 4XX errors.
5 properties 1 required
payout_item
object
The sender-created payout to a recipient.
10 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-payouts-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

PayPal Activate API
AE Profile APIs.io
PayPal Authorizations API
AE Profile APIs.io
PayPal Balances API
AE Profile APIs.io
PayPal Billing API
AE Profile APIs.io
PayPal Cancel API
AE Profile APIs.io
PayPal Capture API
AE Profile APIs.io
PayPal Captures API
AE Profile APIs.io
PayPal Deactivate API
AE Profile APIs.io
PayPal Disputes-Actions API
AE Profile APIs.io
PayPal Disputes API
AE Profile APIs.io
PayPal Invoices API
AE Profile APIs.io
PayPal Orders API
AE Profile APIs.io
#Payouts
← Back to P APIs
API Details
ID
paypal:paypal-payouts-api
Server
https://api-m.sandbox.paypal.com
Docs
https://developer.paypal.com/docs/api/subscriptions/v1/
Provider
PayPal
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=paypal-payouts-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paypal-payouts-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of PayPal Payouts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.