canonical: https://jentic.com/apis/paypal.com/payments

# Paypal Payments

Call the Payments API to authorize payments, capture authorized payments, refund payments that have already been captured, and show payment information. Use the Payments API in conjunction with the <a href="/docs/api/orders/v2/">Orders API</a>. For more information, see the <a href="/docs/checkout/">PayPal Checkout Overview</a>. The API exposes 7 endpoints secured with oauth2 authentication.

## For AI agents

Programmatically show details for authorized payment, capture authorized payment. Covers 7 operations with oauth2 authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- Show details for authorized payment
- Capture authorized payment
- Reauthorize authorized payment
- Void authorized payment
- Refund captured payment

## Use cases

### Payments Operations

Use the Payments to perform payments operations programmatically. The API provides 7 endpoints covering core functionality including show details for authorized payment, capture authorized payment, reauthorize authorized payment.

Example prompt: Call GET /v2/payments/authorizations/{authorization_id} to show details for authorized payment

### Automated authorizations Management

Automate authorizations operations by combining multiple Payments endpoints. Agents can capture authorized payment and then reauthorize authorized payment in a single workflow.

Example prompt: Call POST /v2/payments/authorizations/{authorization_id}/capture to capture authorized payment, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Payments endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle oauth2 tokens manually.

Example prompt: Search Jentic for 'show details for authorized payment', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v2/payments/authorizations/{authorization_id} | Show details for authorized payment |
| POST | /v2/payments/authorizations/{authorization_id}/capture | Capture authorized payment |
| POST | /v2/payments/authorizations/{authorization_id}/reauthorize | Reauthorize authorized payment |
| POST | /v2/payments/authorizations/{authorization_id}/void | Void authorized payment |
| GET | /v2/payments/captures/{capture_id} | Show captured payment details |
| POST | /v2/payments/captures/{capture_id}/refund | Refund captured payment |
| GET | /v2/payments/refunds/{refund_id} | Show refund details |

## Key resources

- **authorizations** — Use the `/authorizations` resource to show details for, capture payment for, reauthorize, and void a
- **captures** — Use the `/captures` resource to show details for and refund a captured payment.
- **refunds** — Use the `/refunds` resource to show refund details.
- **assets** — Assets APIs for Checkout
- **cancel-payment** — Use the <code>/cancel-payment</code> resource to cancel an order capture or order authorization by <

## Why Jentic

- **Setup:** Wiring PayPal Payments by hand means running its OAuth 2.0 flow, refreshing Bearer tokens, and choosing the right sandbox or live host before you can capture, void, or refund authorizations. Through Jentic you install once, import Payments from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** Payments puts the authorization id in the URL path (/v2/payments/authorizations/{authorization_id}), so a rule can pin your agent to reading one authorization or capture. You choose the operations it may call, so capturing, voiding, reauthorizing, or refunding is not included unless you add them.
- **Credential handling:** Your PayPal OAuth client id and secret are stored once, encrypted, by your own Jentic One instance and injected at execution time, with token refresh handled for you. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'show details for an authorized payment' or 'refund a capture', and Jentic returns the matching Payments operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API

## FAQ

### What authentication does the Payments use?

The Payments uses OAuth 2.0 for authorization. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I show details for authorized payment with the Payments?

Yes. Use the GET /v2/payments/authorizations/{authorization_id} endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Payments?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I show details for authorized payment through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'show details for authorized payment'. Jentic returns the matching Payments operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Payments have?

The Payments exposes 7 endpoints covering authorizations, captures, refunds operations.

### Can I limit what my agent is allowed to do with the PayPal Payments API?

Yes. Because Jentic One is self-hosted, you decide which PayPal Payments operations your agent may call, so it can be pinned to read-only calls like showing details for an authorization, a capture, or a refund while capture, void, reauthorize, and refund stay off until you add them. Since the authorization id lives in the URL path (/v2/payments/authorizations/{authorization_id}), a rule can also restrict the agent to a single authorization or capture. Your PayPal OAuth client credentials are held encrypted by your own instance and injected at execution time, so the agent can only act within the operations and scope you have granted.
