Retry Payout

POST /siren/v1/payouts/{id}/retry

Sends a failed automatic payout again, through the method set for its currency. Only a payout whose status is failed can be retried. Needs Siren Essentials and up.

Example Response

202 Accepted

{
  "id": 42,
  "status": "failed"
}

The returned status is the payout’s status at that moment. The attempt usually runs in the background, so it can still read failed or processing. On a site that runs background work in the same request, it can already read paid. Read the payout again in a moment to see paid, or failed with a new failureReason.

A retry changes nothing when the currency has no payout method, the collaborator is in the trash or deleted, or the plan doesn’t include the method. The payout stays failed with its earlier failureReason, and the route still answers 202.

Error Responses

Status	When
`400`	On WordPress, the caller can’t update payouts, with “You don’t have permission to do that.” Staff with payout permissions, such as administrators and Platform Managers, can. Collaborators can’t
`404`	No payout has that ID
`409`	The payout isn’t `failed`. The message reads “Only failed payouts can be retried.”

On Siren Cloud, a caller who can’t update payouts gets 403, or 401 when no credential was accepted. On a WordPress store connected to Siren Cloud, this route answers 409 with the code siren_managed_in_cloud, because payouts run in Siren Cloud.

To find failed payouts, list fulfillments with payoutStatus=failed. Set Up Automatic Payouts explains failures for store owners.