Skip to main content
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 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

​
Payout Attributes

PropertyTypeDescription
rootfi_idintegerUnique identifier for this payout
rootfi_created_atstringWhen this payout was created in Commenda’s system (ISO 8601)
rootfi_updated_atstringWhen this payout was last updated (ISO 8601)
rootfi_company_idintegerCompany identifier this payout belongs to
platform_idstringPlatform-specific payout identifier
gateway_account_idstringPayment gateway account identifier
amountnumberPayout amount
currency_idstringISO 4217 currency code
statusenumCurrent payout status
scheduleenumPayout schedule type
typeenumDestination account type
methodstringPayout method details
arrival_datestringDate funds will arrive in merchant account (ISO 8601)
gatewaystringPayment gateway name
destinationobjectBank account details
transaction_idsarrayTransactions included in this payout
created_atstringOriginal creation timestamp (ISO 8601)
updated_atstringLast update timestamp (ISO 8601)

​
Status Enum Values

ValueDescription
pendingPayout is scheduled but not yet sent
in_transitPayout has been initiated
paidFunds have been delivered
cancelledPayout was cancelled
failedPayout failed to process
unknownStatus cannot be determined

​
Schedule Enum Values

ValueDescription
manualManually initiated payout
automaticAutomatically scheduled payout
unknownSchedule type unknown

​
Type Enum Values

ValueDescription
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
{
  "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"
}