Documentation Index Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
The Payout Data Model represents a transfer of funds from the payment platform to the merchant’s bank account. Payouts aggregate multiple transactions into a single transfer.
Fund transfers : Track money moving from payment platform to bank accountTransaction aggregation : Link payouts to the transactions they includeArrival tracking : Monitor expected and actual fund arrival datesMultiple payout types : Support for bank account, card, and other payout methods
Attributes Payout 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_company_id integer Company identifier this payout belongs to platform_id string Platform-specific payout identifier gateway_account_id string Payment gateway account identifier amount number Payout amount currency_id string 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 PENDINGPayout is scheduled but not yet sent IN_TRANSITPayout has been initiated PAIDFunds have been delivered CANCELEDPayout was canceled FAILEDPayout failed to process UNKNOWNStatus cannot be determined
Schedule Enum Values Value Description MANUALManually initiated payout AUTOMATICAutomatically scheduled payout UNKNOWNSchedule type unknown
Type Enum Values Value Description BANK_ACCOUNTPayout to bank account CARDPayout to debit card FPXFPX payment method UNKNOWNDestination type unknown
Expandable Attributes Use the expand query parameter to include related objects:
expand=transactions - Includes all Transaction objects in the payout
The Payout Response Object
{ "rootfi_id" : 5001 , "rootfi_created_at" : "2025-01-15T00:00:00Z" , "rootfi_updated_at" : "2025-01-16T10:00:00Z" , "rootfi_company_id" : 999 , "platform_id" : "po_stripe_001" , "gateway_account_id" : "acct_stripe_123" , "amount" : 5000.00 , "currency_id" : "USD" , "status" : "PAID" , "schedule" : "AUTOMATIC" , "type" : "BANK_ACCOUNT" , "method" : "standard" , "arrival_date" : "2025-01-16T00:00:00Z" , "gateway" : "stripe" , "destination" : { "bank_name" : "Chase" , "last4" : "1234" , "routing_number" : "021000021" }, "transaction_ids" : [ "txn_9001" , "txn_9002" , "txn_9003" ], "created_at" : "2025-01-15T00:00:00Z" , "updated_at" : "2025-01-16T10:00:00Z" }
