Orders

Name: Orders API
Brand: Orders
Availability: InStock

✓ Official Vendor SpecPaymentsPayment Processingoauth29 EndpointsREST

For Agents

Create and capture PayPal payment orders, authorize funds, and attach shipping trackers. Supports PayPal wallet, cards, and local payment methods with buyer and seller protection.

Quickstart

Get started with Orders in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a PayPal checkout order"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Orders API.

Create payment orders with multiple purchase units, shipping details, and payment source preferences

Authorize funds on an order and capture them separately for delayed fulfillment workflows

Confirm the payment source on an order to trigger buyer authentication (3D Secure, PayPal login)

Attach carrier tracking information to captured orders for automatic seller protection

GET STARTED

Start building with Orders API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Orders API for, with concrete tasks.

★ AI Agent Order Processing

AI agents create and capture PayPal orders through Jentic without storing OAuth client secrets directly. An agent searches for 'create a PayPal order' via Jentic, receives the order creation schema with purchase unit structure, and executes the call with credential isolation. The agent can then authorize and capture in subsequent calls, all without managing token refresh logic.

Search Jentic for 'create a PayPal order', load the schema, create an order for $75.00 USD with intent CAPTURE, then execute the capture call

E-Commerce Checkout with PayPal

Accept payments from 400+ million PayPal wallet users alongside guest card payments through a single order creation call. The Orders API handles buyer redirection to PayPal for approval, supports both immediate capture (intent=CAPTURE) and delayed authorization (intent=AUTHORIZE), and calculates seller protection eligibility based on shipping address and item category.

Create an order with intent CAPTURE for $50.00 USD including item details and shipping address, then retrieve the order to confirm status is APPROVED

Authorization and Delayed Capture

Place a hold on buyer funds at checkout and capture later when goods ship, with a 29-day authorization window for PayPal wallet and 3-day window for cards. The authorize-then-capture flow is ideal for physical goods fulfillment where the exact shipping cost may change. Partial captures are supported, allowing agents to capture less than the authorized amount.

Create an order with intent AUTHORIZE for $120.00 USD, authorize it, then capture $115.00 as a partial capture after adjusting for actual shipping cost

Shipment Tracking and Seller Protection

Attach carrier tracking information to captured orders to qualify for PayPal Seller Protection on eligible transactions. The tracking endpoint accepts carrier name, tracking number, and notify_buyer flag. Orders with valid tracking automatically transition to seller-protected status, reducing chargeback liability and dispute losses.

Add a UPS tracking number to a captured order using POST /v2/checkout/orders/{id}/track with carrier 'UPS' and notify_buyer set to true

Key Endpoints

9 endpoints — create, authorize, and capture payment orders across paypal wallets, cards, and local payment methods through a unified checkout flow.

METHOD

PATH

DESCRIPTION

POST

/v2/checkout/orders

Create a new payment order

GET

/v2/checkout/orders/{id}

Retrieve order details by ID

POST

/v2/checkout/orders/{id}/authorize

Authorize payment on an order

POST

/v2/checkout/orders/{id}/capture

Capture payment on an authorized order

POST

/v2/checkout/orders/{id}/confirm-payment-source

Confirm payment source for buyer auth

POST

/v2/checkout/orders/{id}/track

Add tracking info to a captured order

POST

/v2/checkout/orders

Create a new payment order

GET

/v2/checkout/orders/{id}

Retrieve order details by ID

POST

/v2/checkout/orders/{id}/authorize

Authorize payment on an order

POST

/v2/checkout/orders/{id}/capture

Capture payment on an authorized order

POST

/v2/checkout/orders/{id}/confirm-payment-source

Confirm payment source for buyer auth

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

PayPal OAuth client_id and client_secret are stored encrypted in the Jentic MAXsystem vault. Token refresh is automatic — agents receive valid Bearer tokens without ever seeing the underlying credentials.

Intent-based discovery

Agents search by intent (e.g., 'create a PayPal order' or 'capture payment') and Jentic returns the matching Orders API operation with its full request schema, so the agent constructs the correct purchase_units payload without reading PayPal docs.

Time to first call

Direct PayPal integration: 2-4 days for OAuth setup, order flow, webhook verification, and error handling. Through Jentic: under 1 hour — search, load schema, execute with automatic token management.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Stripe API

Developer-centric payment platform with broader subscription and marketplace features

Choose Stripe when you need advanced subscription billing, metered usage, or a multi-party Connect marketplace rather than simple order-based checkout

Complementary

PayPal Payments API

Lower-level payment details and refund operations for captured PayPal orders

Use the Payments API when you need to issue refunds on captured orders or retrieve detailed payment-level information beyond order status

Complementary

PayPal Subscriptions API

Recurring billing and subscription management for PayPal payments

Use the Subscriptions API when the use case requires recurring billing rather than one-time order payments

Alternative

Adyen Checkout API

Enterprise checkout with broader local payment method coverage in Europe and APAC

Choose Adyen when processing enterprise-volume transactions requiring local payment methods across European and Asia-Pacific markets

FAQs

Specific to using Orders API through Jentic.

What authentication does the PayPal Orders API use?

The PayPal Orders API uses OAuth 2.0 with client credentials flow. You exchange your client_id and secret for a Bearer access token via POST /v1/oauth2/token, then pass the token in the Authorization header. Tokens expire after ~9 hours. Through Jentic, your PayPal OAuth credentials are stored in the MAXsystem vault and token refresh is handled automatically — agents never see the client secret.

Can I authorize and capture payments separately with the PayPal Orders API?

Yes. Create an order with intent=AUTHORIZE, then call POST /v2/checkout/orders/{id}/authorize to place a hold on funds. When ready to collect, call POST /v2/checkout/orders/{id}/capture. The authorization window is 29 days for PayPal wallet payments and 3 days for card payments. Partial captures below the authorized amount are supported.

What are the rate limits for the PayPal Orders API?

PayPal applies rate limits based on your account tier and endpoint. Standard accounts get approximately 30 requests per second for order creation and 50 for retrieval. If you exceed limits, the API returns HTTP 429. PayPal recommends exponential backoff with a maximum of 3 retries.

How do I create a PayPal order through Jentic?

Search Jentic for 'create a PayPal order' to find the POST /v2/checkout/orders operation. The schema shows required fields: intent (CAPTURE or AUTHORIZE) and purchase_units array with amount (currency_code + value). Jentic handles OAuth token management automatically. Sign up at https://app.jentic.com/sign-up to get started.

Does the PayPal Orders API support multiple currencies?

Yes. The Orders API supports over 100 currencies specified in the purchase_units[].amount.currency_code field using ISO 4217 codes (e.g., USD, EUR, GBP). Each purchase unit can have a different currency. Settlement currency depends on your PayPal account configuration.

How does seller protection work with the PayPal Orders API?

Seller protection eligibility is determined automatically based on order attributes. To qualify, orders must include a shipping address and be captured (not just authorized). Adding carrier tracking via POST /v2/checkout/orders/{id}/track strengthens protection. The order response includes a seller_protection object showing eligibility status and dispute categories covered.