--- title: "GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}" method: GET path: "/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}" tags: ["Payouts"] --- # GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId} `GET /api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}` ## Request - Base URL: `https://api.flipdish.co` - URL: `https://api.flipdish.co/api/v1.0/{appId}/bankaccounts/{bankAccountId}/payouts/{payoutId}` - Auth: OAuth 2 (implicit, authorization URL `https://api.flipdish.co/identity/connect/authorize`, scopes: `api`) ## Path parameters - `appId` string, required - `bankAccountId` integer, required - `payoutId` integer, required ## Response `200` OK - PayoutDetail: Holds the information for a whitelabel payout with details broken down by Store - `PayoutId` integer: The id of the payout. - `BankAccountId` integer: Bank account identifier - `AccountName` string: Account name of the payout destination - `PayoutStatus` 'Pending' | 'InTransit' | 'Paid' | 'Failed' | 'Cancelled': Status of the payout - `CreatedDate` string, date-time: Date payout was created - `PeriodStartTime` string, date-time: This payout includes operations after at this date (inclusive) - `PeriodEndTime` string, date-time: This payout includes operations before at this date (exclusive) - `DestinationBank` string: Destination bank name - `DestinationAccount` string: Last 4 digits of the destination bank IBAN - `PayoutType` 'Internal' | 'Stripe': Type of payout source - `Currency` 'EUR' | 'USD' | 'GBP' | 'CAD' | 'AUD' | 'DJF' | 'ZAR' | 'ETB' | 'AED' | 'BHD' | 'DZD' | 'EGP' | 'IQD' | 'JOD' | 'KWD' | 'LBP' | 'LYD' | 'MAD' | 'OMR' | 'QAR' | 'SAR' | 'SYP' | 'TND' | 'YER' | 'CLP' | 'INR' | 'AZN' | 'RUB' | 'BYN' | 'BGN' | 'NGN' | 'BDT' | 'CNY' | 'BAM' | 'CZK' | 'DKK' | 'CHF' | 'MVR' | 'BTN' | 'XCD' | 'BZD' | 'HKD' | 'IDR' | 'JMD' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'TTD' | 'XDR' | 'ARS' | 'BOB' | 'COP' | 'CRC' | 'CUP' | 'DOP' | 'GTQ' | 'HNL' | 'MXN' | 'NIO' | 'PAB' | 'PEN' | 'PYG' | 'UYU' | 'VEF' | 'IRR' | 'XOF' | 'CDF' | 'XAF' | 'HTG' | 'ILS' | 'HRK' | 'HUF' | 'AMD' | 'ISK' | 'JPY' | 'GEL' | 'KZT' | 'KHR' | 'KRW' | 'KGS' | 'LAK' | 'MKD' | 'MNT' | 'BND' | 'MMK' | 'NOK' | 'NPR' | 'PKR' | 'PLN' | 'AFN' | 'BRL' | 'MDL' | 'RON' | 'RWF' | 'SEK' | 'LKR' | 'SOS' | 'ALL' | 'RSD' | 'KES' | 'TJS' | 'THB' | 'ERN' | 'TMT' | 'BWP' | 'TRY' | 'UAH' | 'UZS' | 'VND' | 'MOP' | 'TWD' | 'BMD': Payout currency - `PayoutStores` PayoutStore[]: Payout information broken down by Store - `StoreId` integer: The id of the Store. - `StoreName` string: Name of the store - `Amount` number, double, nullable: Amount of the payout for this Store - `OnlineRevenue` RevenueDetail: Sales information - `OnlineSalesAmount` number, double: Online sales amount - `OnlineSalesTax` number, double: Online sales tax - `OnlineSalesIncludingTax` number, double: Online sales amount plus online sales tax - `OnlineSalesFeesBaseAmount` number, double: Online sales base amount to calculate fees - `CashSalesAmount` number, double: Cash sales amount - `CashSalesTax` number, double: Cash sales tax - `CashSalesIncludingTax` number, double: Cash sales amount plus online sales tax - `CashSalesFeesBaseAmount` number, double: Online sales base amount to calculate fees - `TotalSalesIncludingTax` number, double: Total Sales (online and cash) including tax - `OnlineSalesDeliveryCharges` number, double: Delivery charges on online sales - `OnlineSalesTips` number, double: Tips for online sales - `TotalOnlineRevenue` number, double: Online sales plus online delivery charges and tips - `OnlineSalesServiceCharges` number, double: Service charge on online sales - `Revenue` RevenueDetail: Sales information - `OnlineSalesAmount` number, double: Online sales amount - `OnlineSalesTax` number, double: Online sales tax - `OnlineSalesIncludingTax` number, double: Online sales amount plus online sales tax - `OnlineSalesFeesBaseAmount` number, double: Online sales base amount to calculate fees - `CashSalesAmount` number, double: Cash sales amount - `CashSalesTax` number, double: Cash sales tax - `CashSalesIncludingTax` number, double: Cash sales amount plus online sales tax - `CashSalesFeesBaseAmount` number, double: Online sales base amount to calculate fees - `TotalSalesIncludingTax` number, double: Total Sales (online and cash) including tax - `OnlineSalesDeliveryCharges` number, double: Delivery charges on online sales - `OnlineSalesTips` number, double: Tips for online sales - `TotalOnlineRevenue` number, double: Online sales plus online delivery charges and tips - `OnlineSalesServiceCharges` number, double: Service charge on online sales - `RevenueAdjustments` RevenueAdjustmentsDetails: Revenue Adjustments breakdown - `OnlineSalesRefundedAmount` number, double: Online sales refunds - `PosSalesRefundedAmount` number, double: POS Online sales refunds - `CashSalesRefundedAmount` number, double: Cash sales refunds - `CustomerCashFees` number, double: Customer cash fees - `RefundsCount` integer: Number of refunds - `PayGreenSalesAmount` number, double, nullable: PayGreen sales - `PayGreenProcessingFees` number, double, nullable: PayGreen processing fees charged to end-user - `TotalOnlineRevenueAdjustments` number, double: Total revenue adjustments - `FlipdishFees` FlipdishFeesDetails: Fees breakdown - `OnlineSalesFees` number, double: Fees on online sales - `CashSalesFees` number, double: Fees on cash sales - `PosSalesFees` number, double: Fees of POS sales - `TotalSalesFees` number, double: Total online and cash sales - `OnlineSalesRefundedFees` number, double: Fees on refunds for online sales - `CashSalesRefundedFees` number, double: Fees on refunds for cash sales - `PosSalesRefundedFees` number, double: Fees on refunds for POS sales - `SalesFeesVat` number, double: VAT on sales fees - `TotalFees` number, double: Total fees - `Chargebacks` ChargebackDetails: Chargebacks breakdown - `ChargebackAmount` number, double: Chargeback amount - `PosSalesChargebackAmount` number, double: POS Chargeback amount - `ChargebackRefundedFees` number, double: Chargeback refunded feeds - `ChargebacksCount` integer: Number of chargebacks - `TotalChargebackCost` number, double: Total amount - `OtherCharges` OtherChargesDetails: Breakdown of other charges - `TotalOtherCharges` number, double: Total amount of other charges - `ChargesCount` integer: Number of other charges - `Balance` BalanceDetails: Period opening and closing balance - `OpeningBalance` number, double: OpeningBalance. - `ClosingBalance` number, double: ClosingBalance. - `PosRevenue` PosRevenueDetails: Breakdown of POS charges - `PosSalesAmount` number, double: POS sale amount for the store - `PosSalesTax` number, double: POS sale Tax for the store - `PosSalesTips` number, double: POS sale tips for the store - `TotalPosRevenue` number, double: POS Total Revenue for the store - `ThirdPartyFees` ThirdPartyFeesDetails: Breakdown of third party integration fees - `DeliveryIntegrationFee` number, double: Third party integration delivery fee - `DeliveryTipFee` number, double: Third party integration delivery tip fee - `TotalThirdPartyFees` number, double: Total third party integration fees - `Amount` number, double: Payout amount - `CutoffDate` string, date-time: Payouts before this date do not have a details breakdown ## Other responses - `400`: BadRequest - `401`: Authentication has been denied for this request. - `403`: Successful authentication, but authorization has been denied for this request. --- [API](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc.dev/flipdish/apis/flipdish-open-api-v1-0/revisions/4d8c2b9e1c13?raw)