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

PayPal Payouts-Item API

Use the `/payouts-item` resource to show payout item details and cancel an unclaimed payout item.

PayPal Payouts-Item 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-Item. 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 12 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 12 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-Item 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-Item 2

Use the /payouts-item resource to show payout item details and cancel an unclaimed payout item.

GET
/v1/payments/payouts-item/{payout_item_id}
Paypal Show payout item details
payouts-item.get 1 param → 200404500default
POST
/v1/payments/payouts-item/{payout_item_id}/cancel
Paypal Cancel unclaimed payout item
payouts-item.cancel 1 param → 200400404500default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are payout_item-2 (12 properties), payout_item_detail (8 properties), name (7 properties), error (6 properties). Each schema is shown below with its type and property counts.

payout_item-2
object
The payout item status and other details. A payoutitemid helps you identify denied payments. If a payment is denied, you can use the payoutitemid to identify t…
12 properties 3 required
purpose_enum
string
The purpose of the transaction.
name
object
The name of the party.
7 properties
transaction_enum
string
The item transaction status. Note: For POST/v1/payments/payouts-item/{payoutitemid}/cancel , the only possible transactionstatus value is RETURNED .
error
object
The error details.
6 properties 3 required
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
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.
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties 2 required
payout_currency_conversion
object
The currency conversion resource.
3 properties
recipient_enum
string
The ID type that identifies the payment receiver.
error_details-2
object
The error details. Required for client-side 4XX errors.
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-payouts-item-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

PayPal Activate API
PayPal Authorizations API
PayPal Balances API
PayPal Billing API
PayPal Cancel API
PayPal Capture API
PayPal Captures API
PayPal Deactivate API
PayPal Disputes-Actions API
PayPal Disputes API
PayPal Invoices API
PayPal Orders API
Where this information came from

This is an independent, third-party profile of PayPal Payouts-Item 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.