Returns the user's channel payouts, a page at a time: one per transfer a channel sent to their bank, with every row it is made of (bookings, adjustments, resolutions), so you can match each bank deposit to the bookings behind it. Airbnb only for now. Requires the ownerStatements:read scope.
Host Tools reads payouts from Airbnb once a day, so a payout appears up to a day after Airbnb releases it. Payouts go back to Host Tools' first read of the account's payouts, which reaches at most 60 days back; older payouts aren't returned.
Airbnb doesn't let some accounts read their payouts, so far only ones connected in setup mode (fullAccess: false in Get Accounts). Such an account has no payouts here, and Get Errors lists a payouts.unavailable error for it until Host Tools can read them.
Send either a date range or updatedSince:
startDateandendDatereturn the payouts dated in the range, oldest first.statusnarrows them to paid or pending ones,accountIDto one account's andchannelto one channel's.updatedSincereturns every payout written at or after that time, whatever its date, oldest change first. A pending payout that has gone comes back once more, withdeletedAt, so a copy you keep can drop it. Use it to keep a copy in sync instead of reading every range again: save the time just before each call, minus a minute for clock differences, and pass it asupdatedSinceon the next call. It takes no other filter. A payout written again while you page moves to a later page, so it is read again rather than missed. A read can return a payout you already have, so keep payouts by_id: a second copy replaces the first. There's no webhook for payouts yet, so poll withupdatedSinceto pick up changes.
Amounts are numbers in the payout's currency, and each row has its own currency.
dateis Airbnb's release date. The money reaches the bank a few days later, depending on the payout method.- A
pendingpayout is an estimate of what Airbnb will pay out ondate, made from its upcoming rows. It has noreference, and it can disappear: once Airbnb pays it, it is replaced by a newpaidpayout with its own_id, and a cancelled booking drops it. Match bank deposits topaidpayouts only. - A paid payout's rows add up exactly to its
amount, with two exceptions. Airbnb can convert a payout into the bank account's currency (THB bookings paid into a USD account): its rows then keep their own currency and amounts, so only the payout'samountmatches the bank deposit. And an Airbnb Fast Pay payout to a debit card (payoutMethod: debitCard) arrives short by Airbnb's Fast Pay fee, which has no row of its own:fastPayFeegives it, and the rows add up toamountplusfastPayFee. A debit-card payout without Fast Pay adds up and has nofastPayFee. Host Tools gives the fee only when the difference is exactly 1.5% of the rows, rounded to the cent, on a USD payout, as on every Fast Pay payout seen so far. Airbnb caps the fee at $15, and a payout short by any other amount, a capped fee or another currency included, has nofastPayFee.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
403The OAuth token doesn't have the ownerStatements:read scope
429Too many requests