Payouts
API ReferencePayoutsCreate
Create Payout
Create a new payout to send funds.
POST /payouts/create
Body Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | integer | Yes | The payout amount in the smallest currency unit. |
currency | string | Yes | The three-letter ISO 4217 currency code. |
customer_id | string | Yes | The customer receiving the payout. |
payout_type | string | Yes | Type of payout: "card" or "bank". |
description | string | No | Description of the payout. |
metadata | object | No | Set of key-value pairs for storing additional information. |
Request Example
curl -X POST 'https://api.v2.paychtec.com/payouts/create' \ -H "Content-Type: application/json" \ -H "api-key: snd_YOUR_API_KEY" \ -d '{ "amount": 5000, "currency": "USD", "customer_id": "cus_1234567890abcdef", "payout_type": "bank", "description": "Vendor payment"}'Response
{
"payout_id": "po_1234567890abcdef",
"amount": 5000,
"currency": "USD",
"customer_id": "cus_1234567890abcdef",
"payout_type": "bank",
"status": "requires_fulfillment",
"description": "Vendor payment",
"created": "2024-01-22T10:00:00Z"
}