Skip to content
Nappai Documentation

PayPal Payout

PayPal Payout sends money from your PayPal account to someone else’s PayPal account, using their email address. It also checks the status of a payout you have already made. PayPal calls each transfer a payout and groups it in a batch; each batch this component creates has a single recipient.

When to use it

  • You pay commissions to affiliates or partners and want to send their amount when it is approved.
  • You return a deposit or a refund to someone who has a PayPal account.
  • You want to check whether a payout has reached its recipient.

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 payouts. 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.
Payout Batch IDOnly in Get, and required there. The batch identifier PayPal returned when the payout was created.
Sender Batch IDOnly in Create, and required there. Your own identifier for the payout, different every time, for example commissions-2026-10-ana. PayPal does not accept two payouts with the same one, which prevents paying the same thing twice.
Email SubjectOnly in Create. The subject of the email PayPal sends to notify the recipient.
Recipient EmailOnly in Create, and required there. The email of the PayPal account that receives the money. In Sandbox, use one of PayPal’s personal test accounts.
AmountOnly in Create, and required there. The amount with decimals, for example 10.50.
CurrencyOnly in Create. The payout’s currency, such as EUR or USD. Defaults to USD.
NoteOnly in Create. A message for the recipient. Optional.

Operations

  • Create: sends the amount to the recipient’s PayPal account.
  • Get: returns the status of the batch and its payout.

Output

The Data output returns the batch: its identifier (Payout Batch ID), status, your Sender Batch ID, amount, currency, PayPal’s fee, and the creation and completion dates. In Get, there is one item per payout in the batch, with the payout’s identifier, status, recipient and amount.

Each payout’s identifier is what PayPal Payout Item uses to look it up or cancel it. 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 course platform pays its teachers their share of sales every month.

  1. The flow reads each teacher’s PayPal email and monthly amount from a spreadsheet.
  2. For each teacher, add PayPal Payout with Operation set to Create.
  3. Put an identifier with the month and the teacher in Sender Batch ID, their email in Recipient Email, their amount in Amount, Currency set to EUR and “Your October payout” in Email Subject.
  4. Store the returned Payout Batch ID in the same sheet so you can check it later.

Good practices

  • Test your flows with a Sandbox credential before you use a Live one: money sent in Live is real.
  • Build the Sender Batch ID from details that identify the payment, such as the month and the recipient. If the flow runs again by mistake, PayPal rejects the duplicate payout.