Actions35
- Payment Actions
- Customer Actions
- Invoice Actions
- Product Actions
- Price Actions
- Subscription Actions
- Payout Actions
- Balance Actions
Payment → Wait for a Payment
AI-generatedSummary
Polls a SouthPay payment status until it reaches a terminal state or the timeout expires.
Inputs
- paymentId (required) — Select a payment by ID or from the SouthPay list; required to identify the payment to monitor.
- pollInterval — Seconds between polling attempts (minimum 2, default 10).
- timeout — Maximum seconds to wait (default 600).
Output shape
a single item containing the payment record upon reaching a terminal status or timing out
The operation returns the payment object only when the status is in the terminal list: completed, overpaid, failed, expired, or refunded.
Examples
Example 1: Monitor a payment until it settles
Select a payment from the list, set a 30-second timeout, and 5-second poll interval.
Example 2: Wait for a refund confirmation
Select the refunded payment, keep default timeout, and poll every 10 seconds.