Get payout status
Retrieve the current status of a PayPal or Venmo payout.
/api/Integration/v2/payout/status/{weblink}Call this endpoint after Redeem payout returns isProcessing: true or whenever your system needs the latest payout outcome.
Get payout status returns the current normalized payout status for the weblink token. Use it when Redeem payout returns 202 Accepted or when you need to confirm whether a payout has completed, failed, or moved into another terminal state.
The endpoint uses the same Basic Auth and ownership rules as Redeem payout. Only the client that owns the underlying order can check the payout status.
This endpoint requires Basic Auth using your API credentials.
Path parameter
Use the same encoded weblink token that you used to redeem the payout.
| Parameter | Type | Required | Description |
|---|---|---|---|
weblink | string | Yes | Encrypted payout weblink token extracted from items[].cards[].cardCode for an eligible payout product. |
Successful response
The response includes Bamboo and PayPal identifiers plus a normalized payout status.
200 OK
{
"transactionId": "fc894d78-e978-46c0-0748-08ded1b0af32",
"payoutBatchId": "DZGTNDS9H3BWS",
"status": "Completed"
}| Field | Type | Description |
|---|---|---|
transactionId | string | Bamboo payout transaction identifier returned for this weblink. |
payoutBatchId | string | PayPal payout batch identifier. |
status | string | Normalized payout status: Pending, Completed, Unclaimed, Failed, Returned, or Reversed. |
Status lifecycle
Bamboo normalizes payout status values. Use the status to decide the next developer action.
Statuses and meanings
| Status | Meaning |
|---|---|
Pending | Payout accepted and still in progress, or an unrecognized in-flight state. |
Completed | Funds delivered to the recipient. |
Unclaimed | Recipient has no PayPal or Venmo account. They have about 30 days to register before funds are returned. |
Failed | Payout rejected because of an invalid account, compliance block, blocked recipient, denied batch, or canceled batch. |
Returned | Unclaimed payout returned to sender after the claim window expired. |
Reversed | Funds reversed or refunded by PayPal after being claimed. |
Recommended action
| Action | Statuses |
|---|---|
Check again while processing | Pending |
Treat as successful | Completed |
Notify or support the recipient | Unclaimed |
Investigate or stop fulfillment | Failed, Returned, Reversed |
Error responses
Get payout status returns generic errors when the weblink cannot be checked.
| Status | Body | Cause |
|---|---|---|
400 Bad Request | "Failed to retrieve payout status" | Weblink not found, wrong client ownership, or the weblink is not a payment link. |
401 Unauthorized | - | Missing or invalid Authorization header. |
Sandbox behavior
Sandbox payout status uses PayPal's sandbox environment. No real money is transferred, the response shape is the same, and phone-recipient payout testing may have limitations.
On this page
Try it out
Open the interactive API panel to test this endpoint with your own credentials.