---
title: "List payment history"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List payment history

`GET /payments`

## Request

- Base URL: `https://api.commpeak.com/portal`
- URL: `https://api.commpeak.com/portal/payments`
- Auth: API key in header `Authorization`

Returns the account's balance movements as shown on the Payment History page in the portal: top-ups, deductions, subscriptions and temporary credits, newest first. `scope` narrows the list to one kind (`all`, `purchase`, `deductions`, `subscriptions`, `temp_credits`). Without `time_range` the last 3 months are returned; a range can span at most 1 year. Accounts with separate Voice and SMS balances can narrow the list with `account`. `document_available` tells whether a credit note or receipt document exists for the payment in the portal. Pagination is by `page` and `per_page` (default 100, max 1000).

## Query parameters

- `scope` string, nullable: Kind of payments: all (default), purchase, deductions, subscriptions, temp_credits.
- `time_range` string, nullable: Date range "YYYY-MM-DD - YYYY-MM-DD" (or a single date).
- `account` string, nullable: voice or sms; only for accounts with separate Voice and SMS balances.
- `page` integer, nullable: Page number (default 1).
- `per_page` integer, nullable: Items per page (default 100, max 1000).

## Response `200`

Successful Response

- PaymentsResponse: Envelope returned by `GET /portal/payments`.
  - `payments` PaymentItem[], required
    - `id` integer, required: Payment identifier.
    - `date` string, nullable: Payment date (ISO 8601).
    - `amount` number, nullable: Amount; negative for deductions.
    - `currency` string, nullable: Currency.
    - `type` string, nullable: Payment type.
    - `description` string, nullable: Description.
    - `account` string, nullable: `voice` or `sms` balance.
    - `document_available` boolean, nullable: Whether a credit note or receipt is available in the portal.
  - `page` integer, nullable: Current page.
  - `per_page` integer, nullable: Items per page.
  - `total` integer, nullable: Total number of items.

## Other responses

- `422`: Validation Error

---

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