PayPal

Usage Instructions

Integrates PayPal into your workflow. Create and capture orders, manage billing subscriptions, create invoices, and handle payment lifecycle events. Supports sandbox mode for testing.

Tools

`paypal_create_order`

Create a PayPal order for a payment

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`intent`	string	Yes	Payment intent: CAPTURE or AUTHORIZE
`amount`	number	Yes	Payment amount
`currencyCode`	string	Yes	ISO currency code (e.g. USD, EUR)
`description`	string	No	Order description
`returnUrl`	string	No	URL to redirect after approval
`cancelUrl`	string	No	URL to redirect on cancellation

Output

Parameter	Type	Description
`order`	json	The created PayPal order object
`metadata`	json	Order metadata: id, status, intent

`paypal_capture_order`

Capture payment for an approved PayPal order

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`orderId`	string	Yes	The PayPal order ID to capture

Output

Parameter	Type	Description
`order`	json	The captured PayPal order object
`metadata`	json	Order metadata: id, status

`paypal_get_order`

Retrieve details of a PayPal order by ID

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`orderId`	string	Yes	The PayPal order ID to retrieve

Output

Parameter	Type	Description
`order`	json	The PayPal order object
`metadata`	json	Order metadata: id, status, intent

`paypal_create_subscription`

Create a PayPal subscription for a billing plan

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`planId`	string	Yes	The PayPal billing plan ID
`subscriberGivenName`	string	No	Subscriber first name
`subscriberSurname`	string	No	Subscriber last name
`subscriberEmail`	string	No	Subscriber email address
`returnUrl`	string	No	URL to redirect after approval
`cancelUrl`	string	No	URL to redirect on cancellation

Output

Parameter	Type	Description
`subscription`	json	The created PayPal subscription object
`metadata`	json	Subscription metadata: id, status, plan_id

`paypal_get_subscription`

Retrieve details of a PayPal subscription by ID

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`subscriptionId`	string	Yes	The PayPal subscription ID

Output

Parameter	Type	Description
`subscription`	json	The PayPal subscription object
`metadata`	json	Subscription metadata: id, status, plan_id

`paypal_cancel_subscription`

Cancel an active PayPal subscription

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`subscriptionId`	string	Yes	The PayPal subscription ID to cancel
`reason`	string	No	Reason for cancellation

Output

Parameter	Type	Description
`metadata`	json	Cancellation result metadata

`paypal_create_invoice`

Create a PayPal invoice to send to a customer

Input

Parameter	Type	Required	Description
`sandbox`	boolean	No	Use PayPal sandbox environment for testing
`currencyCode`	string	Yes	ISO currency code (e.g. USD, EUR)
`invoiceNumber`	string	No	Custom invoice number
`note`	string	No	Note to include on the invoice
`payerEmail`	string	No	Email address of the payer
`items`	json	No	Invoice line items as JSON array: [{name, quantity, unitAmount, description?}]

Output

Parameter	Type	Description
`invoice`	json	The created PayPal invoice object
`metadata`	json	Invoice metadata: id, status

PayPal

On this page