openapi: 3.2.0
info:
  title: Raiffeisen Ru Accounts Operation API
  version: '0.1'
  contact:
    email: dcc@raiffeisen.ru
    name: Support e-mail
    x-team-id: 228
    x-short-team-name: Corporate Cards
  x-description-i18n:
    eng: "Automated card issuance via API or registry. This allows you to issue corporate cards without documents or passports. Send us a list of cardholders via a registry through your online banking or API—we’ll issue the cards for you.\n\n# Registry\n\n1. Send the list of employees via online banking in XLS, CSV, or XML format. You can fill out the employee list manually or export it from your accounting system.\n\n2. If you order cards at a [bank branch](https://docs.google.com/spreadsheets/d/1lT-qOCGrAW7u9IFn8tDWwO1bnUt_gNPEncINGvVVbKE), delivery takes 3-5 business days.\n   If you order cards to be delivered to cardholders' addresses (only for XLS and CSV formats), delivery takes 5-7 business days, depending on the region. Cardholders will receive an SMS notification when their card is ready.\n\n## Registry Format\n  Template: <span style=\"white-space: pre;\">    </span> <Button onclick=\"document.location='images/Заявление на выпуск карт для нерезидентов v2.xlsx'\" color=\"primary\">XLS</Button>\n\n  Examples: <span style=\"white-space: pre;\">    </span> <Button onclick=\"document.location='images/xml_registry1.xml'\" color=\"primary\">XML_1</Button> <span style=\"white-space: pre;\">    </span> <Button onclick=\"document.location='images/xml_registry2.xml'\" color=\"primary\">XML_2</Button> <span style=\"white-space: pre;\">    </span> <Button onclick=\"document.location='images/csv_registry.csv'\" color=\"primary\">CSV</Button>\n\n   Parameter Name                     | Value\n  ------------------------------------|------------------------------------------------------------------------------------------\n   ИдПервичногоДокумента              | Unique registry identifier on the Company's side\n   РасчетныйСчетОрганизации           | Company account opened with the Bank to which the cards will be linked\n   ВидВклада/КодВидаВклада            | Card type <br> (MIR_CORPORATE/ MIR_CORPORATE_VIRTUAL/ CASH_IN&OUT)\n   Фамилия                            | Last name of the employee-cardholder\n   Имя                                | First name of the employee-cardholder\n   Отчество                           | Middle name of the employee-cardholder\n   ЭмбоссированныйТекст               | First and last name of the employee-cardholder in Latin script (to be printed on the card)\n   ОтделениеБанка/ ФилиалОтделенияБанка | Bank branch code where the cards will be delivered\n   Пол                                | Gender of the employee-cardholder\n   ДатаРождения                       | Date of birth\n   МестоРождения.СтранаНазвание       | Country of birth\n   Серия                              | Passport series (Russian passport)\n   Номер                              | Passport number (Russian passport)\n   ДатаВыдачи                         | Passport issue date\n   КемВыдан                           | Passport issuing authority\n   Гражданство                        | Citizenship\n   АдресПрописки.Страна               | Country of registration\n   АдресПрописки.РегионНазвание       | Region of registration address\n   АдресПрописки.НаселенныйПунктНазвание | Locality of registration address\n   АдресПрописки.УлицаНазвание        | Street of registration address <br> (if absent, specify \"Нет\")\n   АдресПрописки.Дом                  | House number of registration address\n   МобильныйТелефон                   | Employee-cardholder’s mobile phone <br> (79210000001 or 9210000001)\n   Суточный лимит <br> (CSV file)     | Daily cash withdrawal limit\n   Месячный лимит <br> (CSV file)     | Monthly spending limit\n   Секретное слово <br> (CSV file)    | Cardholder’s secret word\n   Индекс доставки <br> (CSV file)    | Delivery postal code\n   Регион доставки <br> (CSV file)    | Delivery region\n   Населенный пункт доставки <br> (CSV file) | Delivery locality\n   Улица доставки <br> (CSV file)     | Delivery street\n   Дом доставки <br> (CSV file)       | Delivery house number\n   Корпус доставки <br> (CSV file)    | Delivery building/block\n\n## Instructions for Exporting Registry from 1С\n[Instructions for Exporting Registry from 1С](https://docs.google.com/document/d/1xk9q9MDW1qx9oqQI64FF9PUBdShuLc-rgYuciY2SbzI)\n\n## List of Bank Branches for Card Pickup\n[List of Bank Branches for Card Pickup](https://docs.google.com/spreadsheets/d/1lT-qOCGrAW7u9IFn8tDWwO1bnUt_gNPEncINGvVVbKE)\n\n# About the API\n\nAfter signing the contract, you will receive an email with authorization details for the service.\n\n1. Integrate our API with your accounting system.\n2. Send the list of employees.\n3. Check card issuance status.\n4. Within 3-5 business days, the cards will be delivered to the bank branch. Cardholders will receive an SMS notification.\n\nCommunication is carried out via HTTP using GET/POST methods (each request description specifies the required method and address).\n   - POST requests use JSON arguments.\n   - GET requests work with query strings.\n\nThe API always returns a response in JSON format, regardless of the request type.\n   - Every response includes a message code (`code`). If a logical error occurs during processing, the API will also return an error description (`message`).\n\n## Authorization\n\nTo authorize requests, the following is required:\n- `secretKey` – a secret key used for inter-service communication.\n\nIMPORTANT: The secret key must be stored securely. Do not publish it on third-party resources or share it with unauthorized parties.\n\nInter-service requests are authorized via the API secret key (`SECRET_KEY`). The authorization parameter is specified in the `Authorization` header, formatted as `\"Bearer SECRET_KEY\"`.\n"
  x-logo:
    url: images/raifflogo.png
    backgroundColor: '#FFFFFF'
    altText: Raiff logo
  description: 'Operations tagged accounts-operation-api across 2 of this provider''s published API definitions: raiffeisen-ru-raif-pay-corporate-cards-openapi.json, raiffeisen-ru-raif-pay-corporate-cards-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pay-test.raif.ru
  description: Sandbox
- url: https://pay.raif.ru
  description: Production
security:
- Authorization: []
tags:
- name: accounts-operation-api
  x-displayName: Операции по счетам
  x-x-displayName-i18n:
    eng: Account transactions
  description: 'API для просмотра информации и управления счетами:

    * Получение баланса счёта, к которому привязаны карты

    * Получение списка счетов по номеру карты'
  x-description-i18n:
    eng: 'API for viewing and managing accounts:

      * Get balance of the account linked to cards

      '
paths:
  /api/cards/v1/accounts/{account}/balance:
    get:
      tags:
      - accounts-operation-api
      summary: Баланс по счёту
      x-summary-i18n:
        eng: Account balance
      description: Получение баланса счёта, к которому привязаны карты.
      x-description-i18n:
        eng: Obtaining the balance of the account to which the cards are linked.
      operationId: getAccountBalance
      parameters:
      - $ref: '#/components/parameters/AccountInPath'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountBalanceDto'
        '400':
          $ref: '#/components/responses/400_business_exception'
        '401':
          $ref: '#/components/responses/401_without_traceId'
        '500':
          $ref: '#/components/responses/500_without_traceId'
    servers:
    - url: https://pay-test.raif.ru
      description: Sandbox
    - url: https://pay.raif.ru
      description: Production
components:
  schemas:
    AvailableBalance:
      type: number
      description: Доступный баланс
      x-description-i18n:
        eng: Available balance
      example: 70.76
    AccountBalanceDto:
      type: object
      properties:
        availableBalance:
          allOf:
          - $ref: '#/components/schemas/AvailableBalance'
  responses:
    400_business_exception:
      description: Бизнес-ошибка
      x-description-i18n:
        eng: Business-error
      content:
        application/json:
          schema:
            type: object
            properties:
              code:
                type: string
                description: Код ошибки
                x-description-i18n:
                  eng: Error code
                example: ERROR.INVALID_DATA
              message:
                type: string
                description: Текст ошибки
                x-description-i18n:
                  eng: Error text
                example: Некорректные данные
    500_without_traceId:
      description: Внутренняя ошибка
      content:
        application/json:
          schema:
            type: object
            properties:
              timestamp:
                type: string
                description: Дата и время операции
                example: '2021-01-01T12:00:27.87+00:20'
                format: date-time
              status:
                type: integer
                description: HTTP-код
                example: 500
              error:
                type: string
                description: Ошибка
                example: Internal Server Error
              message:
                type: string
                description: Описание ошибки
                example: Internal Server Error
              path:
                type: string
                description: URL, по которому была вызвана ошибка
    401_without_traceId:
      description: Неверный токен аутентификации
      content:
        application/json:
          schema:
            type: object
            description: Объект ошибки
            properties:
              timestamp:
                type: string
                description: Дата и время операции
                example: '2021-01-01T12:00:27.87+00:20'
                format: date-time
              status:
                type: integer
                description: HTTP-код
                example: 401
              error:
                type: string
                description: Ошибка
                example: Unauthorized
              message:
                type: string
                description: Описание ошибки
                example: some exception
              path:
                type: string
                description: URL, по которому была вызвана ошибка.
  parameters:
    AccountInPath:
      name: account
      in: path
      description: Номер счёта
      x-description-i18n:
        eng: Account number
      required: true
      schema:
        type: string
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Bearer secret key
      x-internal: false
x-refined-from:
- raiffeisen-ru-raif-pay-corporate-cards-openapi.json
- raiffeisen-ru-raif-pay-corporate-cards-openapi.yml