Payout data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

Data Model
FieldTypeRequiredDescription
idstringNo
created_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstringNo(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
total_amountnumberNo
currencystringNo
notesstringNo
statusenumNoValues: SUCCEEDED, PENDING, FAILED, CANCELED
arrival_atstring (date-time)NoDate the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
fee_amountnumberNoProcessor fee deducted from the payout
net_amountnumberNototal_amount minus fee_amount
account_idstringNoref -> AccountingAccount; the destination account (reference to AccountingAccount)
lineitemsPaymentPayoutLineitem[]NoThe transactions included in this payout
lineitems[].object_typeenumNoWhat this payout line settles Values: PAYMENT, REFUND, FEE, ADJUSTMENT, TRANSFER, OTHER
lineitems[].object_idstringNoid of the settled object -- a PaymentPayment or PaymentRefund for PAYMENT / REFUND lines
lineitems[].amountnumberNoGross amount of this line
lineitems[].currencystringNoISO 4217 currency code of the line amount
lineitems[].fee_amountnumberNoProcessor fee attributed to this line
lineitems[].net_amountnumberNoamount minus fee_amount

TypeScript

TypeScript
export type PaymentPayout = {
	id?: string;
	created_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	total_amount?: number;
	currency?: string;
	notes?: string;
	status?: 'SUCCEEDED' | 'PENDING' | 'FAILED' | 'CANCELED';
	arrival_at?: string-time; // Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	fee_amount?: number; // Processor fee deducted from the payout
	net_amount?: number; // total_amount minus fee_amount
	account_id?: string; // ref -> AccountingAccount; the destination account (reference to AccountingAccount)
	lineitems?: []; // The transactions included in this payout
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodPaymentPayout = z.object({
	id: z.string().optional(),
	created_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	total_amount: z.number().optional(),
	currency: z.string().optional(),
	notes: z.string().optional(),
	status: z.enum("SUCCEEDED", "PENDING", "FAILED", "CANCELED").optional(),
	arrival_at: z.string-time().optional().describe("Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	fee_amount: z.number().optional().describe("Processor fee deducted from the payout"),
	net_amount: z.number().optional().describe("total_amount minus fee_amount"),
	account_id: z.string().optional().describe("ref -> AccountingAccount; the destination account (reference to AccountingAccount)"),
	lineitems: z.array().optional().describe("The transactions included in this payout"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PaymentPayoutStatus(str, Enum):
	SUCCEEDED = 'SUCCEEDED'
	PENDING = 'PENDING'
	FAILED = 'FAILED'
	CANCELED = 'CANCELED'

@dataclasses.dataclass
class PaymentPayout:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	total_amount: Optional[int]
	currency: Optional[str]
	notes: Optional[str]
	status: Optional[PaymentPayoutStatus]
	"""Date the funds land in the destination account (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	arrival_at: Optional[str]
	"""Processor fee deducted from the payout"""
	fee_amount: Optional[int]
	"""total_amount minus fee_amount"""
	net_amount: Optional[int]
	"""ref -> AccountingAccount; the destination account (reference to AccountingAccount)"""
	account_id: Optional[str]
	"""The transactions included in this payout"""
	lineitems: Optional[PropertyPaymentPayoutLineitems]
Are we missing anything? Let us know
Was this page helpful?