Payouts
API ReferencePayouts
Payouts
Send money to your customers, vendors, or partners.
Overview
The Payouts API allows you to send funds to bank accounts and cards. Payouts are used for disbursements, refunds to non-original payment methods, vendor payments, and more.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /payouts/create | Create Payout |
GET | /payouts/:id | Retrieve Payout |
POST | /payouts/:id | Update Payout |
POST | /payouts/:id/cancel | Cancel Payout |
POST | /payouts/:id/fulfill | Fulfill Payout |
POST | /payouts/list | List Payouts |
Payout Status
| Status | Description |
|---|---|
requires_creation | Payout needs to be created |
requires_confirmation | Payout awaiting confirmation |
requires_fulfillment | Payout ready to be fulfilled |
pending | Payout is being processed |
success | Payout completed successfully |
failed | Payout failed |
cancelled | Payout was cancelled |
reversed | Payout was reversed |
expired | Payout expired |