# List payouts

Returns the payouts Adfin has made to the bank account.

Endpoint: GET /payouts
Version: 1.0.0
Security: Biller Access Token (Production), Biller Access Token (Staging)

## Query parameters:

  - `status` (array)
    Only return payouts in these states. Repeat the parameter to name more than one, combined with OR. Omit it to return every state.
    Enum: "PROCESSING", "SENT", "FAILED", "RETURNED"

  - `minPayoutDate` (string)
    Only return payouts paid out on or after this date. Inclusive.
    Example: "2026-08-01"

  - `maxPayoutDate` (string)
    Only return payouts paid out on or before this date. Inclusive.
    Example: "2026-08-31"

  - `page` (integer)
    Which page to return, counting from one.
    Example: 1

  - `size` (integer)
    How many payouts to return per page. A request for more than the maximum is refused.
    Example: 50

  - `sort` (string)
    How to order the page.
    Enum: "payoutDate,desc", "payoutDate,asc"

## Response 200 fields (application/json):

  - `payouts` (array, required)
    The payouts

  - `payouts.id` (string, required)
    The id of the payout

  - `payouts.status` (string, required)
    The status of the payout
    Enum: "PROCESSING", "SENT", "FAILED", "RETURNED"

  - `payouts.totalAmount` (number, required)
    The total amount of the payout

  - `payouts.currencyCode` (string, required)
    The currency of the payout
    Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHF", "CLP", "CNY", "COP", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GGP", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IMP", "INR", "IQD", "IRR", "ISK", "JEP", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SPL", "SRD", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TVD", "TWD", "TZS", "UAH", "UGX", "USD", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "YER", "ZAR", "ZMW", "ZWD"

  - `payouts.payoutDate` (string, required)
    The working day the money is paid out to the bank account. This is not the day the customer paid.
    Example: "2026-08-24"

  - `payouts.creationTime` (string, required)
    The time the payout was created

  - `payouts.lastUpdatedTime` (string, required)
    The time the payout was last updated

  - `payouts.reference` (string)
    The reference that appears on the bank statement

  - `payouts.payoutItemsCount` (integer, required)
    The number of items that make up the payout

  - `pagination` (object, required)
    Pagination details

  - `pagination.page` (integer)
    The current page number One-based page index (1..N).

  - `pagination.size` (integer)
    The size of the page, i.e., the number of elements per page.

  - `pagination.totalPages` (integer)
    The total number of pages available.

  - `pagination.totalElements` (integer)
    The total number of elements across all pages.

  - `pagination.numberOfElements` (integer)
    The number of elements in the current page.

  - `pagination.sort` (string)
    Sorting criteria in the format: property,(asc|desc).


## Response 400 fields

## Response 401 fields

## Response 500 fields