Preview Waiting Payouts

POST /siren/v1/payouts/waiting-preview

Takes the obligations you’re about to fulfill and names each payout the fulfillment would leave waiting on its collaborator. It groups the obligations the way generating a fulfillment does, one payout per collaborator and currency, and lists each payout whose currency pays out through Stripe or PayPal while the collaborator has no Stripe account or no PayPal email. It creates and changes nothing. The “Generate Fulfillments” dialog calls it to show its warning, as Set Up Automatic Payouts describes. On WordPress, this route is coming in the next Siren plugin update.

Only approved obligations count, and a collaborator in the trash is left out, since generating the fulfillment leaves both out too. A currency counts only when its method is configured and in your plan. Store credit needs nothing from the collaborator, so it never appears. A collaborator who connected Stripe and hasn’t finished onboarding has an account, so this route doesn’t name them. Their payout waits once Siren tries to send it, with the waitingReason stripe_account_incomplete.

Request Body

Field	Type	Required	Description
`obligationIds`	integer[]	Yes	The obligations the fulfillment would be made from

Example

{
  "obligationIds": [101, 102, 107]
}

{
  "count": 1,
  "waiting": [
    {
      "collaboratorId": 42,
      "collaboratorName": "Casey Lee",
      "currency": "USD",
      "value": 5000,
      "method": "stripe"
    }
  ]
}

value is the payout’s total at the currency’s stored scale, so 5000 is $50.00. method is the payout method the collaborator still has to set up, stripe or paypal. When nothing would wait, count is 0 and waiting is empty.

Error Responses

Status	When
`400`	`obligationIds` is missing or isn’t an array, or one of its IDs isn’t an obligation the caller can reach
`400`	On WordPress, the caller can’t create fulfillments, with “You don’t have permission to do that.” Staff who can generate fulfillments, such as administrators and Platform Managers, can. Collaborators can’t
`500`	The obligations couldn’t be read. The message reads “Something went wrong.”, or “Something went wrong when checking the referenced records.” when the IDs couldn’t be checked

The caller needs permission to create fulfillments. Collaborators can’t call it. On Siren Cloud, Admins and Platform Managers can call it, and anyone else 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.