---
title: "List revenue-share settlements"
method: GET
path: "/api/v1/revenue-share/settlements"
tags: ["Revenue Share"]
---

# List revenue-share settlements

`GET /api/v1/revenue-share/settlements`

## Request

- Base URL: `https://partner-api.monta.com`
- URL: `https://partner-api.monta.com/api/v1/revenue-share/settlements`
- Auth: HTTP bearer

Required scope: `revenue-share:read`

## Query parameters

- `page` integer
- `perPage` integer
- `agreementCode` string, nullable: Filter settlements by the agreement they belong to.
- `status` 'Pending' | 'Settled' | 'Failed' | 'Other'
- `periodFrom` string, date-time, nullable: Return settlements whose period starts on or after this timestamp (ISO 8601, e.g. `2026-01-01T00:00:00Z`).
- `periodTo` string, date-time, nullable: Return settlements whose period ends on or before this timestamp (ISO 8601, e.g. `2026-01-31T23:59:59Z`).

## Response `200`

Revenue-share settlements matching the filters

- OffsetBasedResponse51
  - `data` RevenueShareSettlement[], required
    - `id` string, required: Stable identifier of the settlement.
    - `agreementCode` string, nullable: Code of the agreement the settlement belongs to.
    - `status` 'Pending' | 'Settled' | 'Failed' | 'Other', required
    - `periodStart` string, date-time, nullable: Start of the settled period.
    - `periodEnd` string, date-time, nullable: End of the settled period.
    - `currency` string, nullable: Currency of the settled amounts.
    - `totalShareAmount` number, nullable: Total shared amount for the period.
    - `totalTaxAmount` number, nullable: Total tax amount for the period.
    - `walletTransactionId` string, nullable: Identifier of the wallet transaction that settled the share.
    - `attempts` integer, nullable: Number of settlement attempts made.
    - `lastAttemptAt` string, date-time, nullable: Timestamp of the last settlement attempt.
    - `settledAt` string, date-time, nullable: Timestamp when the settlement was completed.
    - `errorReason` string, nullable: Reason the settlement failed, when applicable.
    - `createdAt` string, date-time, nullable: Creation timestamp.
  - `meta` MontaPageMeta, required
    - `itemCount` integer, required
    - `currentPage` integer, required
    - `perPage` integer, required
    - `totalPageCount` integer, required
    - `totalItemCount` integer, required

## Other responses

- `400`: The request is invalid
- `401`: Consumer with provided credentials was not found
- `403`: Operator doesn't have access to resource
- `404`: Entity with the provided id was not found

## Changes

- **2026-11-03** `0ca400461c52`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/monta/apis/monta-partner-api/changes/api/v1/revenue-share/settlements/get.md)

---

[API](https://skmtc.dev/monta/apis/monta-partner-api.md) - [All operations](https://skmtc.dev/monta/apis/monta-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/monta/apis/monta-partner-api/revisions/0ca400461c52?raw)