PayPal
Online payment processing and money transfers
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api-m.paypal.com/ | link | — | — | — |
Actions (90)
Webhooks · 26
- Create webhookPOST /v1/notifications/webhooks
Subscribe a webhook listener to events.
documented - Create webhookPOST /v1/notifications/webhooks
Subscribe a webhook listener to events.
documented - Create webhook lookupPOST /v1/notifications/webhooks-lookup
Create a webhook lookup to bind a REST API app to an account.
documented - Create webhook lookupPOST /v1/notifications/webhooks-lookup
Create a webhook lookup to bind a REST API app to an account.
documented - Delete webhookDELETE /v1/notifications/webhooks/{webhook_id}
Delete a webhook.
documented - Delete webhookDELETE /v1/notifications/webhooks/{webhook_id}
Delete a webhook.
documented - Delete webhook lookupDELETE /v1/notifications/webhooks-lookup/{webhook_lookup_id}
Delete a webhook lookup.
documented - Delete webhook lookupDELETE /v1/notifications/webhooks-lookup/{webhook_lookup_id}
Delete a webhook lookup.
documented - List available webhook eventsGET /v1/notifications/event-types
List supported webhook events.
documented - List available webhook eventsGET /v1/notifications/event-types
List supported webhook event types.
documented - List event subscriptions for webhookGET /v1/notifications/webhooks/{webhook_id}/event-types
List event types subscribed to a webhook.
documented - List event subscriptions for webhookGET /v1/notifications/webhooks/{webhook_id}/event-types
List event types subscribed to a webhook.
documented - List webhook lookupsGET /v1/notifications/webhooks-lookup
List webhook lookups.
documented - List webhook lookupsGET /v1/notifications/webhooks-lookup
List webhook lookups.
documented - List webhook notificationsGET /v1/notifications/event-notifications
List webhook notifications for events.
documented - List webhook notificationsGET /v1/notifications/event-notifications
List webhook notifications for events.
documented - List webhooksGET /v1/notifications/webhooks
List webhooks for an app.
documented - List webhooksGET /v1/notifications/webhooks
List webhooks for an app.
documented - Show webhook detailsGET /v1/notifications/webhooks/{webhook_id}
Show details for a webhook.
documented - Show webhook detailsGET /v1/notifications/webhooks/{webhook_id}
Show details for a webhook.
documented - Show webhook lookup detailsGET /v1/notifications/webhooks-lookup/{webhook_lookup_id}
Show webhook lookup details.
documented - Show webhook lookup detailsGET /v1/notifications/webhooks-lookup/{webhook_lookup_id}
Show webhook lookup details.
documented - Update webhookPATCH /v1/notifications/webhooks/{webhook_id}
Update a webhook.
documented - Update webhookPATCH /v1/notifications/webhooks/{webhook_id}
Update a webhook.
documented - Verify webhook signaturePOST /v1/notifications/verify-webhook-signature
Verify the signature of a received webhook.
documented - Verify webhook signaturePOST /v1/notifications/verify-webhook-signature
Verify the signature of a received webhook.
documented
Invoicing · 24
- Cancel invoicePOST /v1/invoicing/invoices/{invoice_id}/cancel
Cancel an invoice.
documented - Cancel invoicePOST /v1/invoicing/invoices/{invoice_id}/cancel
Cancel an invoice.
documented - Create invoicePOST /v1/invoicing/invoices
Create a PayPal invoice.
documented - Create invoicePOST /v1/invoicing/invoices
Create a PayPal invoice.
documented - Create invoice templatePOST /v1/invoicing/templates
Create an invoice template.
documented - Create invoice templatePOST /v1/invoicing/templates
Create an invoice template.
documented - List invoice paymentsGET /v1/invoicing/invoices/{invoice_id}/payments
List payments associated with an invoice.
documented - List invoice paymentsGET /v1/invoicing/invoices/{invoice_id}/payments
List payments associated with an invoice.
documented - List invoicesGET /v1/invoicing/invoices
List PayPal invoices.
documented - List invoicesGET /v1/invoicing/invoices
List PayPal invoices.
documented - List templatesGET /v1/invoicing/templates
List invoice templates.
documented - List templatesGET /v1/invoicing/templates
List invoice templates.
documented - Record invoice paymentPOST /v1/invoicing/invoices/{invoice_id}/payments
Record a payment against an invoice.
documented - Record invoice paymentPOST /v1/invoicing/invoices/{invoice_id}/payments
Record a payment against an invoice.
documented - Send invoicePOST /v1/invoicing/invoices/{invoice_id}/send
Send an invoice to a customer.
documented - Send invoicePOST /v1/invoicing/invoices/{invoice_id}/send
Send an invoice to a customer.
documented - Show invoice detailsGET /v1/invoicing/invoices/{invoice_id}
Retrieve an invoice by ID.
documented - Show invoice detailsGET /v1/invoicing/invoices/{invoice_id}
Retrieve an invoice by ID.
documented - Show template detailsGET /v1/invoicing/templates/{template_id}
Show template details.
documented - Show template detailsGET /v1/invoicing/templates/{template_id}
Show template details.
documented - Update invoicePATCH /v1/invoicing/invoices/{invoice_id}
Update invoice fields.
documented - Update invoicePATCH /v1/invoicing/invoices/{invoice_id}
Update invoice fields.
documented - Update templatePATCH /v1/invoicing/templates/{template_id}
Update an invoice template.
documented - Update templatePATCH /v1/invoicing/templates/{template_id}
Update an invoice template.
documented
Subscriptions · 10
- Activate subscriptionPOST /v1/billing/subscriptions/{subscription_id}/activate
Activate a subscription.
documented - Cancel subscriptionPOST /v1/billing/subscriptions/{subscription_id}/cancel
Cancel a subscription.
documented - Capture subscription paymentPOST /v1/billing/subscriptions/{subscription_id}/capture
Capture funds for an active subscription.
documented - Create subscriptionPOST /v1/billing/subscriptions
Create a PayPal subscription.
documented - List subscriptionsGET /v1/billing/subscriptions
List subscriptions for the merchant.
documented - List transactions for subscriptionGET /v1/billing/subscriptions/{subscription_id}/transactions
List transactions associated with a subscription.
documented - Revise plan or quantity of subscriptionPOST /v1/billing/subscriptions/{subscription_id}/revise
Revise plan/quantity for a subscription.
documented - Show subscription detailsGET /v1/billing/subscriptions/{subscription_id}
Retrieve details for a subscription.
documented - Suspend subscriptionPOST /v1/billing/subscriptions/{subscription_id}/suspend
Suspend a subscription.
documented - Update subscriptionPATCH /v1/billing/subscriptions/{subscription_id}
Update subscription fields.
documented
Catalog Products · 8
- Activate productPOST /v1/catalogs/products/{product_id}/activate
Activate catalog product.
documented - Activate productPOST /v1/catalogs/products/{product_id}/activate
Activate catalog product.
documented - Create productPOST /v1/catalogs/products
Create a catalog product.
documented - Create productPOST /v1/catalogs/products
Create a catalog product.
documented - List productsGET /v1/catalogs/products
List catalog products.
documented - List productsGET /v1/catalogs/products
List catalog products.
documented - Update productPOST /v1/catalogs/products/{product_id}
Update catalog product.
documented - Update productPOST /v1/catalogs/products/{product_id}
Update catalog product.
documented
Orders · 8
- Authorize orderPOST /v2/checkout/orders/{order_id}/authorize
Authorize funds for an order (hold”) within the PayPal window.
documented - Capture orderPOST /v2/checkout/orders/{order_id}/capture
Capture funds for an order after buyer approval.
documented - Confirm payment sourcePOST /v2/checkout/orders/{order_id}/confirm-payment-source
Confirm the payer's selected payment source for an order.
documented - Create orderPOST /v2/checkout/orders
Create an order for PayPal Checkout.
documented - Order update callbackPOST /v2/checkout/orders/order-update-callback
Receive updated order information via callback from PayPal.
documented - Show order detailsGET /v2/checkout/orders/{order_id}
Retrieve details for a specific order.
documented - Track shipmentPOST /v2/checkout/orders/{order_id}/track
Submit shipment/tracking information for an order.
documented - Update orderPATCH /v2/checkout/orders/{order_id}
Modify fields of an order in CREATED or APPROVED state.
documented
Payments · 8
- Capture authorized paymentPOST /v2/payments/authorizations/{authorization_id}/capture
Capture funds for an authorized payment.
documented - Create capturePOST /v2/payments/captures
Create a payment capture (for a purchase that is already authorized or a direct capture).
documented - Reauthorize authorized paymentPOST /v2/payments/authorizations/{authorization_id}/reauthorize
Reauthorize an existing authorized payment.
documented - Refund authorized paymentPOST /v2/payments/authorizations/{authorization_id}/refund
Refund an authorized payment.
documented - Refund captured paymentPOST /v2/payments/captures/{capture_id}/refund
Refund a captured payment.
documented - Show authorized payment detailsGET /v2/payments/authorizations/{authorization_id}
Retrieve details for an authorized payment.
documented - Show captured payment detailsGET /v2/payments/captures/{capture_id}
Retrieve details for a captured payment.
documented - Void authorized paymentPOST /v2/payments/authorizations/{authorization_id}/void
Void an authorization (if not yet captured).
documented
Payouts · 4
- Cancel payout itemPOST /v1/payments/payouts-item/{payout_item_id}/cancel
Cancel a payout item.
documented - Create payout batchPOST /v1/payments/payouts
Create a batch payout for multiple recipients.
documented - Show payout batch detailsGET /v1/payments/payouts/{payout_batch_id}
Retrieve details for a payout batch.
documented - Show payout item detailsGET /v1/payments/payouts-item/{payout_item_id}
Retrieve details for a single payout item.
documented