---
title: "List payout entries"
method: GET
path: "/v1/payouts/{payout_id}/payout_entries"
tags: ["Payouts"]
---

# List payout entries

`GET /v1/payouts/{payout_id}/payout_entries`

List payout entries

**Required scope: `business/payouts:read`**

## Path parameters

- `payout_id` string, required — The unique identifier of the payout.

## Query parameters

- `cursor` string, nullable — A pagination cursor from where results should start being fetched.
- `limit` integer — The maximum number of results to return.

## Response `200`

Successful Response

- PaginatedResponsePayoutEntry
  - `data` PayoutEntry[], required — A list of paginated entities.
    - `id` string, required — The unique identifier of the payout entry.
    - `client_transaction_id` string, nullable, required — The identifier provided when creating the transaction via the SDK.
    - `payout_id` string, required — A reference to the payout that this entry is a part of.
    - `type` 'adjustment' | 'capital' | 'dispute' | 'fee' | 'instant_payout' | 'loyalty' | 'payment' | 'refund' | 'rebate', required
    - `gross_amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
      - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
      - `currency` string, required — The currency code in ISO 4217 format.
    - `capital_repayment_amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
      - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
      - `currency` string, required — The currency code in ISO 4217 format.
    - `fee_amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
      - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
      - `currency` string, required — The currency code in ISO 4217 format.
    - `net_amount` Money, required — `Money` represents a monetary value denoted by both an amount and a currency. The `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing with South African Rands (ZAR), the amount is in cents. eg: R150.45 is therefore represented by `Money(amount=15045, currency="ZAR")`.
      - `amount` integer, required — The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents.
      - `currency` string, required — The currency code in ISO 4217 format.
  - `next_cursor` string, nullable, required — A pagination cursor that can be used to retrieve the next set of results.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests

---

[API](https://skmtc.net/yoco/apis/yoco-api.md) · [All operations](https://skmtc.net/yoco/apis/yoco-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/yoco/yoco-api/versions/1ee03e82bc45/schema)