FoyerDevelopers

Generated · Live registry

payouts tools

2 tools in this domain, generated from the running registry.

All tool domains

payouts.detail

read-only

What one payout consists of: the guest payments and refunds in it (with stay, room and guest where known), Stripe fees and the reconciliation to the paid-out amount. Payout id from `payouts.list`. Owner only. Read-only.

Input parameters

FieldTypeRequiredNotes
payoutIdstringyes

Output fields

FieldTypeRequiredNotes
payoutIdstringyes
paymentsarray of objectyes
payments.kindenumyespayment = Zahlung (charge/payment), refund = Erstattung (negativer Betrag). — One of: payment, refund
payments.chargeIdstringyesCharge-/Refund-ID der Quelle (Fallback: txn_…).
payments.paymentIntentIdstring · nullableyes
payments.amountCentsintegeryesBrutto, bei Erstattungen negativ.
payments.feeCentsintegeryesStripe-Gebühr dieser Buchung.
payments.currencystringyes
payments.createdstringyesISO-8601-Zeitstempel.
payments.stayobject · nullableyes
otherarray of objectyes
other.typestringyesStripe-Balance-Transaction-Typ, z. B. adjustment.
other.countintegeryes
other.amountCentsintegeryesSumme der Brutto-Beträge dieses Typs.
totalsobjectyes
totals.currencystringyes
totals.paymentsCentsintegeryes
totals.refundsCentsintegeryes
totals.otherCentsintegeryes
totals.feesCentsintegeryesSumme aller Stripe-Gebühren (positiv).
totals.netCentsintegeryesPayments + Refunds + Sonstiges − Gebühren.
totals.payoutAmountCentsintegeryes
totals.differenceCentsintegeryesAuszahlungsbetrag − netCents.
transactionCountintegeryes
truncatedbooleanyestrue, wenn die Seitengrenze erreicht wurde.

payouts.list

read-only

Stripe payouts of direct bookings to the property's bank account, newest first (amount, status, arrival date). `connected: false` if no Stripe account is linked. Paginate with `cursor` = `nextCursor`. Owner only. Read-only — moves no money.

Input parameters

FieldTypeRequiredNotes
cursorstringno
limitintegerno

Output fields

FieldTypeRequiredNotes
connectedbooleanyes
onboardedbooleanyes
payoutsarray of objectyes
payouts.idstringyes
payouts.amountCentsintegeryes
payouts.currencystringyes
payouts.statusstringyes
payouts.arrivalDatestringyesISO-Datum, "YYYY-MM-DD".
payouts.createdstringyesISO-8601-Zeitstempel.
payouts.methodstring · nullableyes
payouts.descriptionstring · nullableyes
nextCursorstring · nullableyes