Skip to main content
Paypal logo
  • Category: payment processing
  • Auth: S2S_OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 78
  • Triggers: 0
  • Slug: PAYPAL
  • Version: 20261101_00

Tools

Slug: PAYPAL_ACTIVATE_PLANActivates a PayPal billing plan to make it available for subscription signups. The tool returns a success flag and plan ID after a successful request.

Input Parameters

string
required
The ID of the billing plan to activate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_ADD_BATCH_TRACKERSAdd tracking information for multiple PayPal transactions in a single request. Use this action when you need to add or update tracking information for one or more PayPal transactions. This is particularly useful for batch processing shipping updates when fulfilling multiple orders. The action supports up to 20 trackers per request. The response includes tracker identifiers for successfully processed entries and any errors for entries that failed validation or processing. Required fields: - trackers: An array containing at least one tracker object Each tracker requires: - transaction_id: The PayPal transaction ID - status: The shipment status (CLICKED, SHIPPED, DELIVERED, etc.)

Input Parameters

array
required
An array of tracking information for one or more shipments. Maximum 20 trackers per request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_AUTHORIZE_ORDERAuthorizes payment for an approved PayPal order for later capture. The response may be minimal; request a full representation if authorization details are needed.

Input Parameters

string
The preferred server response upon successful completion of the request. Use ‘return=minimal’ for minimal response or ‘return=representation’ for full response.
string
required
The ID of the order to authorize.
object
Payment source for the order authorization.
string
The server stores keys for 72 hours. Used to enforce idempotency for multiple authorizations on the same order.
string
Deprecated. Caller-supplied PayPal-Auth-Assertion headers are not supported.
string
Optional. Verifies that the payment originates from a valid, user-consented device and application.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CANCEL_INVOICECancels a sent PayPal invoice and optionally notifies relevant parties. Use this action when you need to cancel an invoice that has already been sent to a payer. The action allows you to provide a cancellation reason and control who receives email notifications about the cancellation (recipient, invoicer, and additional CC recipients). This action is irreversible — once canceled, the invoice cannot be reinstated and the payer will no longer be able to pay it through PayPal. Note: Only invoices in SENT or SCHEDULED status can be canceled. Draft invoices should be deleted instead, and paid invoices must be refunded.

Input Parameters

string
A note about the cancellation reason. Maximum 1000 characters.
string
The subject of the email notification sent about the cancellation. Maximum 150 characters.
string
required
The ID of the invoice to cancel.
boolean
Whether to send the cancellation notification email to the merchant (invoicer). Default is true.
boolean
Whether to send the cancellation notification email to the recipient (payer). Default is true.
array
An array of CC email addresses to which the cancellation notification is sent. Maximum 100 email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CANCEL_REMINDERSCancels the automatic payment reminders for a PayPal invoice. Use this action when you need to stop the automatic reminder emails from being sent to the payer for a particular invoice. This is useful when the invoice has been paid, is no longer relevant, or when you want to handle payment follow-ups manually. Note: This action only cancels future scheduled reminders. It does not affect reminders that have already been sent.

Input Parameters

string
required
The ID of the invoice for which to cancel the reminders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CAPTURE_SUBSCRIPTION_PAYMENTCaptures an outstanding balance on a PayPal subscription. Provide the subscription ID, amount, outstanding-balance capture type and a note explaining the charge.

Input Parameters

string
required
The ID of the subscription.
string
required
The reason or note for the subscription charge.
object
required
The charge amount from the subscriber.
string ("OUTSTANDING_BALANCE")
required
The type of capture. Currently only OUTSTANDING_BALANCE is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CHARGE_PAYMENT_METHODCharges a payment method using the Braintree GraphQL API, creating a transaction and beginning settlement. Provide a tokenized payment method ID and transaction details; requests use the production Braintree endpoint.

Input Parameters

object
required
The input containing the payment method ID and transaction details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_INVOICECreates a PayPal draft invoice. Use this action when you need to create a new invoice that can be customized and sent to recipients. The invoice is created in DRAFT status and can be modified before being sent. Required fields: - detail.currency_code: The three-character currency code (e.g., “USD”) Optional fields: - detail.invoice_number: Custom invoice number - detail.invoice_date: Date when invoice was issued - detail.note: Note to the payer - detail.terms_and_conditions: Payment terms - items: List of line items (name, quantity, unit_amount required) - primary_recipients: Billing information for recipients - amount: Invoice amount breakdown The created invoice can be modified, scheduled, or sent using other PayPal invoicing actions.

Input Parameters

array
An array of invoice line items. Each item includes name, quantity, and unit amount. Maximum 100 items.
object
The invoice amount summary including breakdown.
object
required
The details of the invoice. Includes invoice number, date, currency code, and payment terms. The currency_code field is required.
object
The invoicer business information that appears on the invoice.
object
The currency and amount for a financial transaction.
object
Configuration for the invoice template.
array
The billing and shipping information for the recipients. Includes name, email, address, and phone.
array
An array of CC email addresses to which notifications are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_PAYMENTCreates a PayPal payment using the v1 Payments API. Use this action when you need to create a payment to be processed through PayPal. This action is for the deprecated v1 API - consider using the v2 Payments API for new integrations. The action returns the created payment object including approval URLs for the buyer to complete the payment. After the buyer approves the payment, execute it to complete the transaction. Note: This is an irreversible operation once the payment is executed.

Input Parameters

object
required
The payer information including payment method.
string ("sale" | "authorize" | "order")
required
The payment intent. Must be ‘sale’ for immediate payment, ‘authorize’ for payment authorization, or ‘order’ for creating an order.
array
required
List of transaction details including amount and description.
object
Redirect URLs for the payment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_PAYMENTS_BILLING_PLANSCreates a PayPal billing plan using the legacy payments API (POST /v1/payments/billing-plans). Use this action when setting up a new billing plan for PayPal billing agreements, including plans with trial periods, regular billing cycles, and custom payment preferences. After creation, the plan must be activated via the activate_plan action before it can be used in billing agreements. Note: This uses the legacy /v1/payments/billing-plans endpoint. For newer integrations, consider using the /v1/billing/plans endpoint instead.

Input Parameters

string
required
The billing plan name. Must be 1-256 characters.
string ("FIXED" | "INFINITE")
required
The type of the billing plan. One of: FIXED, INFINITE.
array
An array of terms for the billing plan.
string
required
The detailed description of the billing plan. Must be 1-127 characters.
array
required
An array of payment definitions for the billing plan. Includes trial and regular payment configurations.
object
required
The merchant preferences for the billing plan, including setup fee, return URL, and cancel URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_PLANCreates a PayPal billing plan for subscription billing. Use this action when setting up new subscription pricing plans in PayPal, including plans with trial periods, regular billing cycles, and custom payment preferences. The plan must be associated with an existing product. The action returns the created plan object with its unique ID and status.

Input Parameters

string
required
The plan name. Must be 1-127 characters.
object
Tax configuration for the plan.
string ("CREATED" | "INACTIVE" | "ACTIVE")
Initial state of the plan.
string
required
The ID of the product created through the Catalog Products API. PayPal-generated IDs are 22 characters (e.g. PROD-…) but custom IDs may be 6-50 characters.
string
The detailed description of the plan. Must be 1-127 characters.
array
required
An array of billing cycles for trial billing and regular billing. A plan can have at most two trial cycles and only one regular cycle.
boolean
Indicates whether you can subscribe to this plan by providing a quantity for the goods or service.
object
required
The payment preferences for a subscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_PRODUCTCreates a new product in PayPal’s catalog. Use when you need to set up a product that can be used with PayPal’s subscription or payment services. The product can be physical goods, digital goods, or a service. Once created, you can associate plans and pricing with this product. Use this action when you want to create a new product entry in PayPal’s catalog system for selling physical items, digital products, or services through PayPal’s payment infrastructure.

Input Parameters

string
The ID for the product. You can specify the SKU for the product. If omitted, the system generates an ID with the PROD- prefix.
string
required
The product name. Required. Maximum 127 characters.
string ("PHYSICAL" | "DIGITAL" | "SERVICE")
The product type. Indicates whether the product is physical or digital goods, or a service. Default: PHYSICAL.
string ("ACCESSORIES" | "ACCOUNTING" | "ADULT" | "ADVERTISING" | "AIRLINES" | "ANTIQUES" | "ART_AND_CRAFT_SUPPLIES" | "ART_DEALERS_AND_GALLERIES" | "ARTS_AND_CRAFTS" | "AUDIO_BOOKS" | "AUTOMOTIVE" | "BABIES_CLOTHING_AND_SUPPLIES" | "BANKING" | "BEAUTY_AND_FRAGRANCES" | "BOOKS" | "BOOKS_AND_MAGAZINES" | "BUSINESS" | "CAMERAS_AND_PHOTOGRAPHY" | "CAR_AND_TRUCK_DEALERS" | "CHARITY" | "CLOTHING" | "CLOTHING_ACCESSORIES_AND_SHOES" | "COFFEE_AND_TEA" | "COLLECTIBLES" | "COMPUTER_HARDWARE_AND_SOFTWARE" | "CONSTRUCTION" | "CONSUMER_ELECTRONICS" | "COSMETIC_STORES" | "CATERING_SERVICES" | "CURRENCY" | "DAIRY_PRODUCTS" | "DANCE_HALLS_STUDIOS_AND_SCHOOLS" | "DENTAL" | "DEPARTMENT_STORES" | "DIGITAL_GOODS" | "DIGITAL_MEDIA_BOOKS_MOVIES_MUSIC" | "DOGS_AND_CATS" | "DOWNLOAD" | "DRUGSTORE" | "DURABLE_GOODS" | "ECOMMERCE_DEVELOPMENT" | "EDUCATION" | "ELECTRONICS" | "ENTERTAINMENT" | "EQUIPMENT" | "EVENTS" | "FASHION_JEWELRY" | "FERTILIZERS" | "FINANCIAL" | "FINANCIAL_SERVICES" | "FIREARMS_WEAPONS_AND_KNIVES" | "FLORISTS" | "FOOD" | "FOOD_PRODUCTS" | "FUNERAL" | "FURNITURE" | "GADGETS_AND_OTHER_ELECTRONICS" | "GAMBLING" | "GAMES" | "GARDEN_SUPPLIES" | "GENERAL" | "GIFTS_AND_FLOWERS" | "GOVERNMENT" | "HARDWARE_AND_TOOLS" | "HEALTH_AND_NUTRITION" | "HEALTH_AND_PERSONAL_CARE" | "HOBBIES_TOYS_AND_GAMES" | "HOME_AND_GARDEN" | "HOTELS_MOTELS_INNS_RESORTS" | "HUMOROUS_GIFTS_AND_NOVELTIES" | "INSURANCE" | "JEWELRY_AND_WATCHES" | "KITCHEN" | "LAW" | "LEGAL_SERVICES_AND_ATTORNEYS" | "LIVESTOCK" | "LOCAL_DELIVERY_SERVICE" | "LOCKSMITH" | "LOTTERY_AND_CONTESTS" | "LUGGAGE_AND_LEATHER_GOODS" | "LUXURY" | "MAGAZINES" | "MARINE_SUPPLIES" | "MEDICAL" | "MEDICAL_AND_PHARMACEUTICAL" | "MEMORABILIA" | "MILITARY" | "MOBILE_RINGTONES" | "MOTION_PICTURE_THEATERS" | "MOVIE_TICKETS" | "MULTI_LEVEL_MARKETING" | "MUSIC" | "MUSIC_CDS_CASSETTES_AND_ALBUMS" | "NETWORKING" | "NON_DURABLE_GOODS" | "NON_PROFIT_POLITICAL_AND_RELIGION" | "NUTRITION" | "OFFICE" | "OFFICE_SUPPLIES_AND_EQUIPMENT" | "ONLINE_DATING" | "ONLINE_GAMING" | "ONLINE_SERVICES" | "OPTICAL" | "OTHER" | "OUTDOOR" | "PACKAGING" | "PEST_CONTROL" | "PET_SHOPS_PET_FOOD_AND_SUPPLIES" | "PETROLEUM_AND_PETROLEUM_PRODUCTS" | "PHOTOFINISHING" | "PHOTOGRAPHY" | "PHYSICAL_GOOD" | "PRECIOUS_STONES_AND_GOODS" | "PRESCRIPTION_DRUGS" | "PRINTING" | "PROMOTIONAL_ITEMS" | "PUBLISHING" | "PUBLISHING_AND_PRINTING" | "REAL_ESTATE" | "RECREATIONAL" | "RELIGIOUS" | "RENTAL" | "REPAIR" | "RESTAURANTS" | "RETAIL" | "SCHOOLS_AND_COLLEGES" | "SERVICES" | "SHOES" | "SOFTWARE" | "SPORTING" | "SPORTING_GOODS" | "SUBSCRIPTIONS" | "TELECOMMUNICATION" | "TEXTILE" | "THEATER" | "TOOLS_AND_EQUIPMENT" | "TOYS_AND_GAMES" | "TRAVEL" | "TRUCK_AND_UTILITY_TRAILER_RENTALS" | "UTILITIES" | "VETERINARY" | "VIDEO_GAMES_AND_SYSTEMS" | "WASTE_MANAGEMENT" | "WHOLESALE" | "WINE_AND_ALCOHOL")
The product category classification.
string
The home page URL for the product. Must be a valid URI.
string
The image URL for the product. Must be a valid URI.
string
The product description. Maximum 256 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_SUBSCRIPTIONCreates a new PayPal subscription based on a billing plan. Use this action when you need to set up a recurring billing subscription for a customer. The action returns a subscription ID and an approval URL where the subscriber must complete the subscription by logging into their PayPal account and confirming the payment. This action is irreversible once the subscriber approves the subscription. Required fields: - plan_id: The PayPal billing plan ID Important: - The subscriber will be redirected to PayPal to approve the subscription - Use the ‘approve’ link from the response to redirect the subscriber - The subscription status will be ‘PENDING’ until the subscriber approves it

Input Parameters

object
An inline plan object to customize the subscription.
string
required
The ID of the plan for the subscription. Typically a PayPal plan ID like ‘P-4BP00732K8416940FNHU6FGA’.
string
The quantity of the product in the subscription.
string
The custom id for the subscription. Can be an invoice id.
string
The date and time when the subscription starts, in Internet date and time format (ISO 8601).
object
The subscriber information for the subscription.
boolean
DEPRECATED. Indicates whether the subscription auto-renews after the billing cycles complete.
object
The currency and amount for a financial transaction.
object
The application context, which customizes the payer experience during the subscription approval process with PayPal.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_TEMPLATECreates a PayPal invoice template. Use this action when you need to create a reusable invoice template that can be used to generate invoices with consistent settings. Templates are useful for businesses that regularly send similar invoices. Required fields: - name: The template name (must be unique) - template_info.detail.currency_code: The three-character ISO-4217 currency code Optional fields: - default_template: Set as the default template (only one allowed per account) - standard_template: Indicates if this is a custom template - template_info: Full template configuration - invoicer: Business information (email, tax_id, logo_url, etc.) - primary_recipients: Billing/shipping information for recipients - items: Line item presets - configuration: Tax settings, partial payment options - settings: Display preferences - unit_of_measure: QUANTITY, HOURS, or AMOUNT The created template can be used with the Generate Invoice action to quickly create invoices from pre-configured templates.

Input Parameters

string
required
The template name. Must be unique.
array
The template settings. Sets a template as the default template or edit template.
object
The template details including invoicer business information, invoice recipients, items, and configuration.
string ("QUANTITY" | "HOURS" | "AMOUNT")
The unit of measure for the invoiced item.
boolean
Indicates whether this template is the default template. A invoicer can have one default template.
boolean
Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_WEBHOOKCreates a PayPal webhook endpoint to receive notifications about events. Use this action when you need to set up a webhook to receive real-time notifications about PayPal events such as payment completions, refunds, disputes, or subscription changes. The webhook URL must be publicly accessible and support HTTPS. The action returns the created webhook object including its unique ID for later reference.

Input Parameters

string
required
The URL that is configured to listen on localhost for incoming POST notification messages that contain event information. The URL must be a valid HTTPS URL.
array
required
An array of events to which to subscribe your webhook. To subscribe to all events, including events as they are added, specify the asterisk wild card ’*’ as the name. To list all supported events, use the List Available Events endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_WEBHOOK_LOOKUPCreates a PayPal webhook lookup and returns its ID and any available client ID and related links. If a lookup already exists, the action can return its details when the ID is available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_CREATE_WEB_PROFILECreates a PayPal web experience profile for customizing checkout. Use this action when you need to set up a branded, customized checkout experience for PayPal payments. This includes configuring the landing page, branding elements like logo and brand name, input field customization, and checkout flow behavior. The profile can be set as temporary (persists for three hours) or permanent. To use this profile, pass its ID when creating a payment.

Input Parameters

string
The ID of the web experience profile. If not provided, PayPal generates an ID.
string
required
The web experience profile name. Must be unique for a set of profiles for a merchant.
boolean
Indicates whether the profile persists for three hours or permanently. Set to false for permanent persistence, true for three-hour persistence.
object
The flow configuration parameters.
object
The input field customization parameters.
object
The style and presentation parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DEACTIVATE_PLANDeactivates a PayPal billing plan, making it unavailable for new subscriptions while preserving existing subscriptions. Use this action when you need to stop offering a particular billing plan without deleting it. Existing subscriptions will continue to work, but no new subscriptions can be created with this plan. Note: Only plans in an ACTIVE state can be deactivated. Deactivated plans cannot be reactivated.

Input Parameters

string
required
The unique plan identifier. Required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_EXTERNAL_PAYMENTDeletes an external payment record from a specified PayPal invoice. The tool reports success for a 204 response and also for any 404 response, so a success result alone does not confirm that a record was deleted.

Input Parameters

string
required
The unique identifier of the invoice from which to delete the external payment. This is the invoice ID returned when creating or listing invoices.
string
required
The unique identifier of the external payment transaction to delete. This is the transaction ID associated with the payment record on the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_INVOICEDeletes a PayPal invoice by its ID. Use this action when you need to permanently remove an invoice that is no longer needed. This action is irreversible — once deleted, the invoice cannot be recovered and any associated payment records will be lost. Note: Only draft invoices can be deleted. Attempting to delete an invoice that has been sent or paid will return an error.

Input Parameters

string
required
The ID of the invoice to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_INVOICE_PAYMENT_RECORDDeletes a payment record from a PayPal invoice by invoice and transaction ID. The tool reports success for HTTP 204 and also for any HTTP 404 response.

Input Parameters

string
required
The ID of the invoice from which to delete the payment record.
string
required
The ID of the payment transaction record to delete from the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_INVOICE_REFUND_RECORDDeletes an external refund record from a specified PayPal invoice using the deprecated Invoicing v1 API. This removes the record from the invoice rather than reversing the underlying payment.

Input Parameters

string
required
The unique identifier of the invoice from which to delete the refund record. This is the invoice ID returned when creating or listing invoices.
string
required
The unique identifier of the refund transaction to delete. This is the transaction ID associated with the refund record on the invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_PAYMENT_RESOURCEDeletes a PayPal payment resource. Use when you need to permanently remove a payment resource that is no longer needed. This action is irreversible — the payment resource cannot be recovered once deleted. Note: Only payment resources in a valid state can be deleted. Attempting to delete a resource that is already deleted or does not exist will return an error.

Input Parameters

string
required
The unique payment resource identifier to delete. Typically starts with ‘XD’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_TEMPLATEDeletes a PayPal invoice template by its ID. Use this action when you need to permanently remove an invoice template that is no longer needed. This action is irreversible — once deleted, the template cannot be recovered and will need to be recreated if needed again. Note: Only templates that are not currently in use can be deleted. Attempting to delete a template that is associated with active invoices may return an error.

Input Parameters

string
required
The ID of the template to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_WEBHOOKDeletes a PayPal webhook by its ID. Use this action when you need to permanently remove a webhook endpoint that is no longer needed. This action is irreversible — once deleted, the webhook cannot be recovered and will stop receiving event notifications immediately. Note: Deleting a webhook does not affect any events that were already processed by that webhook. Only future events will be affected.

Input Parameters

string
required
The ID of the webhook to delete. This is the unique identifier returned when the webhook was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_DELETE_WEB_PROFILEDeletes a PayPal web experience profile by its ID. Use this action when you need to permanently remove a web experience profile that is no longer needed. This action is irreversible — the web experience profile cannot be recovered once deleted. Note: Only web profiles that are not currently in use can be deleted. Attempting to delete a profile that is associated with an active resource will return an error.

Input Parameters

string
required
The ID of the web experience profile to delete. Typically starts with ‘TXP-’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_FETCH_NODEQueries a GraphQL node by global ID at the configured PayPal base URL. The query requests only the node ID, not type-specific resource details.

Input Parameters

string
required
The global ID of the node to fetch. This ID is the base64-encoded ID used by Braintree’s GraphQL API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_FINALIZE_PAY_PAL_BRAINTREE_DISPUTEFinalizes a Braintree dispute after adding evidence, submitting it to the cardholder’s bank for review. Use this action when you have finished adding evidence to an OPEN dispute and want to formally submit it for review. Only disputes with a status of OPEN can be finalized. This action must be performed before the reply-by date deadline. Once finalized, the dispute cannot be modified or additional evidence added. Note: This action uses the Braintree GraphQL API endpoint, which is separate from the standard PayPal REST API.

Input Parameters

string
required
The ID of the dispute to finalize. Only disputes with a status of OPEN can be finalized.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_FIND_ELIGIBLE_METHODSFind a list of eligible payment methods for a customer. Use this action when you need to determine which payment methods (such as PayPal, PayPal Credit, Pay Later, or Venmo) are available for a customer based on their country and purchase details. This is useful for displaying appropriate payment options during checkout or determining payment eligibility before creating an order. The response includes available payment methods and optionally vaulted tokens if the customer has saved payment instruments. Common use cases: - Pre-checkout payment method availability - Display appropriate payment options to customers - Determine eligible funding sources for a transaction

Input Parameters

object
Customer who is making a purchase from the merchant/partner.
object
Preferences of merchant/partner consuming the API.
array
required
An array of purchase units for which to determine payment eligibility. Each unit includes amount and optionally payee information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GENERATE_CLIENT_TOKENGenerate a client token for PayPal JavaScript SDK integration. Use this action when you need to obtain a client token for accepting PayPal payments on the client side. The client token is required when initializing the PayPal JS SDK (paypal.Buttons() or paypal.Messages()) in your web application. This action requires no request body parameters - the token is generated based on your authenticated credentials (Bearer token in Authorization header). Note: Client tokens are short-lived and should be fetched fresh before each checkout session. Do not cache or reuse client tokens across multiple sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GENERATE_NEXT_INVOICE_NUMBERGenerates the next invoice number using PayPal’s deprecated Invoicing v1 API, for use before creating an invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GENERATE_NEXT_INVOICE_NUMBER_V2Generates the next invoice number from PayPal’s invoicing service using the v2 API. Use this action when you need to retrieve the next sequential invoice number in your customized format before creating an invoice. This ensures consistent invoice numbering across your PayPal invoices. Note: This action queries PayPal for the next available invoice number in your sequence. The format is configured in your PayPal account settings.

Input Parameters

boolean
Optional parameter to decide whether to fetch the next invoice number or ID. Set to true to fetch the ID, false or omitted for the number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GENERATE_QR_CODEGenerates a QR code image for a PayPal invoice using the v2 invoicing API. Use this action when you need to display a scannable QR code that customers can use to pay an invoice or view its details via the PayPal mobile app. The QR code contains encoded payment information that redirects users to PayPal to complete the transaction. Customization options: - Adjust dimensions using the width and height parameters (150-500 pixels) - Choose between payment URL (action='pay') or details URL (action='details') Note: This action uses the PayPal Invoicing API v2, which is the recommended version for new integrations.

Input Parameters

integer
The width, in pixels, of the QR code image. Value must be between 150 and 500 pixels.
string ("pay" | "details")
The type of URL for which to generate a QR code. - PAY: Generate a QR code for payment - DETAILS: Generate a QR code for viewing invoice details
integer
The height, in pixels, of the QR code image. Value must be between 150 and 500 pixels.
string
required
The ID of the invoice for which to generate a QR code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_BILLING_SUBSCRIPTIONSLists PayPal billing subscriptions for the merchant account, with pagination and optional time-range and status filters. Request total item and page counts with total_required.

Input Parameters

integer
A non-zero integer representing the page number of the result. Default: 1.
string ("APPROVAL_PENDING" | "APPROVED" | "ACTIVE" | "SUSPENDED" | "CANCELLED" | "EXPIRED")
Possible status values for a subscription.
string
The end date and time for the subscription range, in Internet date and time format. Example: 2020-12-31T23:59:59Z.
integer
The number of items to return in the response. Default: 25, Maximum: 100.
string
The start date and time for the subscription range, in Internet date and time format. Example: 2020-01-01T00:00:00Z.
boolean
Indicates whether to show the total items and total pages in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_INVOICERetrieves a PayPal invoice by ID, including modeled details such as status, amounts, line items, payments, refunds, recipients, and related links. Returned details are limited to the tool’s response model.

Input Parameters

string
required
The ID of the invoice to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_INVOICING_INVOICES_QR_CODEGenerates a QR code image for a PayPal invoice. Use this action when you need to display a scannable QR code that customers can use to pay an invoice. The QR code contains encoded payment information that redirects customers to PayPal to complete the payment. You can customize the QR code dimensions using the width and height parameters. Note: The PayPal Invoicing v1 API is deprecated. Consider migrating to the v2 API for new integrations.

Input Parameters

integer
The width of the QR code image in pixels. The minimum value is 150 and the maximum value is 600.
string
The action for the QR code. Can be ‘pay’ for payment or ‘capture’ for payment capture.
integer
The height of the QR code image in pixels. The minimum value is 150 and the maximum value is 600.
string
required
The ID of the invoice for which to generate a QR code.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_INVOICING_TEMPLATERetrieves a PayPal invoice template by ID, including modeled name, settings, invoicer information, recipients, items, amounts, configuration, and links. Returned details are limited to the tool’s response model.

Input Parameters

string
required
The ID of the template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_ORDERRetrieves a PayPal checkout order by ID, including modeled status, intent, purchase units, payer information, and links. Payment source can be requested, but its response is restricted to a string-to-string mapping.

Input Parameters

string
A comma-separated list of fields that should be returned for the order. Valid filter field is ‘payment_source’.
string
required
The ID of the order for which to show details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_PAYMENTRetrieves details for a PayPal payment by its ID using the deprecated v1 Payments API. Use when you need to check the status, payer information, transaction details, or related resources of an existing payment. This action is useful for verifying payment details, checking if a payment was approved, viewing transaction amounts, or accessing related sale/authorization/capture resources. Note that this is a deprecated v1 API endpoint — consider using the v2 Payments API for new integrations.

Input Parameters

string
required
The ID of the payment to retrieve. This is the unique identifier assigned when a payment was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_PAYMENTS_REFUNDRetrieves a PayPal refund by ID to check its status, amount, and other details. DEPRECATED: Payments v1 is intended for existing integrations and will be removed; migrate refund lookups to Payments v2.

Input Parameters

string
required
The ID of the refund to retrieve. This is the unique identifier assigned when a refund was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_PLANRetrieves details for a specific PayPal billing plan by its ID. Use when you need to fetch information about an existing subscription plan, such as its pricing, billing cycles, status, or payment preferences.

Input Parameters

string
required
The unique PayPal-generated ID for the plan. Plan IDs start with ‘P-’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_PRODUCTRetrieves detailed information about a specific PayPal product by its ID. Use when you need to get details about a product, such as its name, description, category, or type. This action is useful for verifying product details before creating plans or subscriptions.

Input Parameters

string
required
The ID of the product to retrieve. This is the unique identifier assigned when the product was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_SUBSCRIPTIONRetrieves the details of a PayPal subscription by its ID. Use this action when you need to check the status, billing information, subscriber details, or other properties of an existing subscription. Optionally, you can request additional fields like ‘last_failed_payment’ or ‘plan’ details using the fields parameter.

Input Parameters

string
required
The ID of the subscription to retrieve.
string
A comma-separated list of additional fields to include in the response. Possible values are ‘last_failed_payment’ and ‘plan’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_USERINFORetrieves user claims from PayPal using OpenID Connect. Use when you need to obtain authenticated user’s profile information such as email, name, and address based on an access token. This endpoint returns user identity information associated with the OAuth access token provided in the Authorization header. The access token must have been obtained via OpenID Connect authentication flow. This action requires an access token with the ‘openid’ scope. The token is passed via the Authorization header (Bearer token), which is automatically injected from the auth_metadata.

Input Parameters

string ("paypalv1.userinfo-1.0" | "openid")
The schema that defines the claims format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_USER_INFORetrieves user profile information from PayPal. Use when you need to get the authenticated user’s profile details including name, email, address, and account verification status. The response is filtered by the specified schema. The only supported schema value is ‘paypalv1.1’, which returns the user information in a structured format.

Input Parameters

string ("paypalv1.1")
Supported schema values for user info response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_WEBHOOKRetrieves detailed information about a specific PayPal webhook by its ID. Use this action when you need to get details about an existing webhook configuration, such as the webhook URL, subscribed event types, or webhook status. This is useful for auditing webhook settings, verifying webhook subscriptions, or checking webhook configuration. This is a read-only operation that returns the webhook details including its ID, URL, subscribed event types, and HATEOAS links for related actions.

Input Parameters

string
required
The ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_WEBHOOK_LOOKUPRetrieves detailed information about a specific PayPal webhook lookup by its ID. Use this action when you need to get details about a webhook lookup, such as its associated client ID and related HATEOAS links. This is useful for verifying webhook lookup information or auditing webhook lookup records. This is a read-only operation that returns the webhook lookup details including the lookup ID, client ID, and related links for navigation.

Input Parameters

string
required
The ID of the webhook lookup to retrieve. This is the unique identifier assigned when the webhook lookup was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_GET_WEB_PROFILERetrieves detailed information about a PayPal web experience profile by its ID. Use when you need to get details about an existing web experience profile, such as its name, flow configuration, input field settings, or presentation style. This is useful for auditing profile settings, verifying configurations, or retrieving profile information before updating. This is a read-only operation that returns the web profile details including its ID, name, flow config, input fields, presentation settings, and temporary status.

Input Parameters

string
required
The ID of the web experience profile to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_DISPUTESList PayPal customer disputes with optional filtering by date, transaction, or state. Use when you need to retrieve a paginated list of PayPal disputes. You can filter by creation date, transaction ID, dispute state, or update time range. Results are sorted by creation time (newest first). Use the next_page_token from response links to paginate through additional results.

Input Parameters

integer
Limits the number of disputes in the response. Maximum allowed value is typically 100.
string
Filters the disputes by creation date and time. The start time must be within the last 180 days. Format: ISO 8601 (e.g., yyyy-MM-ddTHH:mm:ss.SSSZ). You can specify either start_time or disputed_transaction_id, but not both.
array
Filters the disputes by one or more dispute states. Separate multiple values with comma or provide as a list. When multiple states are specified, disputes matching any of the states are returned.
string
A token that describes the next page of results to fetch. Use the token from the previous response’s HATEOAS links.
string
Filters disputes updated after this date and time. Must be within the last 180 days. Default is 180 days ago. Format: ISO 8601.
string
Filters disputes updated before this date and time. Must be within the last 180 days. Default is current time. Format: ISO 8601.
string
Filters the disputes by a transaction ID. You can specify either start_time or disputed_transaction_id, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_INVOICESLists PayPal invoices with pagination and optional total counts. A fields option is passed to PayPal to control the requested detail; returned invoice data is limited to the tool’s response model.

Input Parameters

integer
The page number to be retrieved. A combination of page=1 and page_size=20 returns the first 20 templates. A combination of page=2 and page_size=20 returns the next 20 templates.
string ("all" | "none")
Fields to return in the response.
integer
The maximum number of templates to return in the response.
boolean
Indicates whether to show total_pages and total_items in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_LEGACY_BILLING_PLANSLists billing plans using the legacy PayPal payments API (v1/payments/billing-plans). Use when you need to retrieve billing plans created with the legacy PayPal billing agreements API. This is a read-only operation that returns plan details including payment definitions, merchant preferences, and status. Note: This action uses the legacy API endpoint. For newer integrations, consider using the /v1/billing/plans endpoint instead.

Input Parameters

integer
A non-zero integer which is the start index of the entire list of items to return in the response.
string ("CREATED" | "ACTIVE" | "INACTIVE" | "DELETED")
Possible states of a billing plan in the legacy API.
string
The end date and time for the range to consider, in ISO 8601 format (e.g., 2024-12-31T23:59:59Z).
integer
The number of items to return in the response. Defaults to 25.
string
The start date and time for the range to consider, in ISO 8601 format (e.g., 2024-01-01T00:00:00Z).
boolean
Indicates whether to show the total count in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_PAYMENTSLists PayPal Payments v1 payments for reconciliation or monitoring, with pagination and optional time, payer, and status parameters. DEPRECATED: Payments v1 is intended for existing integrations and will be removed. Migrate payment listing to the Transaction Search API, which has a different query and response model.

Input Parameters

integer
The number of items to return. Default: 10. Maximum: 20.
string ("CREATED" | "APPROVED" | "FAILED" | "PAYER_ACTION_REQUIRED")
Payment status values.
string
Filters payments created before this date and time (ISO 8601 format).
string
Filters payments by the PayPal account ID of the payer.
string
The ID of the starting payment in a paginated result set.
string
Filters payments created after this date and time (ISO 8601 format).
integer
The index of the first payment to return. Must be a multiple of count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_PLANSLists billing plans from PayPal with optional filtering and pagination. Use this action when you need to retrieve available billing plans for subscription products. This is a read-only operation that returns plan details including pricing, billing cycles, and status. Results can be filtered by product_id and paginated using page and page_size parameters. The response includes HATEOAS links for navigating between pages and performing related actions (e.g., activate, deactivate, update plan).

Input Parameters

integer
A non-zero integer which is the start index of the entire list of items to return in the response. The combination of page=1 and page_size=20 returns the first 20 items.
integer
The number of items to return in the response. Defaults to 25.
string
Filters the response by a Product ID.
boolean
Indicates whether to show the total count in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_PRODUCTSList products from the PayPal product catalog. Use when you need to retrieve a paginated list of products with their details, such as product IDs, names, and descriptions. This action supports pagination via page_size and page parameters. Set total_required=true to include total item and page counts in the response.

Input Parameters

integer
A non-zero integer which is the start index of the entire list of items that are returned in the response.
integer
The number of items to return in the response. Defaults to 10.
boolean
Indicates whether to show the total items and total pages in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_TEMPLATESList invoice templates from PayPal. Use when you need to retrieve a paginated list of PayPal invoice templates with their details. This is a read-only operation that returns template information including names, IDs, settings, and default status. The action supports pagination via page and page_size parameters, and you can control which fields are returned using the fields parameter (set to ‘none’ for minimal template info).

Input Parameters

integer
The page number to be retrieved, for the list of templates. A combination of page=1 and page_size=20 returns the first 20 templates.
string ("all" | "none")
Fields to return in the response.
integer
The maximum number of templates to return in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_WEBHOOK_EVENT_TYPESLists all available PayPal webhook event types to which you can subscribe. Use this action when you need to discover all webhook events available in the PayPal API before creating or configuring webhooks. This is useful for initial setup or when you need to display available webhook options to users. The endpoint requires no parameters and returns the full list of supported event types with their descriptions and statuses. This is a read-only operation that queries available events without modifying anything.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_WEBHOOK_EVENT_TYPE_SUBSCRIPTIONSLists event type subscriptions for a specific PayPal webhook. Use this action when you need to retrieve the list of event types to which a specific webhook is subscribed. This is useful for auditing webhook configurations, verifying which events a webhook is set up to receive, or checking the status of event subscriptions. Unlike the ListWebhookEventTypes action which lists all available event types, this action returns only the event types that a specific webhook is subscribed to. This is a read-only operation that does not modify any webhook configuration.

Input Parameters

string
required
The ID of the webhook for which to list event type subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_WEBHOOK_LOOKUPSLists all webhook lookups associated with your PayPal application. Use this action when you need to retrieve webhook lookups that have been configured for your application. This is useful for auditing webhook configurations, verifying lookup status, or checking which client IDs have registered webhooks. This is a read-only operation that returns webhook lookup details including IDs, client IDs, and HATEOAS links for related actions. The action requires no input parameters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_WEBHOOKSLists webhooks configured for an application or PayPal account. Use this action when you need to retrieve all webhooks that have been created and configured in your PayPal integration. This is useful for auditing existing webhook configurations, verifying webhook subscriptions, or checking webhook status. The results can be filtered by anchor_type to show webhooks for the application (APPLICATION) or a specific account (ACCOUNT). This is a read-only operation that returns webhook details including URLs, subscribed event types, and HATEOAS links for related actions.

Input Parameters

string ("APPLICATION" | "ACCOUNT")
The type of entity to use as an anchor for filtering webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_LIST_WEB_PROFILESLists PayPal web experience profiles for a merchant or subject, including checkout flow and branding details. PayPal documents this endpoint as returning the latest 20 profiles.

Input Parameters

integer
A non-zero integer which is the start index of the entire list of items to return.
integer
The number of items to return in the response. Defaults to 25. Maximum is 20.
boolean
Indicates whether to show the total count in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_PATCH_ORDERSPartially updates a PayPal checkout order using JSON Patch operations on patchable properties. For HTTP 204, the tool returns a structured success result; JSON error responses are returned as unsuccessful results.

Input Parameters

string
required
The ID of the checkout order to update.
array
required
An array of JSON Patch operations to apply to the order. Each operation follows RFC 6902 format with ‘op’, ‘path’, and optionally ‘value’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_PATCH_PLANPartially updates a PayPal subscription billing plan using JSON Patch operations. On a successful response, it returns a success indicator and the plan ID.

Input Parameters

string
required
The unique billing plan ID.
array
required
An array of JSON Patch operations to apply to the billing plan. Each operation follows RFC 6902 format with ‘op’, ‘path’, and optionally ‘value’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_PATCH_SUBSCRIPTIONPartially updates a PayPal subscription by ID using an ordered array of JSON Patch operations. PayPal error responses with JSON are returned with success set to false and error details.

Input Parameters

string
required
The ID of the subscription to update.
array
required
Array of JSON Patch operations to apply to the subscription. Each operation is applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_PATCH_WEB_PROFILEPartially updates a PayPal web experience profile by ID using JSON Patch operations. On success, returns a success flag and the profile ID.

Input Parameters

string
required
The unique web experience profile ID.
array
required
An array of JSON Patch operations to apply to the web experience profile. Each operation follows RFC 6902 format with ‘op’, ‘path’, and optionally ‘value’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_PING_BRAINTREESends a GraphQL ping query to the configured PayPal base URL. The response may contain ping data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_QUERY_BRAINTREE_REPORTChecks GraphQL connectivity by sending a read-only ping to the configured PayPal endpoint. Braintree report retrieval is currently unavailable through this tool.

Input Parameters

string
The end date for the report query in ISO 8601 format (e.g., ‘2024-01-31’). Used for time-based reports.
string
The start date for the report query in ISO 8601 format (e.g., ‘2024-01-01’). Used for time-based reports.
string ("transactionReport" | "disputeReport" | "merchantFundsAvailable" | "transactionSettlementOutcomesReport")
required
The type of report to query. Each type has its own input parameters and response structure.
string
The merchant account ID to filter the report by. If not specified, uses the default merchant account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_RETRIEVE_PAYMENT_RESOURCERetrieve a PayPal payment resource by its ID. Use this action when you need to fetch details about an existing payment resource created through the Payment Links and Buttons API. This action is useful for checking payment resource status, viewing line items, or retrieving associated links after creating a payment resource. Note: Payment resources are shareable payment links used for simple payment flows.

Input Parameters

string
required
Unique identifier of the payment resource to retrieve. This ID is typically returned when creating a payment resource.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_SEARCH_INVOICESSearch for PayPal invoices based on various filter criteria. Use when you need to find invoices matching specific criteria such as status, date ranges, recipient information, amount ranges, or invoice numbers. This action supports pagination and can return total counts when total_required=true. Common use cases: - Find all invoices with a specific status (e.g., all DRAFT or SENT invoices) - Find invoices created within a date range - Find invoices for a specific customer by email or business name - Find invoices within a monetary amount range - Combine multiple filters for precise invoice searches Pagination: Results are paginated using page and page_size parameters. Set total_required=true to include total_counts in the response.

Input Parameters

string
A private bookkeeping memo to filter by.
integer
The page number to be retrieved. A combination of page=1 and page_size=20 returns the first 20 invoices. A combination of page=2 and page_size=20 returns the next 20 invoices.
array
A list of fields to return for each invoice. Valid fields are: items, payments, refunds, additional_recipients_info, and attachments. Maximum 5 fields.
array
An array of invoice status values to filter by. Common statuses include DRAFT, SENT, SCHEDULED, PAID, CANCELLED, REFUNDED, PARTIALLY_PAID, UNPAID.
boolean
Indicates whether to list merchant-archived invoices. true: lists only archived, false: lists only unarchived, null: lists all.
integer
The maximum number of invoices to return in the response.
string
The reference data including a Purchase Order (PO) number to filter by.
string
The three-character ISO-4217 currency code to filter invoices.
object
The date range for filtering invoices.
string
Filters the search by the invoice number.
boolean
Indicates whether to show total_pages and total_items in the response.
string
Filters the search by the recipient email address.
object
The date range for filtering invoices.
object
The date and time range for filtering invoices.
object
The amount range for filtering invoices.
object
The date and time range for filtering invoices.
string
Filters the search by the recipient last name.
string
Filters the search by the recipient first name.
string
Filters the search by the recipient business name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_SEND_INVOICESends a draft PayPal invoice by ID. Recipient email notification can be enabled or disabled, with options to customize the subject and note, copy the invoicer, and add recipients.

Input Parameters

string
A note to the recipient that is included in the email. Maximum length is 4000 characters.
string
The subject of the email that is sent to the recipient. Maximum length is 998 characters.
string
required
The ID of the invoice to send.
boolean
Whether to send a copy of the invoice to the invoicer’s email address. Defaults to false.
boolean
Whether to send the invoice to the recipient’s email address. Defaults to true.
array
An array of email addresses to receive a copy of the invoice notification. Maximum of 100 email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_SIMULATE_WEBHOOK_EVENTSimulates a PayPal webhook event to test a webhook integration, using a webhook URL or ID. Event names are limited to letters, digits, and periods.

Input Parameters

string
The URL for the webhook endpoint. If omitted, the webhook ID is required.
string
required
The event name. Specify one of the subscribed events. For each request, provide only one event.
string
The ID of the webhook. If omitted, the URL is required.
string
The identifier for event type (e.g., 1.0, 2.0).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_DISPUTEPartially updates a PayPal dispute using an ordered list of JSON Patch operations. The response reports success or failure, including error details when available.

Input Parameters

string
required
The ID of the dispute to update.
array
required
Array of JSON Patch operations to apply to the dispute. Each operation is applied in order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_INVOICEFully updates a PayPal invoice by replacing the entire invoice with the provided data. Use this action when you need to completely replace an invoice with new data. The invoice must be in DRAFT status to be fully updated. Note: This action sends optional notifications to both the recipient and the merchant by default. You can control this behavior using the send_to_recipient and send_to_invoicer parameters. This action is useful when you want to replace the entire invoice rather than making partial updates. For partial updates, use the UpdateInvoice action with PATCH semantics.

Input Parameters

array
An array of invoice line item information. The maximum items for an invoice is 100.
object
The invoice amount summary.
object
required
The details of the invoice. Includes invoice number, date, payment terms, and audit metadata.
string ("DRAFT" | "SENT" | "SCHEDULED" | "PAID" | "MARKED_AS_PAID" | "CANCELLED" | "REFUNDED" | "PARTIALLY_PAID" | "PARTIALLY_REFUNDED" | "MARKED_AS_REFUNDED" | "UNPAID" | "PAYMENT_PENDING" | "AUTO_CANCELLED" | "PAID_EXTERNAL" | "REFUNDED_EXTERNAL" | "SHARED")
The status of an invoice.
object
The currency and amount for a financial transaction.
object
The invoicer business information.
object
The currency and amount for a financial transaction.
string
required
The ID of the invoice to update.
object
The invoice configuration.
boolean
Indicates whether to send the invoice update notification to the merchant. Defaults to true.
boolean
Indicates whether to send the invoice update notification to the recipient. Defaults to true.
array
The billing and shipping information. Includes name, email, address, phone, and language.
array
An array of one or more CC: emails to which notifications are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_PAY_PAL_PRODUCTPartially updates a PayPal product by ID using an array of JSON Patch operations. On a 204 response, it returns a success flag and product ID.

Input Parameters

array
required
An array of JSON Patch operations to apply to the product. Each operation follows RFC 6902 format with ‘op’, ‘path’, and optionally ‘value’.
string
required
The unique product ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_PAY_PAL_WEBHOOKUpdates a PayPal webhook using JSON Patch operations, including changes to its URL or event subscriptions. The response contains the updated webhook when returned, or the webhook ID on a no-content response.

Input Parameters

array
required
An array of JSON Patch operations to apply to the webhook. Each operation follows RFC 6902 format with ‘op’, ‘path’, and optionally ‘value’.
string
required
The unique webhook ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_TEMPLATESFully updates a PayPal invoice template by ID, replacing its existing values with the supplied template data. Provide the template ID and name; omitted fields may be reset.

Input Parameters

string
required
The ID of the template.
string
required
The template name. Must be unique for the invoicer.
object
The template settings.
object
The template details including invoicer business information, invoice recipients, items, and configuration.
string ("QUANTITY" | "HOURS" | "AMOUNT")
The unit of measure for the invoiced item.
boolean
Indicates whether this template is the default template. An invoicer can have only one default template.
boolean
Indicates whether this template is a invoicer-created custom template. The system generates non-custom templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_UPDATE_WEB_PROFILEUpdates a PayPal web experience profile by replacing its configuration with the provided values. A successful no-content response is returned as a success flag.

Input Parameters

string
required
The ID of the web experience profile to update.
string
required
The web experience profile name. Must be unique for a set of profiles for a merchant.
boolean
Indicates whether the profile persists for three hours or permanently. True for three hours, false for permanent.
object
The flow configuration parameters for the web profile.
object
The input field customization parameters for the web profile.
object
The style and presentation parameters for the web profile.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_VERIFY_PAYMENT_METHODVerifies a multi-use payment method to ensure it has passed fraud rules and is associated with a valid account. Use this action when you need to verify that a vaulted (multi-use) payment method is valid before using it for transactions. The verification runs the payment method through your configured Braintree fraud rules and confirms with the card issuer that the card is associated with a valid account. This action is commonly used when a customer adds a new payment method and you want to validate it, when checking if a stored payment method is still valid before a scheduled transaction, or as part of a risk management workflow to pre-validate payment methods. The response includes a verification status (VERIFIED, FAILED, GATEWAY_REJECTED, or PROCESSOR_DECLINED) along with processor response codes. Note: This action uses the Braintree GraphQL API endpoint at /graphql. The payment method must be a multi-use token that has been stored in the Braintree vault.

Input Parameters

object
required
The input containing the payment method ID and optional merchant account ID for verification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PAYPAL_VERIFY_WEBHOOK_SIGNATUREVerifies the signature of a PayPal webhook notification to confirm its authenticity. Use this action when you receive a webhook notification from PayPal and need to verify that it was actually sent by PayPal and not tampered with during transmission. This is essential for security when processing webhook events like payments, disputes, or subscription changes. The required parameters (auth_algo, cert_url, transmission_id, transmission_sig, transmission_time, webhook_id, and webhook_event) are extracted from the webhook notification headers and body that PayPal sends to your endpoint.

Input Parameters

string
required
The X.509 public key certificate. Download the certificate from this URL and use it to verify the signature. Extract this value from the PAYPAL-CERT-URL response header, which is received with the webhook notification.
string
required
The algorithm that PayPal uses to generate the signature and that you can use to verify the signature. Extract this value from the PAYPAL-AUTH-ALGO response header, which is received with the webhook notification.
string
required
The ID of the webhook as configured in your Developer Portal account.
object
required
A webhook event notification.
string
required
The ID of the HTTP transmission. Contained in the PAYPAL-TRANSMISSION-ID header of the notification message.
string
required
The PayPal-generated asymmetric signature. Appears in the PAYPAL-TRANSMISSION-SIG header of the notification message.
string
required
The date and time of the HTTP transmission, in Internet date and time format. Appears in the PAYPAL-TRANSMISSION-TIME header of the notification message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not