Skip to main content
View as Markdown

The BatchPayout object

Represents a batch payout with status and progress tracking.

note

13 of 13 fields on this object have no description yet. Field documentation lives in the SDK types (types/payout.ts) so it stays in one place — this page is generated from it.

Fields​

FieldTypeDescription
batchId
REQUIRED		string
status
REQUIRED		string
totalPayouts
REQUIRED		number
successfulPayouts
REQUIRED		number
failedPayouts
REQUIRED		number
pendingPayouts
REQUIRED		number
totalAmount
REQUIRED		number
currency
REQUIRED		string
estimatedFees
REQUIRED		number
totalDebitedAmount
REQUIRED		number
progressPercentage
REQUIRED		number
createdAt
REQUIRED		string
updatedAt
REQUIRED		string

Example​

{
  "batchId": "batch_1a2b3c",
  "status": "string",
  "totalPayouts": 5000,
  "successfulPayouts": 1,
  "failedPayouts": 1,
  "pendingPayouts": 1,
  "totalAmount": 5000,
  "currency": "USD",
  "estimatedFees": 5000,
  "totalDebitedAmount": 5000,
  "progressPercentage": 1,
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}