---
title: "Get all payout items in a single payout"
method: GET
path: "/payout_items"
tags: ["Payout Item"]
---

# Get all payout items in a single payout

`GET /payout_items`

## Request

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

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

<strong>This endpoint only serves requests for payouts created in the last 6 months. Requests for older payouts will return an HTTP status <code>410 Gone</code>.</strong>

## Query parameters

- `before` string, nullable
- `after` string, nullable
- `limit` union
  - integer
  - string
- `payout` string, required: Unique identifier, beginning with "PO".
- `include_2020_tax_cutover` 'true' | 'false': Boolean value indicating whether the API should return tax data for the cutover period of April to August 2020. Defaults to false.

## Headers

- `GoCardless-Version` string, required

## Response `200`

Successful response

- PayoutItemMultiResourceResponse: A list of payout items
  - `payout_items` PayoutItem[]
    - `amount` string, required: The positive (credit) or negative (debit) value of the item, in fractional currency; the lowest denomination for the currency (e.g. pence in GBP, cents in EUR), to one decimal place. <p class="notice">For accuracy, we store some of our fees to greater precision than we can actually pay out (for example, a GoCardless fee we record might come to 0.5 pence, but it is not possible to send a payout via bank transfer including a half penny).<br><br>To calculate the final amount of the payout, we sum all of the items and then round to the nearest currency unit.</p>
    - `type` 'payment_paid_out' | 'payment_failed' | 'payment_charged_back' | 'payment_refunded' | 'refund' | 'gocardless_fee' | 'app_fee' | 'revenue_share' | 'surcharge_fee' | 'refund_funds_returned', required: The type of the credit (positive) or debit (negative) item in the payout (inclusive of VAT if applicable). One of: - `payment_paid_out` (credit) - `payment_failed` (debit): The payment failed to be processed. - `payment_charged_back` (debit): The payment has been charged back. - `payment_refunded` (debit): The payment has been refunded to the customer. - `refund` (debit): A refund sent to a customer, not linked to a payment. - `refund_funds_returned` (credit): The refund could not be sent to the customer, and the funds have been returned to you. - `gocardless_fee` (credit/debit): The fees that GoCardless charged for a payment. In the case of a payment failure or chargeback, these will appear as credits. Will include taxes if applicable for merchants. - `app_fee` (credit/debit): The optional fees that a partner may have taken for a payment. In the case of a payment failure or chargeback, these will appear as credits. - `revenue_share` (credit/debit): A share of the fees that GoCardless collected which some partner integrations receive when their users take payments. Only shown in partner payouts. In the case of a payment failure or chargeback, these will appear as credits. - `surcharge_fee` (credit/debit): GoCardless deducted a surcharge fee as the payment failed or was charged back, or refunded a surcharge fee as the bank or customer cancelled the chargeback. Will include taxes if applicable for merchants.
    - `taxes` object[], required: An array of tax items <em>beta</em> _Note_: VAT applies to transaction and surcharge fees for merchants operating in the UK and France.
      - `amount` string: The amount of tax applied to a fee in fractional currency; the lowest denomination for the currency (e.g. pence in GBP, cents in EUR), to one decimal place.
      - `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.
      - `destination_amount` string, nullable: The amount of tax to be paid out to the tax authorities in fractional currency; the lowest denomination for the currency (e.g. pence in GBP, cents in EUR), to one decimal place. When `currency` and `destination_currency` don't match this will be `null` until the `exchange_rate` has been finalised.
      - `destination_currency` string: [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” for French merchants and “GBP” for British merchants.
      - `exchange_rate` string, nullable: The exchange rate for the tax from the currency into the destination currency. Present only if the currency and the destination currency don't match and the exchange rate has been finalised. You can listen for the payout's [`tax_exchange_rates_confirmed` webhook](https://docs.gocardless.com/docs/api-reference/events/payout) to know when the exchange rate has been finalised for all fees in the payout.
      - `tax_rate_id` string: The unique identifier created by the jurisdiction, tax type and version
    - `links` PayoutItemLinks, required
      - `payment` string: Unique identifier, beginning with "PM".
      - `mandate` string: Unique identifier, beginning with "MD". Note that this prefix may not apply to mandates created before 2016. Present only for the items of type `payment_refunded`, `refund` and `refund_funds_returned`.
      - `refund` string: Unique identifier, beginning with "RF". Present only for the items of type `payment_refunded`, `refund` and `refund_funds_returned`.
  - `meta` PayoutItemPaginationMeta: 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)