rocketkind
Payments

PayPal

PayPal takes payments and bills for them — checkout orders, captures and refunds, a catalog of products, subscription billing plans, and the transaction report behind reconciliation.

Authentication

  • OAuth 2.0 (Client Credentials)

Actions

Generic API request. Call any PayPal API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Authorize orderPlace a hold on the buyer's funds for an order they have already approved, without taking the money yet — use this when fulfilment happens later and paypal:captureorder will settle it.
  • Capture orderTake the money for an order the buyer has already approved — the settling step of a CAPTURE-intent checkout.
  • Create orderStart a PayPal checkout by creating an order the buyer will then approve.
  • Create productDefine a product in the PayPal catalog, the prerequisite for a billing plan and hence for subscriptions.
  • Create subscriptionSubscribe a buyer to an existing PayPal billing plan.
  • Get captureRead one captured PayPal payment by its capture id, typically to confirm settlement or to check how much is still refundable.
  • Get orderRead one PayPal checkout order by id to find out where it is in the flow — CREATED, APPROVED or COMPLETED — before deciding whether to capture or authorize it.
  • Get subscriptionRead one PayPal subscription by its id (I-…) to check whether it is still ACTIVE or has lapsed, and who is paying for it.
  • List billing plansList the subscription billing plans on the account, so a subscription can be created against the right plan id — plans live under the Subscriptions API and are separate from the catalog products paypal:listproducts returns.
  • List productsList the products defined in the PayPal catalog, so a billing plan can be created against the right product id.
  • List transactionsPull the PayPal transaction report for a date range — the reconciliation view, not the checkout view, so it covers money that moved regardless of which order produced it.
  • Refund captureReturn money to the buyer for a payment already captured.

Triggers

  • New or updated transactionStarts when a PayPal transaction is created or updated.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.