Payouts Overview
Description
The Payouts API group enables businesses to distribute funds to external addresses using stablecoins like USDC and USDT. It supports manual and scheduled payouts across multiple blockchains, providing real-time status tracking and flexible workflows, ideal for payroll, vendor payments, or DeFi distributions.
API Endpoints
- Create Payout: Creates a new payout request to a specified destination address.
- Get Payout: Retrieves details of a specific payout by its ID.
- List Payouts: Returns a paginated list of payouts.
API Endpoint Reference
| Method | Endpoint | Description |
|---|---|---|
| POST | /v1/payouts | Creates a new payout to a destination address. |
| GET | /v1/payouts/:id | Retrieves details of a specific payout. |
| GET | /v1/payouts?offset=0&limit=10 | Lists payouts with pagination. |
Attributes
| Attribute | Type | Description |
|---|---|---|
id | string | Unique identifier for the payout (e.g., pout_t24cg6MLdv1PgUiO). |
account_id | string | ID of the account associated with the payout. |
chain | string | Blockchain chain used (e.g., base). |
amount | string | Total amount to be paid out (e.g., 5.0). |
currency | string | Currency of the transaction (e.g., USDC). |
destination_address | string | Destination address for the payout (e.g., 0xB3906750209897ee480AcfA6cE64538ED0dB5A42). |
metadata | object or null | Additional metadata, if provided. |
status | string | Current status of the payout (e.g., pending). |
payout_type | string | Type of payout (e.g., manual). |
requires_approval | integer | Indicates if approval is required (e.g., 0 for false). |
tx_hash | string or null | Transaction hash, if available. |
error_message | string or null | Error message, if the payout failed. |
created_at | timestamp | Time when the payout was created. |
updated_at | timestamp | Time when the payout was last updated. |
Status Enum
The status field indicates the current state of the payout. Possible values are:
pending: The payout is awaiting processing.pending_approval: The payout requires approval before processing.succeeded: The payout has been successfully completed.failed: The payout failed due to an error.