- Fund transfers: Track money moving from payment platform to bank account
- Transaction aggregation: Link payouts to the transactions they include
- Arrival tracking: Monitor expected and actual fund arrival dates
- Multiple payout types: Support for bank account, card, and other payout methods
Attributes
Payouts Attributes
| Property | Type | Description |
|---|---|---|
rootfi_id | integer | Unique identifier for this payout |
rootfi_created_at | string | When this payout was created in Commenda’s system (ISO 8601) |
rootfi_updated_at | string | When this payout was last updated (ISO 8601) |
rootfi_integration_type | enum | |
platform_id | string | Platform-specific payout identifier |
gateway_account_id | string | Payment gateway account identifier |
amount | double | Payout amount |
currency_id | enum | ISO 4217 currency code |
status | enum | Current payout status |
schedule | enum | Payout schedule type |
type | enum | Destination account type |
method | string | Payout method details |
arrival_date | string | Date funds will arrive in merchant account (ISO 8601) |
gateway | string | Payment gateway name |
destination | object | Bank account details |
transaction_ids | array | Transactions included in this payout |
created_at | string | Original creation timestamp (ISO 8601) |
updated_at | string | Last update timestamp (ISO 8601) |
Status Enum Values
| Value | Description |
|---|---|
PENDING | Payout is scheduled but not yet sent |
IN_TRANSIT | Payout has been initiated |
PAID | Funds have been delivered |
CANCELED | Payout was canceled |
FAILED | Payout failed to process |
UNKNOWN | Status cannot be determined |
Schedule Enum Values
| Value | Description |
|---|---|
MANUAL | Manually initiated payout |
AUTOMATIC | Automatically scheduled payout |
UNKNOWN | Schedule type unknown |
Type Enum Values
| Value | Description |
|---|---|
BANK_ACCOUNT | Payout to bank account |
CARD | Payout to debit card |
FPX | FPX payment method |
UNKNOWN | Destination type unknown |