---
title: "List RoyaltyPays"
method: POST
path: "/api/v3/royalties/payments"
tags: ["Royalties"]
---

# List RoyaltyPays

`POST /api/v3/royalties/payments`

Retrieve a paginated, filtered list of RoyaltyPays

## Request body

- GithubComStoryprotocolProtocolApiApiInternalModelsProtocolv2RoyaltyPayRequestBody
  - `options` GithubComStoryprotocolProtocolApiApiInternalModelsProtocolv2RoyaltyPayQueryOptions
    - `orderBy` string
    - `orderDirection` string
    - `pagination` object
      - `after` string
      - `before` string
      - `limit` integer
    - `where` object
      - `blockNumber` string
      - `id` string
      - `payerIpId` string
      - `receiverIpId` string

## Response `200`

OK

- GithubComStoryprotocolProtocolApiApiInternalModelsProtocolv1RoyaltyPaysResponse
  - `data` GithubComStoryprotocolProtocolApiApiInternalModelsProtocolv1RoyaltyPay[]
    - `amount` string
    - `blockNumber` string
    - `blockTimestamp` string
    - `id` string
    - `payerIpId` string
    - `receiverIpId` string
    - `sender` string
    - `token` string
  - `next` string
  - `prev` string

---

[API](https://skmtc.net/storyapis/apis/story-protocol-api-reference.md) · [All operations](https://skmtc.net/storyapis/apis/story-protocol-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/storyapis/story-protocol-api-reference/revisions/6cb84b9791cd/schema)