Payouts ​
A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.
Related guide: Receiving payouts
Endpoints ​
Create a payout ​
- POST /v1/payouts
Update a payout ​
- POST /v1/payouts/:id
Retrieve a payout ​
- GET /v1/payouts/:id
List all payouts ​
- GET /v1/payouts
Cancel a payout ​
- POST /v1/payouts/:id/cancel
Reverse a payout ​
- POST /v1/payouts/:id/reverse
Events ​
payout.canceledOccurs whenever a payout is canceled.payout.createdOccurs whenever a payout is created.payout.failedOccurs whenever a payout attempt fails.payout.paidOccurs whenever a payout is expected to be available in the destination account. If the payout fails, apayout.failednotification is also sent, at a later time.payout.reconciliation_completedOccurs whenever balance transactions paid out in an automatic payout can be queried.payout.updatedOccurs whenever a payout is updated.