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

Use the `/authorizations` resource to show details for, capture payment for, reauthorize, and void authorized payments.

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

This API exposes 4 operations across 4 paths, and defines 52 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.

4 operations 4 paths 52 schemas 1 GET3 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 Authorizations 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 4

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

Authorizations 4

Use the /authorizations resource to show details for, capture payment for, reauthorize, and void authorized payments.

GET
/v2/payments/authorizations/{authorization_id}
Paypal Show details for authorized payment
authorizations.get 1 param → 200401403404500default
POST
/v2/payments/authorizations/{authorization_id}/capture
Paypal Capture authorized payment
authorizations.capture 3 params body → 201400401403404422500default
POST
/v2/payments/authorizations/{authorization_id}/reauthorize
Paypal Reauthorize authorized payment
authorizations.reauthorize 3 params body → 201400401403404422500default
POST
/v2/payments/authorizations/{authorization_id}/void
Paypal Void authorized payment
authorizations.void 3 params → 200204400401403404409422

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are seller_receivable_breakdown (7 properties), error_409 (5 properties), error_403 (5 properties), error_400 (5 properties). Each schema is shown below with its type and property counts.

reauthorize_request
object
Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor per…
1 property
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
authorization-2
object
The authorized payment transaction.
disbursement_mode
string
The funds that are held on behalf of the merchant.
error_409
object
The server has detected a conflict while processing this request.
5 properties
supplementary_data
object
The supplementary data.
1 property
authorization_status_details
object
The details of the authorized payment status.
1 property
403
object
1 property
account_id
string
The account identifier for a PayPal account.
link_description
object
The request-related [HATEOAS link](/api/rest/responses/hateoas-links) information.
3 properties 2 required
payment_instruction
object
Any additional payment instructions to be consider during payment processing. This processing instruction is applicable for Capturing an order or Authorizing a…
4 properties
authorizations.reauthorize-400
object
1 property
authorization_status
object
The status fields for an authorized payment.
2 properties
error_403
object
The client is not authorized to access this resource, although it may have valid credentials.
5 properties
capture
object
A captured payment.
authorization
object
The authorized payment transaction.
card_brand
string
The card network or brand. Applies to credit, debit, gift, and payment cards.
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
exchange_rate
object
The exchange rate that determines the amount to convert from one currency to another currency.
3 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
processor_response
object
The processor response information for payment requests, such as direct credit card transactions.
4 properties
related_ids
object
Identifiers related to a specific resource.
3 properties
error_default
The default error response.
400
object
1 property
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
401
object
1 property
422
object
1 property
409
object
1 property
payee_base
object
The details for the merchant who receives the funds and fulfills the order. The merchant is also known as the payee.
2 properties
seller_receivable_breakdown
object
The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.
7 properties 1 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](/api/rest/reference/currency-codes/) that identifies the currency.
network_transaction_reference
object
Reference values used by the card network to identify a transaction.
4 properties 1 required
platform_fee
object
The platform or partner fee, commission, or brokerage fee that is associated with the transaction. Not a separate or isolated transaction leg from the external…
2 properties 1 required
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…
error_401
object
Authentication failed due to missing Authorization header, or invalid authentication credentials.
5 properties
authorizations.reauthorize-422
object
1 property
seller_protection
object
The level of protection offered as defined by [PayPal Seller Protection for Merchants](https://www.paypal.com/us/webapps/mpp/security/seller-protection).
2 properties
404
object
1 property
error_415
object
The server does not support the request payload's media type.
5 properties
email
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…
capture-2
object
A captured payment.
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
activity_timestamps
object
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.
2 properties
capture_request
object
Captures either a portion or the full authorized amount of an authorized payment.
supplementary_purchase_data
object
The capture identification-related fields. Includes the invoice ID, custom ID, note to payer, and soft descriptor.
2 properties
authorizations.void-422
object
1 property
capture_status
object
The status of a captured payment.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-authorizations-api-openapi.yml Raw ↑

Other APIs PayPal publishes across the network.

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

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