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

Use the `/balances` resource to list balances.

PayPal Balances 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 Balances. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 19 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.

1 operations 1 paths 19 schemas 1 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 Balances 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 1

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

Balances 1

Use the /balances resource to list balances.

GET
/v1/reporting/balances
Paypal List all balances
balances.get 2 params → 200400403500default

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are error_404 (5 properties), error_400 (5 properties), balance_detail (5 properties), error_415 (5 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
account_id
string
The PayPal payer ID, which is a masked version of the PayPal account number intended for use with third parties. The account number is reversibly encrypted and…
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
error_details
object
The error details. Required for client-side 4XX errors.
5 properties 1 required
error_link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties 2 required
error_default
The default error response.
balance_detail
object
The Balance information.
5 properties 2 required
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
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
balances_response
object
The balances response information.
4 properties
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
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…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-balances-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

PayPal Activate API
PayPal Authorizations 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
PayPal Partner-Referrals API
Where this information came from

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