UrlPay API

https://urlpay.io/docs/
Admin
UrlPay API provides a comprehensive set of functionalities for online stores to process payments,...
Tokens:14,396
Snippets:27
Trust Score:4.6
Update:1 year ago
Show doc for...
Tokens:
Raw
### Get Subscriptions (GET /v2/subscribes)

Source: https://urlpay.io/docs/api

Retrieves a list of subscriptions associated with the shop. Includes details like ID, description, status, currency, amount, and payment dates.

```APIDOC
GET /v2/subscribes

Description: Retrieves a list of subscriptions.
Authorization: api-key

Responses:
  200 OK (List of subscriptions)
  401 Unauthorized
  422 Unprocessable Entity (Validation error)

Response Sample (200):
{
  "items": [
    {
      "id": 1,
      "description": "string",
      "status": 0,
      "currency": "rub",
      "amount": "1000.50",
      "start_date": "string",
      "next_pay_date": "string",
      "interval": null
    }
  ]
}
```

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

### Get Shop Balances (GET /v2/shops/{shopId}/balances)

Source: https://urlpay.io/docs/api

Retrieves the balances for a specific shop, including current balance, hold amount, and available balance per currency.

```APIDOC
GET /v2/shops/{shopId}/balances

Description: Retrieves shop balances.
Authorization: api-key
Path Parameters:
  shopId (integer, required): The ID of the shop.

Responses:
  200 OK (List of shop balances)
  401 Unauthorized
  403 Forbidden
  422 Unprocessable Entity (Validation error)

Response Sample (200):
{
  "success": true,
  "data": {
    "balances": [
      {
        "shop_id": 5,
        "currency": "rub",
        "balance": 1000.5,
        "hold": 200,
        "available": 800.5
      }
    ]
  }
}
```

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

### URLPay API: Get Shop Balances

Source: https://urlpay.io/docs/api/definition

Retrieves the list of balances for a shop. Supports filtering and returns success status, balance data, and potential errors like unauthorized access or validation issues.

```APIDOC
/v1/balances:
  get:
    summary: Получение списка балансов магазина
    tags:
      - Балансы
    parameters:
      - name: shop_id
        in: query
        required: false
        description: ID магазина для фильтрации
        schema:
          type: integer
    responses:
      '200':
        description: Список балансов магазина
        content:
          application/json:
            schema:
              properties:
                success:
                  type: boolean
                  description: Флаг успеха
                  example: true
                data:
                  type: object
                  properties:
                    balances:
                      type: array
                      items:
                        $ref: '#/components/schemas/Balance'
      '401':
        description: Unauthorized
        content:
          application/json:
            example:
              error: unauthorized
              status: 401
      '403':
        description: Forbidden
        content:
          application/json:
            example:
              success: false
              message: Магазин не найден или не принадлежит текущему пользователю
      '422':
        description: Ошибка валидации данных
        content:
          application/json:
            example:
              success: false
              message: Ошибка валидации
              errors:
                shop_id: [ "Поле shop_id должно быть целым числом." ]
```

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

### URLPay API: Get Card Payouts

Source: https://urlpay.io/docs/api

Retrieves a list of card payouts with filtering options. Supports pagination and various query parameters for precise data retrieval.

```APIDOC
GET /v2/card-payouts

Query Parameters:
shop_id (integer): ID of the shop for filtering.
status (string): Payout status for filtering.
currency (string): Currency for filtering.
payout_type (string): Type of payout for filtering (Enum: "card", "account").
date_from (string): Start date of the period.
date_to (string): End date of the period.
per_page (integer): Number of items per page (1-100), default 15.
page (integer): Page number, default 1.
search (string): Search by external_id, recipient name, card/account number, description (max 255 characters).

Responses:
200: List of payouts.
401: Unauthorized.
422: Data validation error.

Response Sample (200):
{
  "success": true,
  "data": [
    {
      "id": 1,
      "user_id": 1,
      "shop_id": 5,
      "external_id": "payout_123",
      "payout_type": "card",
      "recipient_card_number": "1234****3456",
      "recipient_account_number": "40817810099910004312",
      "recipient_bank_code": "044525225",
      "recipient_name": "Иванов Иван Иванович",
      "recipient_phone": "+79001234567",
      "amount": 1000.5,
      "amount_with_fee": 1005.5,
      "currency": "rub",
      "status": "pending",
      "description": "Выплата за услуги",
      "comment": "Дополнительная информация",
      "metadata": {},
      "cancelled_reason": "Запрос от клиента",
      "processed_at": "2023-10-01T12:00:00Z",
      "created_at": "2023-10-01T10:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z",
      "user": {
        "id": 1,
        "name": "Иван Иванов",
        "email": "user@example.com"
      },
      "shop": {
        "id": 5,
        "name": "Мой магазин",
        "url": "https://myshop.com"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "last_page": 10,
    "per_page": 15,
    "total": 150
  }
}
```

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

### Get Available Payout Currencies

Source: https://urlpay.io/docs/api

Retrieves a list of currencies that are available for payouts. The response maps currency codes to their full names.

```APIDOC
get/v2/card-payouts/currencies
Production server
https://urlpay.io/api/v2/card-payouts/currencies
### Response samples
* 200
Content type
application/json
`{
  "success": true,
  "data": {
    "rub": "Российский рубль"
  }
}`
```

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

### Get Available Payout Statuses

Source: https://urlpay.io/docs/api

Retrieves a list of available payout statuses. The response provides string representations for different payout statuses.

```APIDOC
get/v2/card-payouts/statuses
Production server
https://urlpay.io/api/v2/card-payouts/statuses
### Response samples
* 200
Content type
application/json
`{
  "success": true,
  "data": {
    "property1": "string",
    "property2": "string"
  }
}`
```

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

### Get Available Payout Types

Source: https://urlpay.io/docs/api

Retrieves a list of available payout types. The response maps payout type identifiers to their descriptive text.

```APIDOC
get/v2/card-payouts/types
Production server
https://urlpay.io/api/v2/card-payouts/types
### Response samples
* 200
Content type
application/json
`{
  "success": true,
  "data": {
    "card": "На карту",
    "account": "На счет"
  }
}`
```

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

### Get Payment Receipt (GET /v2/payments/{id}/receipt)

Source: https://urlpay.io/docs/api

Retrieves detailed information about a specific payment receipt, including item details, fiscal information, and status. Requires the payment ID.

```APIDOC
GET /v2/payments/{id}/receipt

Description: Retrieves detailed information about a payment receipt.
Authorization: api-key
Path Parameters:
  id (integer, required): The ID of the payment for which to get the receipt.

Responses:
  200 Success (Receipt data retrieved)
  401 Unauthorized
  404 Not Found (Receipt not found)

Response Sample (200):
{
  "status": "success",
  "items": [
    {
      "id": 1,
      "daemon_code": "DAEMON123",
      "device_code": "DEVICE456",
      "warnings": [
        "Warning 1",
        "Warning 2"
      ],
      "error": [
        "Error 1",
        "Error 2"
      ],
      "ecr_registration_number": "REG123456",
      "fiscal_document_attribute": 1,
      "fiscal_document_number": 1001,
      "fiscal_receipt_number": 5001,
      "fn_number": "FN123456",
      "fns_site": "https://fns.ru",
      "receipt_datetime": "2023-10-01T12:00:00Z",
      "shift_number": 1,
      "total": 1000.5,
      "ofd_inn": "1234567890",
      "ofd_receipt_url": "https://ofd.example.com/receipt/1",
      "status": "success",
      "uuid": "invoice_123",
      "created_at": "2023-10-01T12:00:00Z",
      "updated_at": "2023-10-01T12:00:00Z"
    }
  ]
}
```

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

### Get Payout Summary

Source: https://urlpay.io/docs/api

Retrieves a summary of payouts, including total count, total amount, and breakdowns by status, currency, and type. The response includes detailed counts and amounts for each category.

```APIDOC
get/v2/card-payouts
Production server
https://urlpay.io/api/v2/card-payouts
### Response samples
* 200
Content type
application/json
`{
  "success": true,
  "data": {
    "total_count": 150,
    "total_amount": 50000,
    "by_status": {
      "property1": {
        "text": "Ожидает обработки",
        "count": 25,
        "amount": 10000
      },
      "property2": {
        "text": "Ожидает обработки",
        "count": 25,
        "amount": 10000
      }
    },
    "by_currency": {
      "property1": {
        "text": "Российский рубль",
        "count": 150,
        "amount": 50000
      },
      "property2": {
        "text": "Российский рубль",
        "count": 150,
        "amount": 50000
      }
    },
    "by_type": {
      "property1": {
        "text": "На карту",
        "count": 100,
        "amount": 35000
      },
      "property2": {
        "text": "На карту",
        "count": 100,
        "amount": 35000
      }
    }
  }
}`
```

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

### Get Payout by External ID

Source: https://urlpay.io/docs/api

Retrieves payout information using its external ID. It can optionally filter by shop ID. Returns detailed payout data or error messages for unauthorized access, not found, or validation errors.

```APIDOC
##### Authorizations:
_api-key_
##### path Parameters
external_idrequired |  string Внешний ID выплаты  
---|---
##### query Parameters
shop_id |  integer ID магазина для дополнительной фильтрации  
---|---
### Responses
**200**
Данные выплаты
**401**
Unauthorized
**404**
Выплата не найдена
**422**
Ошибка валидации данных
get/v2/card-payouts/external/{external_id}
Production server
https://urlpay.io/api/v2/card-payouts/external/{external_id}
### Response samples
* 200
Content type
application/json
`{
  "success": true,
  "data": {
    "id": 1,
    "user_id": 1,
    "shop_id": 5,
    "external_id": "payout_123",
    "payout_type": "card",
    "recipient_card_number": "1234****3456",
    "recipient_account_number": "40817810099910004312",
    "recipient_bank_code": "044525225",
    "recipient_name": "Иванов Иван Иванович",
    "recipient_phone": "+79001234567",
    "amount": 1000.5,
    "amount_with_fee": 1005.5,
    "currency": "rub",
    "status": "pending",
    "description": "Выплата за услуги",
    "comment": "Дополнительная информация",
    "metadata": { },
    "cancelled_reason": "Запрос от клиента",
    "processed_at": "2023-10-01T12:00:00Z",
    "created_at": "2023-10-01T10:00:00Z",
    "updated_at": "2023-10-01T12:00:00Z",
    "user": {
      "id": 1,
      "name": "Иван Иванов",
      "email": "user@example.com"
    },
    "shop": {
      "id": 5,
      "name": "Мой магазин",
      "url": "https://myshop.com"
    }
  }
}`
```

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

### Get Payout by ID

Source: https://urlpay.io/docs/api

Retrieves specific payout information using its unique ID. This endpoint returns detailed payout data upon successful retrieval and provides error responses for unauthorized access or if the payout is not found.

```APIDOC
##### Authorizations:
_api-key_
##### path Parameters
idrequired |  integer ID выплаты  
---|---
### Responses
**200**
Данные выплаты
**401**
Unauthorized
**404**
Выплата не найдена
get/v2/card-payouts/{id}
Production server
https://urlpay.io/api/v2/card-payouts/{id}
```

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

### URLPay API: Create Card Payout

Source: https://urlpay.io/docs/api

Creates a new card payout. Requires shop ID, external ID, payout type, recipient name, amount, and currency. Supports various optional fields for payout details.

```APIDOC
POST /v2/card-payouts

Authorizations:
_api-key_

Request Body Schema (application/json):
shop_id (integer, required): Shop ID.
external_id (string, required): External payout ID (must be unique, max 255 characters).
payout_type (string, required): Type of payout (Enum: "card", "account").
recipient_card_number (string): Recipient card number (required for type "card", max 19 characters).
recipient_account_number (string): Recipient account number (required for type "account", max 50 characters).
recipient_bank_code (string): Recipient bank code (max 20 characters).
recipient_name (string, required): Recipient's full name (max 255 characters).
recipient_phone (string): Recipient's phone number (max 20 characters).
amount (number, required): Payout amount (float, 0.01 to 999999.99).
currency (string, required): Payout currency (Value: "rub").
description (string): Payout description (max 500 characters).
comment (string): Comment for the payout (max 1000 characters).
metadata (object): Additional data.

Responses:
201: Payout created successfully.
401: Unauthorized.
403: Payouts disabled for the shop.
404: Shop not found.
422: Data validation error.
500: Error creating payout.

Request Sample (Payload):
{
  "shop_id": 5,
  "external_id": "payout_123",
  "payout_type": "card",
  "recipient_card_number": "1234567890123456",
  "recipient_account_number": "40817810099910004312",
  "recipient_bank_code": "044525225",
  "recipient_name": "Иванов Иван Иванович",
  "recipient_phone": "+79001234567",
  "amount": 1000.5,
  "currency": "rub",
  "description": "Выплата за услуги",
  "comment": "Дополнительная информация",
  "metadata": {
    "order_id": "12345",
    "department": "sales"
  }
}
```

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

### UrlPay API V1 Endpoints

Source: https://urlpay.io/docs/api/definition

This section details the available API endpoints for managing payments within the UrlPay system. It covers creating new payments, retrieving payment lists and individual payment details, confirming and canceling transactions, and processing refunds.

```APIDOC
openapi: 3.0.3
info:
  title: UrlPay API V1
  version: 1.0.0
  description: |- 
    Прием платежей и выплаты через UrlPay
paths:
  /v2/payments:
    post:
      summary: Создание платежа
      tags:
        - Платежи
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '201':
          description: Платеж
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                    description: Флаг успеха
                    example: true
                  paymentUrl:
                    type: string
                    description: URL для оплаты
                    example: https://site.ru/
                  id:
                    type: integer
                    description: ID платежа
                    example: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422
    get:
      summary: Получение списка платежей
      tags:
        - Платежи
      responses:
        '200':
          description: Список платежей
          content:
            application/json:
              schema:
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422
  /v2/payments/{id}:
    get:
      summary: Получение данных по платежу
      tags:
        - Платежи
      responses:
        '200':
          description: Платеж
          content:
            application/json:
              schema:
                properties:
                  success:
                    type: boolean
                    description: Флаг успеха
                    example: true
                  payment:
                    $ref: '#/components/schemas/Payment'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422
  /v2/payments/{id}/hold:
    put:
      summary: Подтверждение списания средств
      tags:
        - Платежи
      responses:
        200:
          description: OK
          content:
            application/json:
              example:
                success: true
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422
    delete:
      summary: Отмена списания средств
      tags:
        - Платежи
      responses:
        200:
          description: OK
          content:
            application/json:
              example:
                success: true
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422
  /v2/payments/{id}/refund:
    put:
      summary: Возврат платежа
      tags:
        - Платежи
      responses:
        200:
          description: OK
          content:
            application/json:
              example:
                success: true
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: unauthorized
                status: 401
        '422':
          description: Ошибка валидации данных
          content:
            application/json:
              example:
                error: 'param is missing or the value is empty: article'
                status: 422

```

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

### Send Payment Callback (POST /payments/callback)

Source: https://urlpay.io/docs/api

Sends a callback request for a payment to a configured URL. Includes payment details like ID, amount, currency, UUID, and status.

```APIDOC
POST /payments/callback

Description: Sends a callback request for a payment.
Authorization: api-key
Request Body Schema (application/json):
  id (integer, required): Payment ID.
  amount (number, required): Payment amount.
  currency (string, required): Payment currency (e.g., RUB).
  uuid (string, required): External payment identifier.
  payment_status (string, required): Payment status for callback (e.g., "success", "cancel").

Responses:
  200 OK (Callback request sent successfully)
  400 Bad Request (Invalid payment data or callback URL missing)
  404 Not Found (Payment not found)

Request Sample (Payload):
{
  "id": 12345,
  "amount": 100.5,
  "currency": "RUB",
  "uuid": "external-uuid-123",
  "payment_status": "success"
}
```

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

### URLPay API: Card Payouts Management

Source: https://urlpay.io/docs/api/definition

Manages card payouts, including retrieving a list of payouts with filtering options (shop ID, status, currency, date, etc.) and creating new payouts. Supports bulk creation.

```APIDOC
/v2/card-payouts:
  get:
    summary: Получение списка выплат
    tags:
      - Выплаты
    parameters:
      - name: shop_id
        in: query
        required: false
        description: ID магазина для фильтрации
        schema:
          type: integer
      - name: status
        in: query
        required: false
        description: Статус выплаты для фильтрации
        schema:
          type: string
      - name: currency
        in: query
        required: false
        description: Валюта для фильтрации
        schema:
          type: string
      - name: payout_type
        in: query
        required: false
        description: Тип выплаты для фильтрации
        schema:
          type: string
          enum: [ card, account ]
      - name: date_from
        in: query
        required: false
        description: Дата начала периода
        schema:
          type: string
          format: date
      - name: date_to
        in: query
        required: false
        description: Дата окончания периода
        schema:
          type: string
          format: date
      - name: per_page
        in: query
        required: false
        description: Количество элементов на странице (1-100)
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 15
      - name: page
        in: query
        required: false
        description: Номер страницы
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: search
        in: query
        required: false
        description: Поиск по external_id, имени получателя, номеру карты/счета, описанию
        schema:
          type: string
          maxLength: 255
    responses:
      '200':
        description: Список выплат
        content:
          application/json:
            schema:
              properties:
                success:
                  type: boolean
                  example: true
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/CardPayout'
                pagination:
                  $ref: '#/components/schemas/Pagination'
      '401':
        description: Unauthorized
      '422':
        description: Ошибка валидации данных
  post:
    summary: Создание новой выплаты
    tags:
      - Выплаты
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CardPayoutRequest'
    responses:
      '201':
        description: Выплата успешно создана
        content:
          application/json:
            schema:
              properties:
                success:
                  type: boolean
                  example: true
                message:
                  type: string
                  example: "Выплата успешно создана"
                data:
                  $ref: '#/components/schemas/CardPayout'
      '401':
        description: Unauthorized
      '403':
        description: Выплаты для магазина отключены
      '404':
        description: Магазин не найден
      '422':
        description: Ошибка валидации данных
      '500':
        description: Ошибка при создании выплаты

/v2/card-payouts/bulk:
  post:
    summary: Массовое создание выплат
    tags:
      - Выплаты
    requestBody:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/CardPayoutRequest'
```

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

### URLPay Payment Request Schema

Source: https://urlpay.io/docs/api/definition

Defines the structure for a payment request, including required fields like currency, amount, shop ID, description, signature, UUID, and items. It also details optional fields such as website URL, subscription type, hold time, and language.

```APIDOC
PaymentRequest:
  description: Запрос платежа
  required:
    - currency
    - amount
    - shopId
    - description
    - sign
    - uuid
    - items
  type: object
  properties:
    currency:
      type: string
      description: Валюта оплаты (rub)
      example: rub
      enum: ['rub']
    amount:
      type: number
      description: Сумма оплаты с копейками строкой 100.50
      example: "1000.50"
    uuid:
      type: string
      description: Uuid заказа на строное магазина
      example: invoice_123
    shopId:
      type: integer
      description: ID магазина из ЛК
      example: 5
    description:
      type: string
      description: Описание платежа
      example: Покупка булочек
    website_url:
      type: string
      description: Ссылка на сайт магазина
      example: https://example.com
    subscribe:
      type: string
      description: Подписка, если не требуется то null, варианты данных - Day, Week, Month
      example: null
      enum: ['Day', 'Week', 'Month']
    holdTime:
      type: integer
      description: Время в секундах, на которое происходит холд денег клиента. После гое истечения происходит отмена. Либо нужно подтвердить списание
      example: null
    language:
      type: string
      description: Язык формы оплаты
      example: ru
    items:
      type: array
      items:
        type: object
        required:
          - description
          - price
          - quantity
          - vat_code
          - payment_subject
          - payment_mode
        properties:
          description:
            type: string
            description: Описание товара
          quantity:
            type: number
            description: Количество товара
          price:
            type: number
            description: Цена товара
          vat_code:
            type: integer
            description: |
              Код ставки НДС. Возможные значения:
              - 0: Без НДС
              - 1: НДС по ставке 0%
              - 2: НДС чека по ставке 10%
              - 3: НДС чека по ставке 18%
              - 4: НДС чека по расчетной ставке 10/110
              - 5: НДС чека по расчетной ставке 18/118
              - 6: НДС чека по ставке 20%
              - 7: НДС чека по расчетной ставке 20/120
            enum: [0, 1, 2, 3, 4, 5, 6, 7]
          payment_subject:
            type: integer
            description: |
              Код предмета платежа. Возможные значения:

              - 1: Товар
              - 2: Подакцизный товар
              - 3: Работа
              - 4: Услуга
              - 5: Ставка азартной игры
              - 6: Выигрыш азартной игры
              - 7: Лотерейный билет
              - 8: Выигрыш лотереи
              - 9: Предоставление РИД
              - 10: Платеж
              - 11: Агентское вознаграждение
              - 12: Выплата
              - 13: Иной предмет расчета
              - 14: Имущественное право
              - 15: Внереализационный доход
              - 16: Иные платежи и взносы
              - 17: Торговый сбор
              - 19: Залог
              - 20: Расход
              - 21: Взносы на обязательное пенсионное страхование ИП
              - 22: Взносы на обязательное пенсионное страхование
              - 23: Взносы на обязательное медицинское страхование ИП
              - 24: Взносы на обязательное медицинское страхование
              - 25: Взносы на обязательное социальное страхование
              - 26: Платеж казино
            enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26 ]
          payment_mode:
            type: integer
            description: |
              Код метода платежа
               - 1: Полная предоплата
               - 2: Частичная предоплата
               - 3: Аванс
               - 4: Полный расчет
               - 5: Частичный расчет и кредит
               - 6: Кредит
               - 7: Выплата по кредиту
            enum: [ 1, 2, 3, 4, 5, 6, 7 ]
          product_code:
            type: string
            nullable: true
```

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

### Refund Payment (PUT /v2/payments/{id}/refund)

Source: https://urlpay.io/docs/api

Initiates a refund for a specific payment. Requires the payment ID in the URL. Returns a success status upon successful request.

```APIDOC
PUT /v2/payments/{id}/refund

Description: Initiates a refund for a specific payment.
Authorization: api-key

Responses:
  200 OK
  401 Unauthorized
  422 Unprocessable Entity (Validation error)

Response Sample (200):
{
  "success": true
}
```

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

### URLPay API: Bulk Card Payout Creation

Source: https://urlpay.io/docs/api

Allows for the creation of multiple card payouts in a single request. It requires a shop ID and an array of payout objects, each containing details like external ID, payout type, recipient information, amount, currency, description, and optional metadata. The response includes a success status, a message, and data on the created payouts.

```APIDOC
POST /v2/card-payouts/bulk

Production server: https://urlpay.io/api/v2/card-payouts/bulk

Authorizations:
_api-key_

Request Body schema: application/json
shop_id (required): integer - ID магазина
payouts (required): Array of objects [1..100] items - Массив выплат для создания
  - external_id: string
  - payout_type: string
  - recipient_card_number: string
  - recipient_account_number: string
  - recipient_bank_code: string
  - recipient_name: string
  - recipient_phone: string
  - amount: number
  - currency: string
  - description: string
  - comment: string
  - metadata: object

Responses:
201: Выплаты успешно созданы
401: Unauthorized
403: Выплаты для магазина отключены
404: Магазин не найден
422: Ошибка валидации данных
500: Ошибка при создании выплат

Request samples:
Payload:
{
  "shop_id": 5,
  "payouts": [
    {
      "external_id": "payout_123",
      "payout_type": "card",
      "recipient_card_number": "1234567890123456",
      "recipient_account_number": "40817810099910004312",
      "recipient_bank_code": "044525225",
      "recipient_name": "Иванов Иван Иванович",
      "recipient_phone": "+79001234567",
      "amount": 1000.5,
      "currency": "rub",
      "description": "Выплата за услуги",
      "comment": "Дополнительная информация",
      "metadata": { }
    }
  ]
}

Response samples:
201:
{
  "success": true,
  "message": "Выплаты успешно созданы",
  "data": {
    "created_count": 5,
    "payouts": [
      {
        "id": 1,
        "user_id": 1,
        "shop_id": 5,
        "external_id": "payout_123",
        "payout_type": "card",
        "recipient_card_number": "1234****3456",
        "recipient_account_number": "40817810099910004312",
        "recipient_bank_code": "044525225",
        "recipient_name": "Иванов Иван Иванович",
        "recipient_phone": "+79001234567",
        "amount": 1000.5,
        "amount_with_fee": 1005.5,
        "currency": "rub",
        "status": "pending",
        "description": "Выплата за услуги",
        "comment": "Дополнительная информация",
        "metadata": { },
        "cancelled_reason": "Запрос от клиента",
        "processed_at": "2023-10-01T12:00:00Z",
        "created_at": "2023-10-01T10:00:00Z",
        "updated_at": "2023-10-01T12:00:00Z",
        "user": {
          "id": 1,
          "name": "Иван Иванов",
          "email": "user@example.com"
        },
        "shop": {
          "id": 5,
          "name": "Мой магазин",
          "url": "https://myshop.com"
        }
      }
    ]
  }
}
```

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

### URLPay Pagination Schema

Source: https://urlpay.io/docs/api/definition

Defines the structure for pagination information, including the current page, last page, items per page, and total number of items.

```APIDOC
pagination:
  type: object
  properties:
    current_page:
      type: integer
      description: Текущая страница
      example: 1
    last_page:
      type: integer
      description: Последняя страница
      example: 10
    per_page:
      type: integer
      description: Элементов на странице
      example: 15
    total:
      type: integer
      description: Общее количество элементов
      example: 150
```

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

### Pagination Information

Source: https://urlpay.io/docs/api/definition

Defines the structure for pagination information, including the current page number.

```APIDOC
Pagination:
  description: Информация о пагинации
  type: object
  properties:
    current_page:

```
Tokens:
Raw