Skip to main content
A payout sends money out of your project to a recipient. Payment intents bring money in. Payouts are a separate resource with their own endpoint set and lifecycle. Amounts work exactly as they do on a payment: amount is in major units, so 50 means 50.00. See API conventions.

​
Lifecycle

There is no automatic retry. A failed payout is final. Create a new payout if you need to retry. There is no cancelled or reversed status.

​
Verifying a payout

Webhooks are the primary signal. Orchestrate delivers payout.initiated, payout.completed and payout.failed to your project’s configured endpoints. See Webhooks for payload details and signing. To read the current state of a payout at any time:
To force Orchestrate to re-check the payout status with the provider before returning:
The sync endpoint contacts the provider, updates the payout if the status has changed, and returns the refreshed payout in data.

​
Raw provider record

For support and debugging, fetch the verbatim record the provider returned:
The data object contains: This endpoint is not intended for business logic — it is a diagnostic tool.

​
Listing payouts

Available query parameters: Responses use cursor-based pagination. See API conventions for how to navigate next_cursor and prev_cursor.

​
Available payout methods

Which methods you can pay out to depends on your project’s gateway configuration. Check your dashboard to see the method codes available and the instrument type each method requires.