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 Transactions API

The Transactions API from PayPal — 2 operation(s) for transactions.

PayPal Transactions 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 Transaction. 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 45 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 45 schemas 2 GET

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 Transactions 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 — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Transactions 2
GET
/v1/billing/subscriptions/{id}/transactions
List transactions for subscription
subscriptions.transactions 3 params → 200400401403404500default
GET
/v1/reporting/transactions
Paypal List transactions
search.get 14 params → 200default

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are transaction_info (34 properties), item_detail (19 properties), search_response (9 properties), payer_info (8 properties). Each schema is shown below with its type and property counts.

error_404
object
The server has not found anything matching the request URI. This either means that the URI is incorrect or the resource is not available.
5 properties
error_409
object
The server has detected a conflict while processing this request.
5 properties
transactions_list
object
The list transactions for a subscription request details.
4 properties
403
object
1 property
link_description
object
The request-related [HATEOAS link](/docs/api/reference/api-responses/hateoas-links) information.
3 properties 2 required
error_403
object
The client is not authorized to access this resource, although it may have valid credentials.
5 properties
error_422
object
The requested action cannot be performed and may require interaction with APIs or processes outside of the current request. This is distinct from a 500 respons…
5 properties
capture_status
object
The status of a captured payment.
2 properties
error_details
object
The error details. Required for client-side 4XX errors.
5 properties 1 required
name
object
The name of the party.
7 properties
error_link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties 2 required
transaction
object
The transaction details.
3 required
error_default
The default error response.
error_location
string
The location of the field that caused the error. Value is body, path, or query.
money
object
The currency and amount for a financial transaction, such as a balance or payment due.
2 properties 2 required
capture_status_details
object
The details of the captured payment status.
1 property
amount_with_breakdown
object
The breakdown details for the amount. Includes the gross, tax, fee, and shipping amounts.
6 properties 1 required
401
object
1 property
error_503
object
The server is temporarily unable to handle the request, for example, because of planned maintenance or downtime.
4 properties
error_400
object
Request is not well-formed, syntactically incorrect, or violates schema.
5 properties
currency_code
string
The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/) that identifies the currency.
error_401
object
Authentication failed due to missing Authorization header, or invalid authentication credentials.
5 properties
404
object
1 property
error_415
object
The server does not support the request payload's media type.
5 properties
error_500
object
This is either a system or application error, and generally indicates that although the client appeared to provide a correct request, something unexpected has…
4 properties
email_address
string
The internationalized email address. Note: Up to 64 characters are allowed before and 255 characters are allowed after the @ sign. However, the generally accep…
date_time
string
The date and time, in [Internet date and time format](https://tools.ietf.org/html/rfc3339section-5.6). Seconds are required while fractional seconds are option…
subscriptions.transactions-400
object
1 property
incentive_detail
object
The incentive details.
4 properties
transaction_info
object
The transaction information.
34 properties
payer_info
object
The payer information.
8 properties
item_detail_tax_amount
object
The tax levied by a government on the purchase of goods or services.
1 property
item_detail
object
The item details.
19 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
cart_info
object
The cart information.
3 properties
transaction_detail
object
The transaction details.
7 properties
shipping_info
object
The shipping information.
4 properties
address
object
A simple postal address with coarse-grained fields. Do not use for an international address. Use for backward compatibility only. Does not contain phone.
6 properties 3 required
store_info
object
The store information.
2 properties
country_code
string
The [two-character ISO 3166-1 code](/docs/integration/direct/rest/country-codes/) that identifies the country or region. Note: The country code for Great Brita…
auction_info
object
The auction information.
4 properties
search_response
object
The search response information.
9 properties
checkout_option
object
A checkout option as a name-and-value pair.
2 properties
percentage
string
The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
incentive_info
object
The incentive details.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-transactions-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 Transactions 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.