Skip to content
Nappai Documentation

PayPal Payout Item

PayPal Payout Item works with a single payout inside a PayPal batch: it checks its status or cancels it. Every payout you make with PayPal Payout has its own identifier, and that is the one this component uses.

When to use it

  • You want to know whether the recipient has received their money.
  • You sent money to the wrong email and the recipient has not claimed it yet.
  • You want to record the final status of each payout in your payments sheet.

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: Cancel or Get. Defaults to Get. See Operations.
Payout Item ID (required)The payout’s identifier, the one PayPal Payout returns for each payout in the batch.

Operations

  • Cancel: cancels a payout the recipient has not claimed yet. The money returns to your account.
  • Get: returns the payout’s status and details.

Output

The Data output returns one item with the payout’s details, including its identifier, status, recipient and amount.

You can connect it to a condition that checks the status or to your payments sheet. The component can also be connected to an Agent as a tool, so the agent decides when to use it. See Tool Mode.

Example

The finance team reviews the week’s commission payouts every Friday.

  1. The flow reads the identifiers of the week’s payouts from the payments sheet.
  2. For each one, add PayPal Payout Item with Operation set to Get and pass the identifier to Payout Item ID.
  3. Write the returned status in the sheet.
  4. If a payout is still unclaimed, the team can decide to cancel it with Operation set to Cancel.