Platega API

https://docs.platega.io
Admin
Platega API allows you to integrate payment functions into your services, such as creating payments,...
Tokens:37,999
Snippets:143
Trust Score:5.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Subscription Payment Response Example

Source: https://docs.platega.io/%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D1%82%D1%8C-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BA%D1%83-40029698e0

Example response structure for a subscription payment request, including transaction status and redirect URL.

```yaml
example:
                paymentMethod: Subscription
                transactionId: 11111111-1111-1111-1111-111111111111
                redirect: https://pay.platega.io/subscription/11111111-...
                status: PENDING
                merchantId: 22222222-2222-2222-2222-222222222222
```

--------------------------------

### GET /balance/all

Source: https://docs.platega.io/%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B1%D0%B0%D0%BB%D0%B0%D0%BD%D1%81%D0%BE%D0%B2-33582950e0

Получение списка всех балансов мерчанта.

```APIDOC
## GET /balance/all

### Description
Получение балансов мерчанта по всем валютам.

### Method
GET

### Endpoint
/balance/all

### Parameters
#### Header Parameters
- **X-MerchantId** (string) - Required - Ваш MerchantId (UUID)
- **X-Secret** (string) - Required - Ваш API ключ

### Response
#### Success Response (200)
- **amount** (number) - Сумма баланса
- **currency** (string) - Валюта
- **frozenBalance** (integer) - Замороженный баланс

#### Response Example
[
  {
    "amount": 15000.5,
    "currency": "RUB"
  },
  {
    "amount": 200,
    "currency": "USDT",
    "frozenBalance": 500
  }
]
```

--------------------------------

### OpenAPI Transaction Response Example

Source: https://docs.platega.io/%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%BD%D0%BE%D0%B9-%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B8-%D0%B1%D0%B5%D0%B7-%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-33845703e0

Example of a successful transaction response object containing the transaction ID, status, payment URL, expiration time, and rate.

```yaml
example:
                transactionId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                status: PENDING
                url: >-
                  https://pay.platega.io/?id=f8000067-a4a0-0000-0000-2556a0b40000&mh=0a0000a4-0000-0000-0000-200004060000
                expiresIn: '00:15:00'
                rate: 91.2
```

--------------------------------

### Subscription list response example

Source: https://docs.platega.io/%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-40029720e0

The JSON response structure returned by the /subscription endpoint, containing an array of subscription items and pagination metadata.

```JSON
{
    "items": [
        {
            "id": "480bc68d-8114-4af1-9637-2ca73e5cfdfc",
            "status": 4,
            "amount": 100,
            "currencyCode": "RUB",
            "intervalUnit": 3,
            "intervalCount": 1,
            "nextChargeAt": null,
            "lastChargeAt": null,
            "customerEmail": null,
            "description": "вапвапвап",
            "chargesCount": 0,
            "createdAt": "2026-07-14T13:23:16.164247Z"
        },
        {
            "id": "c036f0c3-45f7-4650-92aa-3b3739855116",
            "status": 4,
            "amount": 100,
            "currencyCode": "RUB",
            "intervalUnit": 2,
            "intervalCount": 1,
            "nextChargeAt": null,
            "lastChargeAt": null,
            "customerEmail": "example@mail.ru",
            "description": "Подписка",
            "chargesCount": 0,
            "createdAt": "2026-07-14T08:27:03.675156Z"
        }
    ],
    "total": 2,
    "page": 1,
    "size": 20
}
```

--------------------------------

### Retrieve subscription list via cURL

Source: https://docs.platega.io/%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-40029720e0

Example request to the /subscription endpoint using cURL, including query parameters for status, date range, and pagination, along with required merchant authentication headers.

```Shell
curl --location '/subscription?status=1&from=2026-07-01T00%3A00%3A00.000Z&to=2026-07-31T23%3A59%3A59.999Z&page=1&size=20' \
--header 'X-MerchantId;' \
--header 'X-Secret;'
```

--------------------------------

### OpenAPI Specification для получения подписки

Source: https://docs.platega.io/%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BA%D1%83-40029717e0

Определение эндпоинта GET /subscription/{subscriptionId}, требующего заголовки X-MerchantId и X-Secret. Возвращает объект с данными подписки и метриками транзакций при успешном запросе.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /subscription/{subscriptionId}:
    get:
      summary: Получить подписку
      deprecated: false
      description: Возвращает подписку по указанному ID
      operationId: getSubscription
      tags:
        - Платежи/Рекуррентные СБП-подписки
        - Payments
      parameters:
        - name: subscriptionId
          in: path
          description: ''
          required: true
          schema:
            type: string
        - name: X-MerchantId
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: X-Secret
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: Данные транзакции
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                  amount:
                    type: integer
                  currencyCode:
                    type: string
                  intervalUnit:
                    type: string
                  intervalCount:
                    type: integer
                  startAt:
                    type: string
                  nextChargeAt:
                    type: string
                  lastChargeAt:
                    type: string
                  description:
                    type: string
                  createdAt:
                    type: string
                  customerEmail:
                    type: string
                  chargeMetrics:
                    type: object
                    properties:
                      chargesTotal:
                        type: integer
                      chargesSuccess:
                        type: integer
                      chargesFailed:
                        type: integer
                      totalAmount:
                        type: integer
                      lastChargeAt:
                        type: string
                      nextChargeAt:
                        type: string
                    required:
                      - chargesTotal
                      - chargesSuccess
                      - chargesFailed
                      - totalAmount
                      - lastChargeAt
                      - nextChargeAt
                    x-apidog-orders:
                      - chargesTotal
                      - chargesSuccess
                      - chargesFailed
                      - totalAmount
                      - lastChargeAt
                      - nextChargeAt
                required:
                  - id
                  - status
                  - amount
                  - currencyCode
                  - intervalUnit
                  - intervalCount
                  - startAt
                  - nextChargeAt
                  - lastChargeAt
                  - description
                  - createdAt
                  - customerEmail
                  - chargeMetrics
                x-apidog-orders:
                  - id
                  - status
                  - amount
                  - currencyCode
                  - intervalUnit
                  - intervalCount
                  - startAt
                  - nextChargeAt
                  - lastChargeAt
                  - description
                  - createdAt
                  - customerEmail
                  - chargeMetrics
              example:
                id: 11111111-1111-1111-1111-111111111111
                status: Active
                amount: 100
                currencyCode: RUB
                intervalUnit: Month
                intervalCount: 1
                startAt: '2026-07-08T09:00:00Z'
                nextChargeAt: '2026-08-09T09:10:00Z'
                lastChargeAt: '2026-07-09T09:10:00Z'
                description: Premium подписка
                createdAt: '2026-07-08T09:00:00Z'
                customerEmail: payer@example.com
                chargeMetrics:
                  chargesTotal: 1
                  chargesSuccess: 1
                  chargesFailed: 0
                  totalAmount: 100
                  lastChargeAt: '2026-07-09T09:10:00Z'
                  nextChargeAt: '2026-08-09T09:10:00Z'
          headers: {}
          x-apidog-name: ''
        '404':
          description: Транзакция не найдена
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Платежи/Рекуррентные СБП-подписки
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1213537/apis/api-40029717-run
components:
  schemas: {}
  securitySchemes:
```

--------------------------------

### GET /subscription

Source: https://docs.platega.io/%D1%81%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BE%D0%BA-40029720e0

Retrieves a list of subscriptions based on provided query parameters.

```APIDOC
## GET /subscription

### Description
Получить список ваших подписок

### Method
GET

### Endpoint
/subscription

### Parameters
#### Query Parameters
- **status** (string) - Optional - Example: 1
- **from** (string) - Optional - Example: 2026-07-01T00:00:00.000Z
- **to** (string) - Optional - Example: 2026-07-31T23:59:59.999Z
- **page** (string) - Optional - Example: 1
- **size** (string) - Optional - Example: 20

#### Header Parameters
- **X-MerchantId** (string) - Required
- **X-Secret** (string) - Required

### Response
#### Success Response (200)
- **items** (array [object]) - List of subscriptions
- **total** (integer) - Total count
- **page** (integer) - Current page
- **size** (integer) - Page size

#### Response Example
{
    "items": [
        {
            "id": "480bc68d-8114-4af1-9637-2ca73e5cfdfc",
            "status": 4,
            "amount": 100,
            "currencyCode": "RUB",
            "intervalUnit": 3,
            "intervalCount": 1,
            "nextChargeAt": null,
            "lastChargeAt": null,
            "customerEmail": null,
            "description": "вапвапвап",
            "chargesCount": 0,
            "createdAt": "2026-07-14T13:23:16.164247Z"
        }
    ],
    "total": 2,
    "page": 1,
    "size": 20
}
```

--------------------------------

### POST /transaction/process

Source: https://docs.platega.io/%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D1%82%D1%8C-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BA%D1%83-40029698e0

Создает новую подписку на регулярные списания. После вызова необходимо перенаправить пользователя по полученному URL для завершения привязки счета.

```APIDOC
## POST /transaction/process

### Description
Создает подписку для регулярных автосписаний через СБП. После создания подписки необходимо перенаправить плательщика на полученный URL для подтверждения привязки счета в его банке.

### Method
POST

### Endpoint
/transaction/process

### Parameters
#### Header Parameters
- **X-MerchantId** (string) - Required - Идентификатор мерчанта
- **X-Secret** (string) - Required - Секретный ключ

#### Request Body
- **paymentMethod** (integer) - Required - Всегда 6
- **paymentDetails** (object) - Required - Детали подписки
  - **amount** (integer) - Required - Сумма одного регулярного списания
  - **currency** (string) - Required - Валюта (например, RUB)
  - **interval** (integer) - Required - Период списаний: 1 — день, 2 — неделя, 3 — месяц, 4 — год
  - **intervalCount** (integer) - Required - Количество периодов
- **description** (string) - Required - Описание, отображаемое плательщику

### Request Example
{
  "paymentMethod": 6,
  "paymentDetails": {
    "amount": 500,
    "currency": "RUB",
    "interval": 3,
    "intervalCount": 1
  },
  "description": "Premium подписка"
}

### Response
#### Success Response (200)
- **paymentMethod** (string) - Метод оплаты
- **transactionId** (string) - ID подписки (subscriptionId)
- **redirect** (string) - URL для перенаправления плательщика
- **status** (string) - Статус операции
- **merchantId** (string) - ID мерчанта

#### Response Example
{
  "paymentMethod": "6",
  "transactionId": "sub_12345",
  "redirect": "https://payment.example.com/redirect/url",
  "status": "pending",
  "merchantId": "m_123"
}
```

--------------------------------

### OpenAPI спецификация для callback-уведомлений

Source: https://docs.platega.io/callback-%D0%BE%D0%B1-%D0%B8%D0%B7%D0%BC%D0%B5%D0%BD%D0%B5%D0%BD%D0%B8%D0%B8-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D1%82%D1%80%D0%B0%D0%BD%D0%B7%D0%B0%D0%BA%D1%86%D0%B8%D0%B8-29209725e0

Определение webhook-а paymentStatus в формате OpenAPI 3.1.0, включающее структуру тела запроса, обязательные заголовки и примеры данных для различных статусов транзакций.

```yaml
openapi: 3.1.0
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
webhooks:
  paymentStatus:
    post:
      summary: Callback об изменении статуса транзакции
      deprecated: false
      description: >-
        Ваш endpoint для приема callback. Укажите URL в ЛК (Настройки → Callback
        URLs). Поставщик отправляет заголовки `X-MerchantId` и `X-Secret` и
        JSON-тело. При успешной оплате — статус **CONFIRMED**, при неуспешной —
        **CANCELED**, при возврате денежных средств — **CHARGEBACKED**. В случае
        отсутствия успешного ответа в течение 60 секунд запрос отменяется, затем
        выполняется до 3 повторных попыток с интервалом 5 минут.


        Правила заполнения поля callback:

        ✅ Использовать только HTTPS (HTTP запрещён)

        ✅ Использовать только публичные IP-адреса или доменные имена

        ✅ Требуется корректный SSL-сертификат, выданный доверенным
        удостоверяющим центром

        ❌ Самоподписанные (self-signed) SSL-сертификаты не допускаются

        ❌ Запрещены приватные IP-диапазоны (10.0.0.0/8, 172.16.0.0/12,
        192.168.0.0/16, 127.0.0.0/8)

        ❌ Запрещены localhost и loopback адреса
      operationId: paymentStatusCallback
      tags: []
      parameters:
        - name: X-MerchantId
          in: header
          description: Ваш MerchantId (UUID)
          required: true
          example: ''
          schema:
            type: string
        - name: X-Secret
          in: header
          description: Ваш API ключ
          required: true
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                  description: ID транзакции
                amount:
                  type: number
                  format: float
                currency:
                  type: string
                status:
                  type: string
                  description: Статус транзакции в callback
                  enum:
                    - CONFIRMED
                    - CANCELED
                  x-apidog-enum:
                    - value: CONFIRMED
                      name: ''
                      description: ''
                    - value: CANCELED
                      name: ''
                      description: ''
                paymentMethod:
                  type: integer
                  description: ID метода оплаты
                payload:
                  type: string
                  description: Дополнительные данные
              x-apidog-orders:
                - id
                - amount
                - currency
                - status
                - paymentMethod
                - payload
              required:
                - id
                - amount
                - currency
                - status
            examples:
              '1':
                value:
                  id: 00000000-0000-0000-0000-000000000000
                  amount: 1000
                  currency: RUB
                  status: CONFIRMED
                  paymentMethod: 2
                summary: confirmed
              '2':
                value:
                  id: 00000000-0000-0000-0000-000000000000
                  amount: 1000
                  currency: RUB
                  status: CANCELED
                  paymentMethod: 2
                summary: canceled
      responses:
        '200':
          description: ''
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: ''
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1213537/apis/api-29209725-run
components:
  schemas: {}
  securitySchemes:
    MerchantIdAuth:
      type: apikey
      in: header
      name: X-MerchantId
      description: Ваш MerchantId (UUID)
    SecretAuth:
      type: apikey
      in: header
      name: X-Secret
      description: Ваш API ключ
    Combination:
      group:
        - id: 482006
        - id: 482007
      type: customize
    bearer:
      type: bearer
      scheme: bearer
servers: []
security: []
```

--------------------------------

### GET /subscription/{subscriptionId}

Source: https://docs.platega.io/%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B8%D1%82%D1%8C-%D0%BF%D0%BE%D0%B4%D0%BF%D0%B8%D1%81%D0%BA%D1%83-40029717e0

Возвращает данные подписки по указанному идентификатору.

```APIDOC
## GET /subscription/{subscriptionId}

### Description
Возвращает подписку по указанному ID.

### Method
GET

### Endpoint
/subscription/{subscriptionId}

### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - Идентификатор подписки

#### Headers
- **X-MerchantId** (string) - Required
- **X-Secret** (string) - Required

### Response
#### Success Response (200)
- **id** (string) - Идентификатор подписки
- **status** (string) - Статус подписки
- **amount** (integer) - Сумма списания
- **currencyCode** (string) - Код валюты
- **intervalUnit** (string) - Единица интервала
- **intervalCount** (integer) - Количество интервалов
- **startAt** (string) - Дата начала
- **nextChargeAt** (string) - Дата следующего списания
- **lastChargeAt** (string) - Дата последнего списания
- **description** (string) - Описание
- **createdAt** (string) - Дата создания
- **customerEmail** (string) - Email клиента
- **chargeMetrics** (object) - Метрики списаний

#### Response Example
{
  "id": "11111111-1111-1111-1111-111111111111",
  "status": "Active",
  "amount": 100,
  "currencyCode": "RUB",
  "intervalUnit": "Month",
  "intervalCount": 1,
  "startAt": "2026-07-08T09:00:00Z",
  "nextChargeAt": "2026-08-09T09:10:00Z",
  "lastChargeAt": "2026-07-09T09:10:00Z",
  "description": "Premium подписка",
  "createdAt": "2026-07-08T09:00:00Z",
  "customerEmail": "payer@example.com",
  "chargeMetrics": {
    "chargesTotal": 1,
    "chargesSuccess": 1,
    "chargesFailed": 0,
    "totalAmount": 100,
    "lastChargeAt": "2026-07-09T09:10:00Z",
    "nextChargeAt": "2026-08-09T09:10:00Z"
  }
}
```

--------------------------------

### GET /transaction/{id}

Source: https://docs.platega.io/%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D1%8B-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B0-29203844e0

Возвращает статус и детали транзакции по указанному ID.

```APIDOC
## GET /transaction/{id}

### Description
Возвращает статус и детали транзакции.

### Method
GET

### Endpoint
/transaction/{id}

### Parameters
#### Path Parameters
- **id** (string, uuid) - Required - ID транзакции

#### Headers
- **X-MerchantId** (string) - Required - Идентификатор мерчанта
- **X-Secret** (string) - Required - API ключ

### Response
#### Success Response (200)
- **id** (string, uuid) - ID транзакции
- **status** (string) - Статус транзакции (PENDING, CANCELED, CONFIRMED, CHARGEBACKED)
- **paymentDetails** (object) - Детали платежа (amount, currency)
- **merchantName** (string) - Имя мерчанта
- **mechantId** (string, uuid) - ID мерчанта
- **comission** (number) - Комиссия
- **paymentMethod** (string) - Метод оплаты
- **expiresIn** (string) - Время до истечения
- **return** (string, uri) - URL возврата
- **comissionUsdt** (number) - Комиссия в USDT
- **amountUsdt** (number) - Сумма в USDT
- **qr** (string) - QR код
- **payformSuccessUrl** (string, uri) - URL успешной оплаты
- **payload** (string) - Пользовательские данные
- **comissionType** (integer) - Тип комиссии
- **externalId** (string) - Внешний ID
- **description** (string) - Описание платежа

#### Response Example
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING",
  "paymentDetails": {
    "amount": 2000,
    "currency": "RUB"
  },
  "merchantName": "Demo Merchant",
  "mechantId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "comission": 0,
  "paymentMethod": "SBPQR",
  "expiresIn": "00:15:00",
  "return": "https://example.com/success",
  "comissionUsdt": 1.64044944,
  "amountUsdt": 10.8988764,
  "qr": "base64-qr-data-or-url",
  "payformSuccessUrl": "https://pay.platega.io/success",
  "payload": "custom-payload",
  "comissionType": 1,
  "externalId": "0000a4f3-0000-0000-b8ac-fcb675a0000a",
  "description": "Оплата заказа #12345"
}
```

--------------------------------

### Create Subscription

Source: https://docs.platega.io/llms.txt

Creates a recurring SBP subscription. The system handles binding, activation, and subsequent charges, notifying the user via callbacks.

```APIDOC
## POST /subscriptions

### Description
Creates a recurring SBP subscription for automatic charges. The user is redirected to the payment form for initial setup.
```

--------------------------------

### GET /h2h/{id}

Source: https://docs.platega.io/%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-qr-%D0%BA%D0%BE%D0%B4%D0%B0-%D0%B4%D0%BB%D1%8F-h2h-%D1%82%D1%80%D0%B0%D0%BD%D0%B7%D0%B0%D0%BA%D1%86%D0%B8%D0%B8-34794775e0

Возвращает QR-код или платежную ссылку для указанной H2H-транзакции.

```APIDOC
## GET /h2h/{id}

### Description
Возвращает QR-код или платежную ссылку для H2H-транзакции.

### Method
GET

### Endpoint
/h2h/{id}

### Parameters
#### Path Parameters
- **id** (string, uuid) - Required - ID транзакции

#### Header Parameters
- **X-MerchantId** (string) - Required - Ваш MerchantId
- **X-Secret** (string) - Required - Ваш API ключ

### Response
#### Success Response (200)
- **amount** (number) - Сумма транзакции
- **qr** (string) - Ссылка на QR-код

#### Response Example
{
  "amount": 136.12,
  "qr": "https://qr.nspk.ru/00000000000000000000000000?type=00&bank=000000000000&sum=00000&cur=RUB&crc=0000"
}

#### Error Response (400)
- Транзакция не найдена
```

--------------------------------

### POST /v2/transaction/process

Source: https://docs.platega.io/%D1%81%D0%BE%D0%B7%D0%B4%D0%B0%D0%BD%D0%B8%D0%B5-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%BD%D0%BE%D0%B9-%D1%81%D1%81%D1%8B%D0%BB%D0%BA%D0%B8-%D0%B1%D0%B5%D0%B7-%D0%B7%D0%B0%D0%B4%D0%B0%D0%BD%D0%BD%D0%BE%D0%B3%D0%BE-%D0%BC%D0%B5%D1%82%D0%BE%D0%B4%D0%B0-33845703e0

Creates a new transaction and returns payment details including a URL for the user to complete the payment.

```APIDOC
## POST /v2/transaction/process

### Description
Creates a transaction and returns data for payment. The transaction ID is generated automatically by the system. The payer selects the payment method upon visiting the page.

### Method
POST

### Endpoint
/v2/transaction/process

### Parameters
#### Header Parameters
- **X-MerchantId** (string) - Required - Merchant identifier
- **X-Secret** (string) - Required - Secret key for authentication

#### Request Body
- **paymentDetails** (object) - Required - Object containing amount and currency
- **description** (string) - Required - Description of the payment
- **return** (string) - Required - URL to redirect on success
- **failedUrl** (string) - Required - URL to redirect on failure
- **payload** (string) - Optional - Additional payment information
- **orderId** (string) - Optional - Internal order ID
- **metadata** (object) - Optional - Payment metadata including userId and userName

### Request Example
{
  "paymentDetails": {
    "amount": 500,
    "currency": "RUB"
  },
  "description": "Оплата мешков картошки клиенту №293",
  "return": "https://google.com/success",
  "failedUrl": "https://google.com/fail",
  "payload": "Дополнительная информация о платеже",
  "metadata": {
    "userId": "123456789",
    "userName": "@username",
    "clientIp": "111.47.86.11"
  }
}

### Response
#### Success Response (200)
- **transactionId** (string) - Unique transaction identifier
- **status** (string) - Current status of the transaction
- **url** (string) - Payment URL
- **expiresIn** (string) - Expiration time
- **rate** (number) - Exchange rate

#### Response Example
{
  "transactionId": "string",
  "status": "string",
  "url": "string",
  "expiresIn": "string",
  "rate": 0
}
```

--------------------------------

### Get Saved Cards

Source: https://docs.platega.io/%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D1%81%D0%BE%D1%85%D1%80%D0%B0%D0%BD%D1%91%D0%BD%D0%BD%D1%8B%D1%85-%D0%BA%D0%B0%D1%80%D1%82-39075563e0

Retrieves a list of saved cards. By default, only active cards are returned. Set `onlyActive=false` to include cards with DISABLED and PENDING statuses.

```APIDOC
## GET /api/v1/cards

### Description
Retrieves a list of saved cards. By default, only active cards are returned. Set `onlyActive=false` to include cards with DISABLED and PENDING statuses.

### Method
GET

### Endpoint
/api/v1/cards

### Parameters
#### Query Parameters
- **onlyActive** (string) - Optional - By default, can be omitted. If set to false, it will return cards with DISABLED and PENDING statuses as well.
- **Authorization** (string) - Required - Authorization header for request signing. Format: `PG-HMAC kid=<merchantId>, ts=<unix_timestamp>, sig=<base64_signature>`

### Request Example
```
GET /api/v1/cards?onlyActive=true \
  -H "Authorization: PG-HMAC kid=<merchantId>, ts=<unix_timestamp>, sig=<base64_signature>"
```

### Response
#### Success Response (200)
- **cardId** (string) - The unique identifier for the card.
- **masked** (string) - The masked card number (e.g., '•••• •••• •••• 4242').
- **last4** (string) - The last four digits of the card number.
- **brand** (string) - The brand of the card (e.g., 'Visa', 'Mastercard').
- **label** (string) - A user-defined label for the card.
- **status** (string) - The status of the card (e.g., 'ACTIVE', 'DISABLED', 'PENDING').

#### Response Example
```json
[
  {
    "cardId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "masked": "•••• •••• •••• 4242",
    "last4": "4242",
    "brand": "Visa",
    "label": "Основная карта",
    "status": "ACTIVE"
  },
  {
    "cardId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "masked": "•••• •••• •••• 1234",
    "last4": "1234",
    "brand": "Запасная",
    "label": "",
    "status": "DISABLED"
  }
]
```

### Request Signing (HMAC-SHA256)
String to sign: `METHOD\nPATH\ntimestamp`
- `timestamp`: Unix time in seconds. Server accepts requests within a ±300 second window.
- `sha256_hex(body)`: For GET requests, the body is absent, use `e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855`.

Signature: `Base64(HMAC-SHA256(SECRET, string_to_sign))`
Authorization Header: `Authorization: PG-HMAC kid={MERCHANT_ID}, ts={timestamp}, sig={signature}`
```

--------------------------------

### OpenAPI спецификация callback-уведомления

Source: https://docs.platega.io/callback-%D0%BF%D0%BE-%D1%81%D0%BF%D0%B8%D1%81%D0%B0%D0%BD%D0%B8%D1%8E-40029713e0

Определение webhook-события для обработки статусов списаний, включая примеры для подтвержденных и отмененных транзакций.

```yaml
openapi: 3.1.0
info:
  title: ''
  description: ''
  version: 1.0.0
paths: {}
webhooks:
  subscriptionTransactionStatus:
    post:
      summary: Callback по списанию
      deprecated: false
      description: >-
        Приходит на каждое списание — успешное и неуспешное. Отличается от
        callback'а обычного платежа только двумя дополнительными полями:
        SubscriptionId и NextChargeAt.
      operationId: paymentStatusCallback
      tags:
        - Платежи/Рекуррентные СБП-подписки
      parameters:
        - name: X-MerchantId
          in: header
          description: Ваш MerchantId (UUID)
          required: false
          example: ''
          schema:
            type: string
        - name: X-Secret
          in: header
          description: Ваш API ключ
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                Id:
                  type: string
                  description: 'Id — ID транзакции-списания (новый на каждое списание). '
                Amount:
                  type: integer
                Currency:
                  type: string
                Status:
                  description: >-
                    CONFIRMED — деньги списаны, баланс пополнен (сумма за
                    вычетом комиссии).


                    CANCELED — списание не прошло: баланс не меняется,
                    NextChargeAt = null, подписка переходит в PastDue (провайдер
                    не будет повторять попытки).
                  $ref: '#/components/schemas/PaymentStatus'
                PaymentMethod:
                  type: integer
                Payload:
                  type: string
                SubscriptionId:
                  type: string
                NextChargeAt:
                  type: string
              required:
                - Id
                - Amount
                - Currency
                - Status
                - PaymentMethod
                - Payload
                - SubscriptionId
                - NextChargeAt
              x-apidog-orders:
                - Id
                - Amount
                - Currency
                - Status
                - PaymentMethod
                - Payload
                - SubscriptionId
                - NextChargeAt
              x-apidog-ignore-properties: []
            examples:
              '1':
                value:
                  Id: 33333333-3333-3333-3333-333333333333
                  Amount: 100
                  Currency: RUB
                  Status: CONFIRMED
                  PaymentMethod: 6
                  Payload: ''
                  SubscriptionId: 11111111-1111-1111-1111-111111111111
                  NextChargeAt: '2026-08-09T09:10:00Z'
                summary: confirmed
              '2':
                value:
                  Id: 33333333-3333-3333-3333-333333333333
                  Amount: 100
                  Currency: RUB
                  Status: CANCELED
                  PaymentMethod: 6
                  Payload: ''
                  SubscriptionId: 11111111-1111-1111-1111-111111111111
                  NextChargeAt: null
                summary: canceled
      responses:
        '200':
          description: ''
          headers: {}
          x-apidog-name: OK
      security: []
      x-apidog-folder: Платежи/Рекуррентные СБП-подписки
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1213537/apis/api-40029713-run
components:
  schemas:
    PaymentStatus:
      type: string
      description: Статус транзакции
      enum:
        - PENDING
        - CANCELED
        - CONFIRMED
        - CHARGEBACKED
      x-apidog-folder: ''
  securitySchemes:
    MerchantIdAuth:
      type: apikey
      in: header
      name: X-MerchantId
      description: Ваш MerchantId (UUID)
    SecretAuth:
      type: apikey
      in: header
      name: X-Secret
      description: Ваш API ключ
    Combination:
      group:
        - id: 482006
        - id: 482007
      type: customize
    bearer:
      type: bearer
      scheme: bearer
servers: []
security: []
```

--------------------------------

### OpenAPI Specification for Transaction Status

Source: https://docs.platega.io/%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D1%81%D1%82%D0%B0%D1%82%D1%83%D1%81%D0%B0-%D0%BE%D0%BF%D0%BB%D0%B0%D1%82%D1%8B-%D0%BF%D0%BB%D0%B0%D1%82%D0%B5%D0%B6%D0%B0-29203844e0

Определение OpenAPI для метода GET /transaction/{id}, описывающее параметры пути, заголовки аутентификации и схему ответа TransactionStatusResponse.

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /transaction/{id}:
    get:
      summary: Проверка статуса оплаты платежа
      deprecated: false
      description: Возвращает статус и детали транзакции.
      operationId: getTransactionStatus
      tags:
        - Платежи
        - Payments
      parameters:
        - name: id
          in: path
          description: ID транзакции (UUID)
          required: true
          example: ''
          schema:
            type: string
            format: uuid
        - name: X-MerchantId
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: X-Secret
          in: header
          description: ''
          required: true
          example: ''
          schema:
            type: string
      responses:
        '200':
          description: Данные транзакции
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionStatusResponse'
              example:
                id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                status: PENDING
                paymentDetails:
                  amount: 2000
                  currency: RUB
                merchantName: Demo Merchant
                mechantId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                comission: 0
                paymentMethod: SBPQR
                expiresIn: '00:15:00'
                return: https://example.com/success
                comissionUsdt: 1.64044944
                amountUsdt: 10.8988764
                qr: base64-qr-data-or-url
                payformSuccessUrl: https://pay.platega.io/success
                payload: custom-payload
                comissionType: 1
                externalId: 0000a4f3-0000-0000-b8ac-fcb675a0000a
                description: 'Оплата заказа #12345'
          headers: {}
          x-apidog-name: ''
        '404':
          description: Транзакция не найдена
          headers: {}
          x-apidog-name: ''
      security: []
      x-apidog-folder: Платежи
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1213537/apis/api-29203844-run
components:
  schemas:
    TransactionStatusResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        status:
          $ref: '#/components/schemas/PaymentStatus'
        paymentDetails:
          type: object
          properties:
            amount:
              type: number
            currency:
              type: string
          x-apidog-orders:
            - amount
            - currency
          x-apidog-ignore-properties: []
        merchantName:
          type: string
        mechantId:
          type: string
          format: uuid
        comission:
          type: number
        paymentMethod:
          type: string
          description: Название метода оплаты (например, SBPQR)
        expiresIn:
          type: string
        return:
          type: string
          format: uri
        comissionUsdt:
          type: number
        amountUsdt:
          type: number
        qr:
          type: string
        payformSuccessUrl:
          type: string
          format: uri
        payload:
          type: string
        comissionType:
          type: integer
        externalId:
          type: string
        description:
          type: string
      x-apidog-orders:
        - id
        - status
        - paymentDetails
        - merchantName
        - mechantId
        - comission
        - paymentMethod
        - expiresIn
        - return
        - comissionUsdt
        - amountUsdt
        - qr
        - payformSuccessUrl
        - payload
        - comissionType
        - externalId
        - description
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    PaymentStatus:
      type: string
      description: Статус транзакции
      enum:
        - PENDING
        - CANCELED
        - CONFIRMED
        - CHARGEBACKED
      x-apidog-folder: ''
  securitySchemes:
    MerchantIdAuth:
      type: apikey
      in: header
      name: X-MerchantId
      description: Ваш MerchantId (UUID)
    SecretAuth:
      type: apikey
      in: header
      name: X-Secret
      description: Ваш API ключ
    Combination:
      group:
        - id: 482006
        - id: 482007
      type: customize
    bearer:
      type: bearer
      scheme: bearer
servers: []
security: []
```
Tokens:
Raw