---
title: "List payouts"
method: GET
path: "/payouts"
tags: ["Payout"]
---

# List payouts

`GET /payouts`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/payouts`
- Auth: HTTP bearer

Returns a [cursor-paginated](https://docs.gocardless.com/docs/api-reference/data-conventions#cursor-pagination) list of your payouts.

## Query parameters

- `before` string, nullable
- `after` string, nullable
- `limit` union
  - integer
  - string
- `created_at` object
  - `gt` string, date-time: Limit to records created after the specified date-time.
  - `lt` string, date-time: Limit to records created before the specified date-time.
  - `gte` string, date-time: Limit to records created on or after the specified date-time.
  - `lte` string, date-time: Limit to records created on or before the specified date-time.
- `creditor` string: Unique identifier, beginning with "CR".
- `creditor_bank_account` string: Unique identifier, beginning with "BA".
- `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD': [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
- `status` 'pending' | 'paid' | 'bounced': One of: - `pending`: the payout has been created, but not yet sent to your bank or it is in the process of being exchanged through our FX provider. - `paid`: the payout has been sent to the your bank. FX payouts will become `paid` after we emit the `fx_rate_confirmed` webhook. - `bounced`: the payout bounced when sent, the payout can be retried.
- `reference` string: Reference which appears on the creditor's bank statement.
- `payout_type` 'merchant' | 'partner': Whether a payout contains merchant revenue or partner fees.
- `metadata` PayoutMetadata: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters. _Note:_ This should not be used for storing PII data.

## Headers

- `GoCardless-Version` string, required

## Response `200`

Successful response

- PayoutMultiResourceResponse
  - `payouts` Payout[]
    - `id` string, required: Unique identifier, beginning with "PO".
    - `created_at` string, date-time, required: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `amount` integer, required: Amount in minor unit (e.g. pence in GBP, cents in EUR).
    - `deducted_fees` integer, required: Fees that have already been deducted from the payout amount in minor unit (e.g. pence in GBP, cents in EUR), inclusive of tax if applicable. <br /> For each `late_failure_settled` or `chargeback_settled` action, we refund the transaction fees in a payout. This means that a payout can have a negative `deducted_fees` value. <br /> This field is calculated as `(GoCardless fees + app fees + surcharge fees) - (refunded fees)` <br /> If the merchant is invoiced for fees separately from the payout, then `deducted_fees` will be 0.
    - `currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', required: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency code. Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported.
    - `reference` string, required: Reference which appears on the creditor's bank statement.
    - `status` 'pending' | 'paid' | 'bounced', required: One of: - `pending`: the payout has been created, but not yet sent to your bank or it is in the process of being exchanged through our FX provider. - `paid`: the payout has been sent to the your bank. FX payouts will become `paid` after we emit the `fx_rate_confirmed` webhook. - `bounced`: the payout bounced when sent, the payout can be retried.
    - `payout_type` 'merchant' | 'partner', required: Whether a payout contains merchant revenue or partner fees.
    - `arrival_date` string, nullable, required: Date the payout is due to arrive in the creditor's bank account. One of: - `yyyy-mm-dd`: the payout has been paid and is due to arrive in the creditor's bank account on this day - `null`: the payout hasn't been paid yet
    - `links` PayoutLinks, required
      - `creditor` string: ID of [creditor](https://docs.gocardless.com/docs/api-reference/creditor) who will receive this payout, i.e. the owner of the `creditor_bank_account`.
      - `creditor_bank_account` string: ID of [bank account](https://docs.gocardless.com/docs/api-reference/creditor-bank-account) which this will be sent to.
    - `fx` PayoutFx, required
      - `exchange_rate` string, nullable: Rate used in the foreign exchange of the `amount` into the `fx_currency`. Present only after a resource is paid out. Has up to 10 decimal places.
      - `estimated_exchange_rate` string, nullable: Estimated rate that will be used in the foreign exchange of the `amount` into the `fx_currency`. This will vary based on the prevailing market rate until the moment that it is paid out. Present only before a resource is paid out. Has up to 10 decimal places.
      - `fx_amount` union: Amount that was paid out in the `fx_currency` after foreign exchange. Present only after the resource has been paid out.
        - string, nullable
        - integer
      - `fx_currency` 'AUD' | 'CAD' | 'DKK' | 'EUR' | 'GBP' | 'NZD' | 'SEK' | 'USD', nullable: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in which amounts will be paid out (after foreign exchange). Currently "AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK" and "USD" are supported. Present only if payouts will be (or were) made via foreign exchange.
    - `tax_currency` string, nullable, required: [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) code for the currency in which tax is paid out to the tax authorities of your tax jurisdiction. Currently “EUR”, “GBP”, for French or British merchants, this will be `null` if tax is not applicable <em>beta</em>
    - `metadata` PayoutMetadata, required: Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters. _Note:_ This should not be used for storing PII data.
  - `meta` PayoutPaginationMeta: Cursor pagination information
    - `limit` integer, required
    - `cursors` object, required
      - `before` string, nullable, required: Cursor pointing to the end of the desired set.
      - `after` string, nullable, required: Cursor pointing to the start of the desired set.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)