Methods
| Method | Description |
|---|---|
create(request) | Create a new payout |
Create a payout
Request fields
| Field | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Amount in smallest currency unit |
currency | string | Yes | Currency code (from supported currency enum) |
destination | object | Yes | Destination details |
destination.customer_id | string | Yes | Customer receiving the payout |
destination.payment_method_id | string | Yes | Payment method to pay out to |
metadata | Record<string, any> | No | Custom metadata |
Response data
| Field | Type | Description |
|---|---|---|
id | string | Payout ID |
amount | number | Payout amount |
currency | string | Currency code |
status | string | Payout status |
destination | object | Destination details |
created_at | string | ISO timestamp |
updated_at | string | ISO timestamp |