PayPal
App · Payments & Billing · 6 actions · 1 trigger
Accept payments, manage catalog products, and automate billing with PayPal.
Triggers
Start a workflow when something happens in PayPal. See how triggers work.
PayPal New Payment
Triggers when a new payment is received in PayPal
Filters
Narrow which events start a run.
status- Only run for payments with this PayPal status code: S for completed payments, P pending, V reversed, D denied. Leave empty to run for every payment.
Event fields
What a run starts with. Later steps read each field with an @ reference.
transaction_idtexttransaction_statustexttransaction_amounttexttransaction_currencytexttransaction_datetextpayer_emailtextpayer_nametext
Actions
| Action | What it does |
|---|---|
| Capture a PayPal order | Collect (capture) the payment for an approved PayPal order. |
| Create a PayPal billing plan | Create a recurring billing plan for a PayPal product. |
| Create a PayPal order | Create a PayPal checkout order ready for buyer approval. |
| Create a PayPal product | Add a product to your PayPal catalog so it can be used in billing plans. |
| Get PayPal order details | Look up the current status and details of a PayPal order. |
| Refund a PayPal payment | Issue a partial or full refund for a captured PayPal payment. |
Capture a PayPal order
Collect (capture) the payment for an approved PayPal order.
Inputs
- Order ID
order_idtextRequired - The ID of the order to collect payment for
Outputs
PayPal capture result object returned by the PayPal API containing payment capture details.
Example output
{}Create a PayPal billing plan
Create a recurring billing plan for a PayPal product.
Inputs
- Product ID
product_idtextRequired - The ID of the PayPal product this plan is for
- Name
nametextRequired - Plan name
- Interval unit
interval_unittextRequired - How often to bill, such as DAY, WEEK, MONTH, or YEAR
- Interval count
interval_countnumberRequired - How many units between each charge. For example, 3 with MONTH bills every 3 months.
- Currency
currencytextRequired - Billing currency
- Amount
amountnumberRequired - Recurring charge amount
Outputs
PayPal billing plan object returned by the PayPal API containing plan configuration details.
Example output
{}Create a PayPal order
Create a PayPal checkout order ready for buyer approval.
Inputs
- Amount
amountnumberRequired - Order amount
- Currency
currencytextRequired - Currency code (e.g. USD)
- Description
descriptiontext - Order description
Outputs
PayPal order object returned by the PayPal API containing order details and approval links.
Example output
{}Create a PayPal product
Add a product to your PayPal catalog so it can be used in billing plans.
Inputs
- Name
nametextRequired - Product name
- Description
descriptiontext - Product description
- Category
categorytext - Product category, for example SOFTWARE
Outputs
PayPal product object returned by the PayPal API containing product details.
Example output
{}Get PayPal order details
Look up the current status and details of a PayPal order.
Inputs
- Order ID
order_idtextRequired - The ID of the order to look up
Outputs
PayPal order object returned by the PayPal API with current order state and details.
Example output
{}Refund a PayPal payment
Issue a partial or full refund for a captured PayPal payment.
Inputs
- Capture ID
capture_idtextRequired - The ID of the captured payment to refund
- Amount
amountnumber - Amount to refund. Leave blank to refund the full amount.
- Currency
currencytext - Currency code for the refund (e.g. USD). Required when you enter an amount.
Outputs
PayPal refund object returned by the PayPal API containing refund status and details.
Example output
{}