Skip to content
Nappai Documentation

PayPal Order

PayPal Order creates payment orders in your PayPal account and looks up existing ones. An order is the payment request your customer approves in PayPal: when you create it, you get a link the customer opens to pay with their PayPal account or card.

When to use it

  • A customer confirms a purchase by chat or email and you want to send them a PayPal payment link.
  • You want to generate the payment link for a booking in the same flow that records it.
  • You want to check whether a customer has already approved the payment for their order before you prepare it.

Configuration

You need a PayPal API credential with the Client ID and Client Secret of your PayPal app, and the environment: Sandbox for testing or Live for real payments. See Credentials.

FieldWhat it does
Credential (required)The PayPal API credential of your account.
Operation (required)The action the component performs: Create or Get. Defaults to Create. See Operations.
Order IDOnly in Get, and required there. The order’s identifier in PayPal.
IntentOnly in Create. CAPTURE if the payment will be collected in one go; AUTHORIZE if the amount will only be reserved on the customer’s account to collect later. Defaults to CAPTURE.
AmountOnly in Create, and required there. The amount with decimals, for example 10.00.
CurrencyOnly in Create. The order’s currency, such as EUR or USD. Defaults to USD.
DescriptionOnly in Create. Text describing the purchase. Optional.

Operations

  • Create: creates an order for the given amount and currency and returns the link for the customer to approve it.
  • Get: returns the status and details of an order.

Output

The Data output returns one item with the order’s details: its identifier, status, intent, amount, currency, description and creation date. When you create it, it includes the approval link (approve_url) you have to send to the customer. When the order already has a capture or an authorization, it also includes its identifier and status.

You can connect it to an email or a WhatsApp message to send the link to the customer, or to a condition that checks the status. The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.

Example

A craft shop sells on Instagram and takes payment with PayPal.

  1. When a customer confirms an order, the flow receives the amount and what they bought.
  2. Add PayPal Order with Operation set to Create, Amount set to 45.00, Currency set to EUR and the item’s name in Description.
  3. Connect the Data output to a message that sends the customer the approve_url link.
  4. Later, use another PayPal Order with Operation set to Get and the Order ID to check whether the customer has approved the payment.

Good practices

  • Test your flows with a Sandbox credential before you use a Live one.
  • Store the Order ID with your shop’s order: it is what you need to look it up later.