GOgocardless
Payout Item

Get all payout items in a single payout

Returns a cursor-paginated 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>

get/payout_items

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

payoutstring required

Unique identifier, beginning with "PO".

Example:PO123
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-Versionstring required

Response

Successful response

Example response

{
  "payout_items": [
    {
      "amount": "45.0",
      "type": "payment_paid_out",
      "taxes": [
        {
          "amount": "1.1",
          "currency": "EUR",
          "destination_amount": "1.1",
          "destination_currency": "EUR",
          "exchange_rate": "1.11205",
          "tax_rate_id": "GB_VAT_1"
        }
      ],
      "links": {
        "payment": "PM123",
        "mandate": "MD123",
        "refund": "RF123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.