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

Use the `/captures` resource to show details for and refund a captured payment.

Documentation Provider Profile APIs.io OpenAPI GitHub

PayPal Captures 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 Capture. 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 47 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 47 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 Captures 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.

Captures 2

Use the /captures resource to show details for and refund a captured payment.

GET
/v2/payments/captures/{capture_id}
Paypal Show captured payment details
captures.get 1 param → 200401403404500default
POST
/v2/payments/captures/{capture_id}/refund
Paypal Refund captured payment
captures.refund 4 params body → 201400401403404409422500

Schemas 47

The contract defines 47 schemas that model the data the API accepts and returns. The most detailed are seller_receivable_breakdown (7 properties), refund_request (5 properties), error_400 (5 properties), error_401 (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
payment_instruction-2
object
Any additional payments instructions during refund payment processing. This object is only applicable to merchants that have been enabled for PayPal Commerce P…
1 property
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
net_amount_breakdown_item
object
The net amount. Returned when the currency of the refund is different from the currency of the PayPal account where the merchant holds their funds.
3 properties
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
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.
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
refund_request
object
Refunds a captured payment, by ID. For a full refund, include an empty request body. For a partial refund, include an amount object in the request body.
5 properties
refund
object
The refund information.
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.
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
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
captures.refund-422
object
1 property
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
error_401
object
Authentication failed due to missing Authorization header, or invalid authentication credentials.
5 properties
refund_status_details
object
The details of the refund status.
1 property
captures.refund-400
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
refund_status
object
The refund status.
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…
activity_timestamps
object
The date and time stamps that are common to authorized payment, captured payment, and refund transactions.
2 properties
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
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…
capture_status
object
The status of a captured payment.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

paypal-captures-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 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
PayPal Partner-Referrals API
AE Profile APIs.io
#Capture
← Back to P APIs
API Details
ID
paypal:paypal-captures-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-captures-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/paypal-captures-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 Captures 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.