Payouts API
See the Payouts guide for a conceptual overview.
Create a Payout
POST /v1/payouts
curl https://api.meridian.dev/v1/payouts \
-u sk_test_4eC39HqL...: \
-d amount=10000 \
-d currency=usd
| Parameter | Type | Description |
|---|---|---|
amount required | integer | Amount in cents to pay out. |
currency required | string | Must match your default settlement currency. |
destination | string | External account ID. Defaults to your default bank account. |
method | string | standard or instant. Default: standard. |
Retrieve a Payout
GET /v1/payouts/:id
Cancel a Payout
POST /v1/payouts/:id/cancel
Only payouts with status: pending can be canceled.
curl -X POST https://api.meridian.dev/v1/payouts/po_PayoutId/cancel \
-u sk_test_4eC39HqL...:
List all Payouts
GET /v1/payouts
curl "https://api.meridian.dev/v1/payouts?status=paid&limit=10" \
-u sk_test_4eC39HqL...: