---
title: "List payout records for a given affiliate (by customerId), paginated."
method: GET
path: "/stores/{storeId}/affiliates/{customerId}/payouts/{page}"
tags: ["Affiliate"]
---

# List payout records for a given affiliate (by customerId), paginated.

`GET /stores/{storeId}/affiliates/{customerId}/payouts/{page}`

## Request

- Base URL: `https://api.komerza.com`
- URL: `https://api.komerza.com/stores/{storeId}/affiliates/{customerId}/payouts/{page}`
- Auth: HTTP bearer

Requires the `stores.affiliates.view` permission.

## Path parameters

- `storeId` string, uuid, required
- `customerId` string, uuid, required
- `page` integer, required

## Query parameters

- `limit` integer

## Response `200`

The object was successfully returned.

- AffiliatePayoutPaginatedResponse: Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.
  - `success` boolean, required: Indicates whether the operation was successful
  - `pages` integer, required: The total number of pages available in the paginated response.
  - `data` AffiliatePayout[], required: Represents the collection of items within a paginated response
    - `id` string, uuid, required: The unique identifier of the entity
    - `dateCreated` string, date-time, required: The date the entity was created in the database
    - `customerId` string, uuid, required: The affiliate customer who earned the payout.
    - `storeId` string, uuid, required: The store in which the affiliate earned these commissions.
    - `affiliateId` string, uuid, required: The ID of the affiliate who paid out
    - `amount` number, double, required: The amount paid out to the affiliate (or converted to store credit).
    - `convertedToStoreCredit` boolean, required: Whether this payout was converted into store‐credit (true) or represents an external payout (false).
    - `comment` string, nullable: (Optional) A note or reason for this payout, for auditing.
    - `initiatedByUserId` string, nullable: The user who initiated the payout, if this is null then it was initiated by the customer
    - `initiatedByIp` string, required: The IP address who initiated the payout
    - `isVoided` boolean, required: Indicates whether the affiliate payout has been voided.
    - `voidDate` string, date-time, nullable: The date and time when the payout was voided, if applicable.
    - `voidedByUserId` string, nullable: The user who voided the affiliate payout.
    - `voidReason` string, nullable: The reason provided when an affiliate payout is voided.

---

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