 (1) (1)-nobg.svg?dpl=dpl_p5zuruSp6XXCSM585kX47x2KwV5k){kind=small}
Payouts
Send money to bank accounts and cards.
Overview
The Payouts API allows you to send money to external bank accounts, cards, or wallets. This is useful for marketplace payouts, refunds to original payment methods, or any scenario where you need to disburse funds.
Payout types supported:
- Card - Send to debit or credit cards
- Bank - Send to bank accounts via ACH, wire, or local rails
- Wallet - Send to digital wallets
Payout Object
Payout Objectjson
{
"payout_id": "po_1234567890abcdef",
"merchant_id": "mer_xyz789",
"customer_id": "cus_abc123",
"status": "success",
"amount": 10000,
"currency": "USD",
"payout_type": "bank",
"priority": "regular",
"email": "recipient@example.com",
"name": "John Doe",
"phone": "+1234567890",
"error_message": null,
"error_code": null,
"billing": {
"address": {
"line1": "123 Main St",
"city": "San Francisco",
"state": "CA",
"postal_code": "94102",
"country": "US"
}
},
"metadata": {},
"created": "2024-01-15T10:00:00Z"
}API Endpoints
Payout Status
A payout progresses through several statuses:
| Status | Description |
|---|---|
requires_creation | Payout needs to be created with the processor |
requires_fulfillment | Payout created, waiting for fulfillment confirmation |
pending | Payout is being processed |
success | Payout completed successfully |
failed | Payout failed (check error details) |
cancelled | Payout was cancelled |
reversed | Payout was reversed after completion |
expired | Payout expired before completion |
Payout Priority
Control how quickly funds are delivered:
| Priority | Description |
|---|---|
instant | Immediate delivery (where supported) |
fast | Same-day or next-day delivery |
regular | Standard processing time (1-3 business days) |
wire | Wire transfer (typically same-day for domestic) |
Processor Support
Available payout methods and priorities depend on your enabled processor and the destination country. Check your processor documentation for specific capabilities.