> For the complete documentation index, see [llms.txt](https://help.unitpay.ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.unitpay.ru/en/mass-payouts/payout-list.md).

# Payout list (API)

Use this request to get the list of your mass payouts for a period. For each payout it returns the status, amount, commissions, the amount debited from the balance and the account currency. The request is suitable for payout reconciliation.

{% hint style="info" %}
The request only reads data and does not refresh statuses in payment systems. To refresh the status of a particular payout, use the ["Information about Payout"](https://help.unitpay.ru/en/mass-payouts/information-about-payout) request.
{% endhint %}

```bash
GET https://unitpay.ru/api

method      = massPaymentList
login       = partner@example.com
secretKey   = YOUR_SECRET_KEY
dateFrom    = 2026-09-01
dateTo      = 2026-09-30
status      = success,error
paymentType = card,sbp
limit       = 100
```

**Required parameters:**

<table data-header-hidden><thead><tr><th width="160">name</th><th width="120">type</th><th>description</th></tr></thead><tbody><tr><td><strong>login</strong></td><td>string</td><td>Email of the account in the UnitPay system</td></tr><tr><td><strong>secretKey</strong></td><td>string</td><td>Account secret key, available in <a href="https://unitpay.ru/partner/profile/edit">profile settings</a></td></tr></tbody></table>

**Optional parameters:**

<table data-header-hidden><thead><tr><th width="160">name</th><th width="120">type</th><th>description</th></tr></thead><tbody><tr><td><strong>dateFrom</strong></td><td>string</td><td>Start of the period by payout creation date, in YYYY-MM-DD format. Default: 29 days before dateTo</td></tr><tr><td><strong>dateTo</strong></td><td>string</td><td>End of the period, inclusive, in YYYY-MM-DD format. Default: the current date</td></tr><tr><td><strong>status</strong></td><td>string</td><td>Payout statuses, comma-separated: success, wait, not_completed, error</td></tr><tr><td><strong>paymentType</strong></td><td>string</td><td>Payment system codes, comma-separated: card, sbp, webmoney, usdt, mc, qiwi, yandex</td></tr><tr><td><strong>projectId</strong></td><td>number</td><td>Unique project ID in the UnitPay system. Only payouts created with this projectId are returned</td></tr><tr><td><strong>limit</strong></td><td>number</td><td>Number of payouts in the response: from 1 to 500, 100 by default</td></tr><tr><td><strong>cursor</strong></td><td>number</td><td>The nextCursor value from the previous response. Pass it to get the next page</td></tr></tbody></table>

{% hint style="info" %}
The period is counted in whole days, Moscow time (UTC+3), and cannot be longer than 31 days. To get payouts for a longer period, request them month by month.

Multiple values in **status** and **paymentType** are passed as a single comma-separated string, for example `status=success,error`.
{% endhint %}

If a list of allowed IP addresses is set for the account, the request is accepted only from those addresses.

#### Example of a successful response

```json
{
  "result": {
    "items": [
      {
        "payoutId":          325421263,
        "status":            "success",
        "payoutCommission":  "0.00",
        "partnerCommission": "24.75",
        "sum":               "450.00",
        "createDate":        "2026-09-30 14:02:11",
        "completeDate":      "2026-09-30 14:04:37",
        "transactionId":     "1782",
        "paymentType":       "sbp",
        "purse":             "79123456789",
        "debited":           "474.75",
        "paidOut":           "450.00",
        "currency":          "RUB",
        "projectId":         null,
        "comment":           null
      },
      {
        "payoutId":          325421190,
        "status":            "error",
        "payoutCommission":  "0.00",
        "partnerCommission": "30.00",
        "sum":               "1000.00",
        "createDate":        "2026-09-30 13:47:05",
        "completeDate":      "2026-09-30 13:47:52",
        "transactionId":     "1781",
        "paymentType":       "card",
        "purse":             "220070xxxxxx0004",
        "debited":           "1030.00",
        "paidOut":           null,
        "currency":          "RUB",
        "projectId":         null,
        "comment":           null
      }
    ],
    "nextCursor": 325421190
  }
}
```

<table data-header-hidden><thead><tr><th width="190">name</th><th width="120">type</th><th>description</th></tr></thead><tbody><tr><td><strong>items</strong></td><td>array</td><td>Payouts for the period, newest first</td></tr><tr><td><strong>nextCursor</strong></td><td>number</td><td>Value for the cursor parameter of the next request. null means this is the last page</td></tr></tbody></table>

**Payout fields:**

<table data-header-hidden><thead><tr><th width="190">name</th><th width="120">type</th><th>description</th></tr></thead><tbody><tr><td><strong>payoutId</strong></td><td>number</td><td>Unique payout ID in the UnitPay system</td></tr><tr><td><strong>transactionId</strong></td><td>string</td><td>Unique payout ID on your side</td></tr><tr><td><strong>status</strong></td><td>string</td><td>success — successful payout<br>wait — the payout is being processed<br>not_completed — the payout has been sent to the payment system, but no confirmation has been received yet (temporary status)<br>error — failed payout</td></tr><tr><td><strong>sum</strong></td><td>number</td><td>Payout amount</td></tr><tr><td><strong>payoutCommission</strong></td><td>number</td><td>Payout commission</td></tr><tr><td><strong>partnerCommission</strong></td><td>number</td><td>Partner commission</td></tr><tr><td><strong>debited</strong></td><td>number</td><td>Amount debited from the balance when the payout was created: sum + partnerCommission, in the currency from the currency field. For a payout in the error status this amount is returned to the balance</td></tr><tr><td><strong>paidOut</strong></td><td>number</td><td>Amount received by the recipient. Returned only for payouts in the success status, otherwise null</td></tr><tr><td><strong>currency</strong></td><td>string</td><td>Currency of the account the payout was debited from: RUB or USDT</td></tr><tr><td><strong>paymentType</strong></td><td>string</td><td>Payment system code of the payout. null if the payout was made by a method that is not among the paymentType parameter values</td></tr><tr><td><strong>purse</strong></td><td>string</td><td>Recipient details. A card number is returned masked: the first 6 and the last 4 digits</td></tr><tr><td><strong>projectId</strong></td><td>number</td><td>Project ID if the payout was created with the projectId parameter, otherwise null</td></tr><tr><td><strong>comment</strong></td><td>string</td><td>Payout comment passed on creation</td></tr><tr><td><strong>createDate</strong></td><td>string</td><td>Payout creation date, UTC+3</td></tr><tr><td><strong>completeDate</strong></td><td>string</td><td>Date of the last payout update, UTC+3</td></tr></tbody></table>

Amounts are returned as strings with two decimal places.

#### Getting the next pages

1. Send the first request without the **cursor** parameter.
2. If **nextCursor** in the response is not null, repeat the request with the same parameters and add `cursor` with the **nextCursor** value.
3. If **nextCursor** is null, you have received the last page.

{% hint style="success" %}
Payouts created while you are paging are not included and do not shift the pages, so there are no duplicates or gaps. A payout status may change after you get the list, so request payouts in the wait and not\_completed statuses again later.
{% endhint %}

#### Example of an error response

```json
{
    "error": {
        "message": "Неверные параметры авторизации",
        "code": -32000
    }
}
```

Error messages are returned in Russian. Use the `code` field to handle errors.

<table data-header-hidden><thead><tr><th width="160">name</th><th>description</th></tr></thead><tbody><tr><td><strong>-32000</strong></td><td>Invalid authorization parameters (login, secret key), a request from an IP address outside the allowed list, or projectId does not belong to the account</td></tr><tr><td><strong>-32602</strong></td><td>Invalid request parameters: date format, a period longer than 31 days or dateFrom later than dateTo, an unknown status or paymentType value, limit outside the range from 1 to 500, a parameter passed as an array</td></tr></tbody></table>
