---
title: "GET /api/v1.0/{appId}/payouts"
method: GET
path: "/api/v1.0/{appId}/payouts"
tags: ["Payouts"]
---

# GET /api/v1.0/{appId}/payouts

`GET /api/v1.0/{appId}/payouts`

## Path parameters

- `appId` string, required

## Query parameters

- `startDate` string, date-time
- `endDate` string, date-time
- `page` integer
- `limit` integer
- `payoutRequestIds.bankAccountIds` integer[]
- `payoutRequestIds.states` string[]

## Response `200`

OK

- RestApiPaginationResultPayout — Rest api pagination result
  - `Page` integer, required — Current page index
  - `Limit` integer, required — Current page size
  - `TotalRecordCount` integer, required — Total record count
  - `Data` Payout[], required — Generic data object.
    - `PayoutId` integer — The id of the payout.
    - `PayeeBankAccountId` 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
    - `Amount` number, double — Payout amount
    - `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
    - `CutoffDate` string, date-time — Payouts before this date do not have a details breakdown
    - `OnlineSalesAmount` number, double — Payout online sales amount
    - `OnlineSalesDeliveryCharges` number, double — Payout online sales delivery charges
    - `OnlineSalesTips` number, double — Payout online sales tips
    - `OnlineSalesServiceCharges` number, double — Payout online sales service charges
    - `OnlineSalesRefundedFees` number, double — Payout online sales refunded fees
    - `OnlineSalesFees` number, double — Payout online sales fees
    - `PosSalesFees` number, double — Payout online sales fees
    - `OnlineSalesRefundedAmount` number, double — Payout online sales refunded amount
    - `PosSalesRefundedAmount` number, double — POS Payout online sales refunded amount
    - `OnlineSalesTax` number, double — Payout online sales tax
    - `TotalOnlineRevenue` number, double — Payout total online revenue
    - `CashSalesFees` number, double — Payout cash sales fees
    - `CashSalesRefundedFees` number, double — Payout cash sales refunded fees
    - `CustomerCashFees` number, double — Payout cash fees charged to customer
    - `SalesFeesVat` number, double — Payout sales fees vat
    - `TotalFees` number, double — Payout total fees
    - `TotalOnlineRevenueAdjustments` number, double — Payout total online revenue adjustments
    - `ChargebackAmount` number, double — Payout chargeback amount
    - `PosSalesChargebackAmount` number, double — POS Payout chargeback amount
    - `ChargebackRefundedFees` number, double — Payout chargeback refunded fees
    - `TotalChargebackCost` number, double — Payout chargebacks total cost
    - `TotalOtherCharges` number, double — Payout other charges total
    - `OpeningBalance` number, double — Payout opening balance
    - `ClosingBalance` number, double — Payout closing balance
    - `PayGreenSalesAmount` number, double, nullable — Amount of sales through PayGreen (restaurant vouchers)
    - `DeliveryIntegrationFee` number, double — Third party integration delivery fee
    - `DeliveryIntegrationTipFee` number, double — Third party integration delivery tip fee
    - `TotalThirdPartyFees` number, double — Total third party integration fees
    - `PosSalesAmount` number, double — POS sales amount
    - `PosSalesTax` number, double — POS sales tax
    - `TipsOnPosSales` number, double — Tips on POS sales
    - `BankAccountHasChanged` boolean — Indicates whether the bank account has changed since the previous payout

## 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.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)