openapi: 3.0.3
info:
  title: 'MagicPayments API'
  description: 'MagicPayments API'
  version: 1.0.0
servers:
  -
    url: 'https://api.magic-payments.com'
paths:
  '/api/{wallet_uuid}/invoice':
    post:
      summary: Пополнение
      operationId: ''
      description: "Запрос на пополнение кошелька\n<aside>Если передан параметр calculate=true, то производится предварительный расчет комиссии. В ответе отсутствует блок transaction и присутствует блок addition_data (если разрешено настройками) </aside>\n<aside>Если у вас доступен способ пополнения host2host, то следует передать параметр card. Если при пополнении потребуется 3DS, то в url вернется ссылка для перенаправления на страницу проверки. Для тестового кошелька номера карт 2201382000000013 и 2201382000000021 возвращают ошибку. </aside>"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  comission: 12.5
                  total: 487.5
                  amount: 500
                  url: 'https://example.com/redirect'
                  transaction:
                    currency: RUB
                    order: '73450234'
                    uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    created_at: '2024-01-26T09:59:01.000000Z'
                    status_transaction: created
                    total: 487.5
                    amount: 500
                    type_alias: payin
                    card_mask: null
                properties:
                  status:
                    type: string
                    example: success
                    description: 'Статус запроса'
                    enum: []
                  comission:
                    type: number
                    example: 12.5
                    description: ''
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма к зачислению'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма к оплате'
                    enum: []
                  url:
                    type: string
                    example: 'https://example.com/redirect'
                    description: 'URL для перенаправления на страницу оплаты'
                    enum: []
                  transaction:
                    type: object
                    properties:
                      currency:
                        type: string
                        example: RUB
                        description: 'Код валюты в ISO 4217'
                        enum: []
                      order:
                        type: string
                        example: '73450234'
                        description: 'Внешний идентификатор'
                        enum: []
                      uuid:
                        type: string
                        example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                        description: 'UUID транзакции'
                        enum: []
                      created_at:
                        type: string
                        example: '2024-01-26T09:59:01.000000Z'
                      status_transaction:
                        type: string
                        example: created
                        description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                        enum: []
                      total:
                        type: number
                        example: 487.5
                      amount:
                        type: integer
                        example: 500
                      type_alias:
                        type: string
                        example: payin
                        description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                        enum: []
                      card_mask:
                        type: string
                        example: null
                        description: 'Маска карты (может быть null)'
                        enum: []
                    description: 'Блок описания транзакции (отсутствует если calculate=true)'
        400:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  error: 'Данный канал не поддерживает рекуррентные платежи'
                  code: recurrent_not_supported
                properties:
                  status:
                    type: string
                    example: error
                    description: 'Статус запроса'
                    enum: []
                  error:
                    type: string
                    example: 'Данный канал не поддерживает рекуррентные платежи'
                  code:
                    type: string
                    example: recurrent_not_supported
        422:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  error:
                    amount:
                      - 'Поле amount должно быть числом.'
                properties:
                  status:
                    type: string
                    example: error
                    description: 'Статус запроса'
                    enum: []
                  error:
                    type: object
                    properties:
                      amount:
                        type: array
                        example:
                          - 'Поле amount должно быть числом.'
                        items:
                          type: string
      tags:
        - Операции
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: 'Сумма к пополнению'
                  example: 1000.0
                  nullable: false
                currency:
                  type: string
                  description: 'Код валюты в ISO 4217'
                  example: USD
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                calculate:
                  type: boolean
                  description: 'Рассчитать комиссию'
                  example: false
                  nullable: false
                tokenize_card:
                  type: boolean
                  description: 'Получить токен карты (для рекуррентных платежей)'
                  example: false
                  nullable: false
                tag:
                  type: string
                  description: 'Тэг терминала.'
                  example: trusted
                  nullable: false
                lang:
                  type: string
                  description: 'Язык формы для ввода карты. Возможные значения: ru, en, kz, uz'
                  example: en
                  nullable: false
                callback_method:
                  type: string
                  description: 'Определяет метод вызова callback. Возможные значения: POST, GET'
                  example: POST
                  nullable: false
                callback_url:
                  type: string
                  description: 'Callback url вызывается GET/POST (определяется в поле callback_method) запросом, когда статус транзакции меняет статус. В параметрах GET запроса передаются: transaction - идентификатор транзакции, order - внешний идентификатор транзакции. В теле POST запроса передается текущая транзакция в виде JSON.'
                  example: 'http://www.jast.com/minima-quia-corrupti-perferendis-culpa-omnis-asperiores'
                  nullable: false
                success_url:
                  type: string
                  description: 'Вызывается в случае успешной оплаты. В параметрах GET запроса передаются: transaction - идентификатор транзакции, order - внешний идентификатор транзакции.'
                  example: 'http://www.casper.com/excepturi-eos-vitae-ea-enim-quasi'
                  nullable: false
                fail_url:
                  type: string
                  description: 'Вызывается в случае ошибки в оплате. В параметрах GET запроса передаются: transaction - идентификатор транзакции, order - внешний идентификатор транзакции.'
                  example: 'http://www.schmeler.com/nobis-dolor-autem-similique-illum'
                  nullable: false
                card_token:
                  type: string
                  description: 'Токен карты (для рекуррентных платежей)'
                  example: et
                  nullable: false
                payin_address:
                  type: object
                  description: 'Адрес для пополнения (для оплаты host2host)'
                  example: null
                  nullable: false
                  properties:
                    type:
                      type: string
                      description: 'Тип адреса для перевода. Возможные значения: phone.'
                      example: phone
                      nullable: false
                    phone:
                      type: string
                      description: 'Номер телефона для перевода'
                      example: '79991115566'
                      nullable: false
                    mobile_provider:
                      type: string
                      description: 'Идентификатор оператора мобильной связи пользователя'
                      example: MTS
                      nullable: false
                card:
                  type: object
                  description: 'Данные карты (для оплаты host2host)'
                  example: []
                  nullable: false
                  properties:
                    pan:
                      type: string
                      description: 'Номер карты (для оплаты host2host)'
                      example: '4111111111111111'
                      nullable: false
                    cardholder:
                      type: string
                      description: 'Держатель карты (для оплаты host2host)'
                      example: 'IVAN IVANOV'
                      nullable: false
                    month:
                      type: string
                      description: 'Месяц срока действия карты (2 цифры) (для оплаты host2host)'
                      example: '01'
                      nullable: false
                    year:
                      type: string
                      description: 'Год срока действия карты (2 цифры) (для оплаты host2host)'
                      example: '28'
                      nullable: false
                    cvv:
                      type: string
                      description: 'CVV карты (3 цифры) (для оплаты host2host)'
                      example: '123'
                      nullable: false
                addition_data:
                  type: object
                  description: 'Дополнительные данные для оплаты (не обязательно)'
                  example: []
                  nullable: false
                  properties:
                    email:
                      type: string
                      description: 'Email клиента'
                      example: bradford.kozey@example.com
                      nullable: false
                    phone:
                      type: string
                      description: 'Телефон клиента'
                      example: null
                      nullable: false
                    mobile_provider:
                      type: string
                      description: 'Идентификатор оператора мобильной связи пользователя'
                      example: null
                      nullable: false
                    address:
                      type: string
                      description: 'Адрес клиента'
                      example: null
                      nullable: false
                    city:
                      type: string
                      description: 'Город клиента'
                      example: null
                      nullable: false
                    state:
                      type: string
                      description: 'Штат/область клиента'
                      example: null
                      nullable: false
                    country:
                      type: string
                      description: 'Страна клиента'
                      example: null
                      nullable: false
                    country_code:
                      type: string
                      description: 'Код страны клиента'
                      example: null
                      nullable: false
                    zip_code:
                      type: string
                      description: 'Почтовый индекс клиента'
                      example: null
                      nullable: false
                    customer_ip:
                      type: string
                      description: 'IP адрес клиента'
                      example: null
                      nullable: false
                    customer_id:
                      type: string
                      description: 'ID клиента'
                      example: null
                      nullable: false
                    customer_first_name:
                      type: string
                      description: 'Имя клиента'
                      example: null
                      nullable: false
                    customer_last_name:
                      type: string
                      description: 'Фамилия клиента'
                      example: null
                      nullable: false
                    customer_doc_number:
                      type: string
                      description: 'Номер документа удостоверяющего личность'
                      example: null
                      nullable: false
                    customer_date_birth:
                      type: string
                      description: 'Дата рождения в формате ДД-ММ-ГГГГ'
                      example: null
                      nullable: false
                    device_browser_accept_header:
                      type: string
                      description: 'Принимаемый контент (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_java_enabled:
                      type: string
                      description: 'Признак работы с Java (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_javascript_enabled:
                      type: string
                      description: 'Признак работы с Javascript (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_language:
                      type: string
                      description: 'Язык браузера (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_color_depth:
                      type: string
                      description: 'Глубина цвета браузера (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_screen_height:
                      type: string
                      description: 'Высота экрана  (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_screen_width:
                      type: string
                      description: 'Ширина экрана (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_window_height:
                      type: string
                      description: 'Высота окна браузера (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_window_width:
                      type: string
                      description: 'Ширина окна браузера (для 3DS 2.0)'
                      example: null
                      nullable: false
                    device_browser_tz:
                      type: string
                      description: 'Часовой пояс браузера в минутах от UTC (для 3DS 2.0)'
                      example: '-180'
                      nullable: false
                    device_browser_tz_name:
                      type: string
                      description: 'Название часового пояса браузера (для 3DS 2.0)'
                      example: Europe/Moscow
                      nullable: false
                    device_browser_user_agent:
                      type: string
                      description: 'Пользовательский агент браузера (для 3DS 2.0)'
                      example: null
                      nullable: false
                    challenge_window_size:
                      type: string
                      description: 'Размер окна для challenge (для 3DS 2.0)'
                      example: null
                      nullable: false
                    challenge_window_size_height:
                      type: string
                      description: 'Высота окна для challenge (для 3DS 2.0)'
                      example: null
                      nullable: false
                    challenge_window_size_width:
                      type: string
                      description: 'Ширина окна для challenge (для 3DS 2.0)'
                      example: null
                      nullable: false
                    payment_system_id:
                      type: string
                      description: 'ID платежной системы'
                      example: Sberbank
                      nullable: false
              required:
                - amount
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: c8a6a9f1-c011-3a76-ae3e-206a77e9c191
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/withdrawal':
    post:
      summary: Выплата
      operationId: ''
      description: "Запрос выплаты на карту с кошелька\n<aside>Если передан параметр calculate=true, то производится предварительный расчет комиссии.  В ответе отсутствует блок transaction и присутствует блок addition_data (если разрешено настройками). Для тестового кошелька номера карт 2201382000000013 и 2201382000000021 возвращают ошибку.</aside>"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: success
                  comission: 12.5
                  total: 487.5
                  amount: 500
                  transaction:
                    currency: RUB
                    order: '73450234'
                    uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    created_at: '2024-01-26T09:59:01.000000Z'
                    status_transaction: created
                    total: 487.5
                    amount: 500
                    type_alias: payin
                    card_mask: null
                properties:
                  status:
                    type: string
                    example: success
                    description: 'Статус запроса'
                    enum: []
                  comission:
                    type: number
                    example: 12.5
                    description: ''
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма к зачислению'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма к оплате'
                    enum: []
                  transaction:
                    type: object
                    properties:
                      currency:
                        type: string
                        example: RUB
                        description: 'Код валюты в ISO 4217'
                        enum: []
                      order:
                        type: string
                        example: '73450234'
                        description: 'Внешний идентификатор'
                        enum: []
                      uuid:
                        type: string
                        example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                        description: 'UUID транзакции'
                        enum: []
                      created_at:
                        type: string
                        example: '2024-01-26T09:59:01.000000Z'
                      status_transaction:
                        type: string
                        example: created
                        description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                        enum: []
                      total:
                        type: number
                        example: 487.5
                      amount:
                        type: integer
                        example: 500
                      type_alias:
                        type: string
                        example: payin
                        description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                        enum: []
                      card_mask:
                        type: string
                        example: null
                        description: 'Маска карты (может быть null)'
                        enum: []
                    description: 'Блок описания транзакции (отсутствует если calculate=true)'
        400:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  error: 'Ошибка доступа'
                  code: access_denied
                properties:
                  status:
                    type: string
                    example: error
                    description: 'Статус запроса'
                    enum: []
                  error:
                    type: string
                    example: 'Ошибка доступа'
                  code:
                    type: string
                    example: access_denied
        422:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  status: error
                  error:
                    amount:
                      - 'Поле amount должно быть числом.'
                properties:
                  status:
                    type: string
                    example: error
                    description: 'Статус запроса'
                    enum: []
                  error:
                    type: object
                    properties:
                      amount:
                        type: array
                        example:
                          - 'Поле amount должно быть числом.'
                        items:
                          type: string
      tags:
        - Операции
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  description: 'Сумма к выплате'
                  example: 487497.0
                  nullable: false
                currency:
                  type: string
                  description: 'Код валюты в ISO 4217'
                  example: USD
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                card:
                  type: string
                  description: 'Карта для выплаты (16-19 цифр)'
                  example: '4111111111111111'
                  nullable: false
                payout_address:
                  type: object
                  description: 'Адрес для перевода'
                  example: null
                  nullable: false
                  properties:
                    type:
                      type: string
                      description: 'Тип адреса для перевода. Возможные значения: usdt_trc20 / phone / wallet / bank_account.'
                      example: usdt_trc20
                      nullable: false
                    address:
                      type: string
                      description: 'Адрес для перевода (для type = usdt_trc20)'
                      example: TCgBa3WVrrcQoBfd6bZdiFLatZ....
                      nullable: false
                    wallet:
                      type: string
                      description: 'Номер кошелька для перевода (для type = wallet)'
                      example: TCgBa3WVrrcQoBfd6bZdiFLatZ....
                      nullable: false
                    bank_account:
                      type: string
                      description: 'Номер счета для перевода (для type = bank_account)'
                      example: 912723874....
                      nullable: false
                    phone:
                      type: string
                      description: 'Номер телефона для перевода (для type = phone)'
                      example: '79991115566'
                      nullable: false
                    mobile_provider:
                      type: string
                      description: 'Идентификатор оператора мобильной связи пользователя (для type = phone) или индентификатор банка для выплат по СБП (полный список см. <a href="https://qr.nspk.ru/proxyapp/c2bmembers.json">здесь</a>).'
                      example: 'MTS, 1000000112'
                      nullable: false
                calculate:
                  type: boolean
                  description: 'Рассчитать комиссию'
                  example: false
                  nullable: false
                tag:
                  type: string
                  description: 'Тэг терминала.'
                  example: trusted
                  nullable: false
                callback_url:
                  type: string
                  description: 'Callback url вызывается GET запросом, когда статус транзакции меняется на completed. В параметрах GET запроса передаются: transaction - идентификатор транзакции, order - внешний идентификатор транзакции'
                  example: 'http://west.com/saepe-ad-aspernatur-et-ex-et.html'
                  nullable: false
                callback_method:
                  type: string
                  description: 'Определяет метод вызова callback. Возможные значения: POST, GET'
                  example: POST
                  nullable: false
                addition_data:
                  type: object
                  description: 'Дополнительные данные для оплаты (не обязательно)'
                  example: []
                  nullable: false
                  properties:
                    email:
                      type: string
                      description: 'Email клиента'
                      example: bernier.ashly@example.net
                      nullable: false
                    phone:
                      type: string
                      description: 'Телефон клиента'
                      example: null
                      nullable: false
                    address:
                      type: string
                      description: 'Адрес клиента'
                      example: null
                      nullable: false
                    city:
                      type: string
                      description: 'Город клиента'
                      example: null
                      nullable: false
                    state:
                      type: string
                      description: 'Штат/область клиента'
                      example: null
                      nullable: false
                    country:
                      type: string
                      description: 'Страна клиента'
                      example: null
                      nullable: false
                    country_code:
                      type: string
                      description: 'Код страны клиента'
                      example: null
                      nullable: false
                    zip_code:
                      type: string
                      description: 'Почтовый индекс клиента'
                      example: null
                      nullable: false
                    customer_ip:
                      type: string
                      description: 'IP адрес клиента'
                      example: null
                      nullable: false
                    customer_id:
                      type: string
                      description: 'ID клиента'
                      example: null
                      nullable: false
                    customer_first_name:
                      type: string
                      description: 'Имя клиента'
                      example: null
                      nullable: false
                    customer_last_name:
                      type: string
                      description: 'Фамилия клиента'
                      example: null
                      nullable: false
                    customer_doc_number:
                      type: string
                      description: 'Номер документа удостоверяющего личность'
                      example: null
                      nullable: false
                    customer_date_birth:
                      type: string
                      description: 'Дата рождения в формате ДД-ММ-ГГГГ'
                      example: null
                      nullable: false
                    card_expiration_year:
                      type: string
                      description: 'Год строка действия карты'
                      example: null
                      nullable: false
                    card_expiration_month:
                      type: string
                      description: 'Месяц строка действия карты'
                      example: null
                      nullable: false
                    cardholder:
                      type: string
                      description: 'Держатель карты'
                      example: 'IVAN IVANOV'
                      nullable: false
                    payment_system_id:
                      type: string
                      description: 'ID платежной системы'
                      example: Sberbank
                      nullable: false
              required:
                - amount
                - card
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 7cdf98a3-0be6-3e05-93f4-bcb6d85f1677
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/status':
    post:
      summary: 'Статус операции'
      operationId: ''
      description: 'Запрос статуса по операции (выплата/пополнение) (транзакцию можно получить по ее uuid или по внешнему идентификатору order)'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа в валюте транзакции'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 5dc4649e-2a2b-39f2-9e9d-e06deea75066
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/refund':
    post:
      summary: Refund
      operationId: refund
      description: "Оформить refund по операции.\nВ ответ возвращается refund транзакция."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 6d9b335b-95b6-3faf-aeb3-43600f076847
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/chargeback':
    post:
      summary: Chargeback
      operationId: chargeback
      description: "Оформить chargeback по операции.\nВ ответ возвращается chargeback транзакция."
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
      tags:
        - Операции
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                arn:
                  type: string
                  description: 'Уникальный номер операции в клиринговом обмене между банками'
                  example: null
                  nullable: false
                reason_code:
                  type: string
                  description: 'Характеризует причину возникновения Chargeback'
                  example: null
                  nullable: false
              required:
                - arn
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 0de094c0-37bb-3c92-b966-924570018ee6
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/additional_data':
    post:
      summary: 'Отправка дополнительных параметров по транзакции'
      operationId: ''
      description: "Дополнительные поля:\nUZS: sms_code"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                addition_data:
                  type: object
                  description: 'Дополнительные параметры'
                  example: []
                  nullable: false
                  properties:
                    sms_code:
                      type: string
                      description: 'Код из смс (для UZS)'
                      example: null
                      nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 84daabf1-0bc1-3455-81c2-0675afb052c1
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/paid':
    post:
      summary: 'Оплата счета'
      operationId: ''
      description: 'Отправка чека и реквизитов плательщика по оплаченному счету'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                receipt:
                  type: object
                  description: Чек
                  example: []
                  nullable: false
                  properties:
                    sender:
                      type: string
                      description: 'Реквизиты плательщика'
                      example: 'Иван Иванович 4432'
                      nullable: false
                    file_base64:
                      type: string
                      description: 'Файл чека в base64'
                      example: null
                      nullable: false
                    file_extension:
                      type: string
                      description: 'Расширение файла чека'
                      example: jpg
                      nullable: false
                    file_name:
                      type: string
                      description: 'Имя файла чека'
                      example: image
                      nullable: false
              required:
                - receipt
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: c9ce2648-528f-3e5f-840c-c86e72532625
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/cancel':
    post:
      summary: 'Отмена оплаты по счету'
      operationId: ''
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: f05b4717-f774-3978-8a63-ebf2a4ce7ae6
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/dispute':
    post:
      summary: 'Начать спор по пополнению'
      operationId: ''
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: bf303965-ae9e-3edc-8b4f-57a94abe58a6
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/dispute/messages':
    post:
      summary: 'Получение сообщений по спору'
      operationId: ''
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                example:
                  -
                    created_at: '2024-01-01T12:00:00Z'
                    direction: INCOME
                    type: TEXT
                    message: 'Не пришли деньги'
                  -
                    created_at: '2024-01-01T12:01:00Z'
                    type: IMAGE
                    direction: INCOME
                    base64_content: 0L/RgNC40LzQtdGA
                    filename: photo
                    extension: .jpg
                  -
                    created_at: '2024-01-01T12:03:00Z'
                    direction: OUTCOME
                    type: TEXT
                    message: Разобрались
      tags:
        - Операции
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 9762c57d-66ca-307b-9f69-31d51ec1981e
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/dispute/messages/send':
    post:
      summary: 'Отправка сообщения по спору'
      operationId: ''
      description: ''
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  currency: RUB
                  order: '73450234'
                  uuid: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                  created_at: '2024-01-26T09:59:01.000000Z'
                  status_transaction: created
                  total: 487.5
                  amount: 500
                  type_alias: payin
                  card_mask: null
                properties:
                  currency:
                    type: string
                    example: RUB
                    description: 'Код валюты в ISO 4217'
                    enum: []
                  order:
                    type: string
                    example: '73450234'
                    description: 'Внешний идентификатор'
                    enum: []
                  uuid:
                    type: string
                    example: 26549f4f-fcea-44bb-a65b-f4bf2ae78aea
                    description: 'UUID транзакции'
                    enum: []
                  created_at:
                    type: string
                    example: '2024-01-26T09:59:01.000000Z'
                    description: 'Дата создания в UTC'
                    enum: []
                  status_transaction:
                    type: string
                    example: created
                    description: 'Статус транзакции (created - создан, working - в обработке, completed - исполнен, error - ошибка)'
                    enum: []
                  total:
                    type: number
                    example: 487.5
                    description: 'Сумма зачисления'
                    enum: []
                  amount:
                    type: integer
                    example: 500
                    description: 'Сумма заказа'
                    enum: []
                  type_alias:
                    type: string
                    example: payin
                    description: 'Тип транзакции (payin - пополнение, payout - выплата, refund - Refund, chargeback - Chargeback)'
                    enum: []
                  card_mask:
                    type: string
                    example: null
                    description: 'Маска карты (может быть null)'
                    enum: []
      tags:
        - Операции
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: 'UUID транзакции'
                  example: null
                  nullable: false
                order:
                  type: string
                  description: 'Внешний идентификатор (макс 100 символов)'
                  example: null
                  nullable: false
                message:
                  type: object
                  description: Сообщение
                  example: []
                  nullable: false
                  properties:
                    type:
                      type: string
                      description: 'Тип сообщения. Возможные значения: TEXT - текстовое сообщение, IMAGE - изображение'
                      example: image
                      nullable: false
                    message:
                      type: string
                      description: 'Текст сообщения. Обязательно, если message.type = TEXT'
                      example: 'Не пришли деньги'
                      nullable: false
                    base64_content:
                      type: string
                      description: 'Изображение в кодировке base64. Обязательно, если message.type = IMAGE'
                      example: 0L/RgNC40LzQtdGA
                      nullable: false
                    filename:
                      type: string
                      description: 'Название файла. Обязательно, если message.type = IMAGE'
                      example: photo
                      nullable: false
                    extension:
                      type: string
                      description: 'Тип файла. Обязательно, если message.type = IMAGE'
                      example: .jpg
                      nullable: false
              required:
                - message
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: f3835752-e20f-300c-85db-6978f7783585
        required: true
        schema:
          type: string
  /api/profile:
    get:
      summary: Профиль
      operationId: ''
      description: 'Получение информации по всем кошелькам'
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                example:
                  -
                    uuid: 52a38a2b-fe45-45c8-850c-11f02d7d1620
                    currency: RUB
                    balance: '800.00'
                  -
                    uuid: 18ec8ec9-ebc0-494b-9871-eabef9404375
                    currency: USD
                    balance: '100.00'
      tags:
        - Профиль
  '/api/{wallet_uuid}/balance':
    get:
      summary: Баланс
      operationId: ''
      description: "Получение баланса кошелька\nВ блоке detailed перечислены балансы:\nactive - активный баланс (транзакции в статусах Выполнен);\ncurrent - текущий баланс (транзакции в статусах Создан, В обработке, Выполнен);\nfrozen - ролинг-резерв (транзакции с типом Rolling Reserve);\npayout - выплатной баланс (баланс, доступный для проведения выплат);"
      parameters: []
      responses:
        200:
          description: ''
          content:
            application/json:
              schema:
                type: object
                example:
                  uuid: 52a38a2b-fe45-45c8-850c-11f02d7d1620
                  currency: RUB
                  balance: '800.00'
                  detailed:
                    active: '800.00'
                    current: '800.00'
                    frozen: '0.00'
                    payout: '500.00'
                properties:
                  uuid:
                    type: string
                    example: 52a38a2b-fe45-45c8-850c-11f02d7d1620
                  currency:
                    type: string
                    example: RUB
                  balance:
                    type: string
                    example: '800.00'
                  detailed:
                    type: object
                    properties:
                      active:
                        type: string
                        example: '800.00'
                      current:
                        type: string
                        example: '800.00'
                      frozen:
                        type: string
                        example: '0.00'
                      payout:
                        type: string
                        example: '500.00'
      tags:
        - Профиль
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: 2f0b4b4a-7ec5-33e9-be67-9d0b57beedb4
        required: true
        schema:
          type: string
  '/api/{wallet_uuid}/history':
    get:
      summary: Транзакции
      operationId: ''
      description: 'Получение транзакций за период (используется пагинация)'
      parameters:
        -
          in: query
          name: date_from
          description: 'Дата от (UTC) (в формате d.m.Y)'
          example: null
          required: false
          schema:
            type: string
            description: 'Дата от (UTC) (в формате d.m.Y)'
            example: null
            nullable: false
        -
          in: query
          name: date_to
          description: 'Дата до (UTC) (в формате d.m.Y)'
          example: null
          required: false
          schema:
            type: string
            description: 'Дата до (UTC) (в формате d.m.Y)'
            example: null
            nullable: false
        -
          in: query
          name: page
          description: 'Страница пагинации'
          example: null
          required: false
          schema:
            type: integer
            description: 'Страница пагинации'
            example: null
            nullable: false
      responses:
        200:
          description: ''
          content:
            text/plain:
              schema:
                type: string
                example: "{\n\"current_page\": 1,\n\"data\": [\n{\n\"uuid\": \"d6a2f3a4-59f2-4a23-a663-e2908bf18020\",\n\"currency\": \"RUB\",\n\"status_transaction\": \"created\",\n\"created_at\": \"2022-03-04T08:17:54.000000Z\",\n\"amount\": \"10342.22\"\n},\n{\n\"uuid\": \"72f9b70c-e51f-4377-8040-77b3a0b0fcd0\",\n\"currency\": \"RUB\",\n\"status_transaction\": \"working\",\n\"created_at\": \"2022-03-04T08:16:54.000000Z\",\n\"amount\": \"194.45\"\n},\n{\n\"uuid\": \"af2c715a-953c-405c-b755-2a11a89a3dad\",\n\"currency\": \"RUB\",\n\"status_transaction\": \"completed\",\n\"created_at\": \"2022-03-04T08:15:54.000000Z\",\n\"amount\": \"99.00\"\n},\n],\n\"first_page_url\": \"http://example.com/api/52a38a2b-fe45-45c8-850c-11f02d7d1620/history?page=1\",\n\"from\": 1,\n\"last_page\": 1,\n\"last_page_url\": \"http://example.com/api/52a38a2b-fe45-45c8-850c-11f02d7d1620/history?page=1\",\n\"next_page_url\": null,\n\"path\": \"http://example.com/api/52a38a2b-fe45-45c8-850c-11f02d7d1620/history\",\n\"per_page\": 50,\n\"prev_page_url\": null,\n\"to\": 20,\n\"total\": 20\n}"
      tags:
        - Профиль
    parameters:
      -
        in: path
        name: wallet_uuid
        description: 'UUID кошелька'
        example: ac2de6e6-dc2d-3951-af53-cadef0ca7b2a
        required: true
        schema:
          type: string
tags:
  -
    name: Операции
    description: ''
  -
    name: Профиль
    description: ''
components:
  securitySchemes:
    default:
      type: http
      scheme: bearer
      description: 'You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.'
security:
  -
    default: []