Raiffeisenbank (Russia) Payform API

openapi: 3.2.0
info:
  title: Raiffeisen Ru Payform API
  version: '1.0'
  contact:
    email: ecom@raiffeisen.ru
    name: Support e-mail
    x-team-id: 178
    x-short-team-name: PAPAS
  x-description-i18n:
    eng: '# Connection to acquiring


      To connect, fill out an application in [the online bank](https://www.rbo.raiffeisen.ru/sign-form/internet-acquiring) or [the mobile application.](https://rbo.page.link/internet)


      For questions about working with the API, please contact Raiffeisenbank support service:

      - email: ecom@raiffeisen.ru


      ### Preparatory activities

      To accept payments:

      * Fill out the [application](https://www.rbo.raiffeisen.ru/sign-form/internet-acquiring) to connect acquiring

      * Choose an integration method and implement it

      * Make test payments


      ### Payment page integration methods

      To integrate the payment page, use:

      * A ready-made library that allows you to open a popup for entering payment data and transfer a complex data structure

      * Redirecting the client to the Raiffeisenbank payment page


      # Operation scheme

      ## Bank payment form

      Demonstration of the payment form:


      [Payment form](https://pay.raif.ru/pay/demo.html)


      During the payment process, the user performs the following actions:

      * The user adds goods/services to the store cart and clicks the "Pay" button

      * The partner opens a payment form

      * The user enters the bank card details on the payment form and confirms the payment


      <a href=''images/payment_form_scheme_en.svg'' target=''_blank''><img src=''images/payment_form_scheme_en.svg''></a>


      # API

      Interaction is carried out via the HTTP protocol using the `POST` `GET` `PUT` `DELETE` methods.


      When sending requests to open a payment form and create an order with opening a payment form, the API returns a response in the HTML document format, responses to other requests are returned in JSON format.


      ## Authorization

      To authorize requests, you need:

      * `publicId` - The identifier that is used to open the payment form and is public.

      * `secretKey` - A secret key that is used for inter-service interaction. It is private, must be stored in a secure place and must not be transferred to third parties.


      | Circuit           | URL address       |

      |------------------|-------------------------|

      | Production       |https://pay.raif.ru      |

      | Test             |https://pay-test.raif.ru |


      Inter-service requests are authorized using the secret key `secretKey`. The authorization parameter is passed in the `Authorization` header, the value of which is formed as `Bearer + secretKey`


      You can view the production `publicId` and generate a `secretKey` in the [Online Bank](https://www.rbo.raiffeisen.ru/acquiring/mcp#/), or [Personal Account](https://pay.raif.ru/account/#/auth).


      Instructions for generating `secretKey` can be found in the Help Center:

      * [Generate a secret key in Online Banking](https://help.pay.raif.ru/sbp/rbo/secretkey)

      * [Generate a secret key in your Personal Account](https://help.pay.raif.ru/sbp/lk/secretkey)


      To generate a `secretKey` in the test circuit, you must contact the support service ecom@raiffeisen.ru


      # Testing

      ## Acquiring

      `Bank payment form`:

      | PAN of a bank card| Card validity period| CVV | OTP code| Payment scenario   |

      |-------------------|---------------------|-----|---------|--------------------|

      | 4000001000000018  | 12/35               | 880 |   1234  | Successfull payment|

      | 4000001000000018  | 12/35               | 880 |   1111  | Unsuccessful payment|


      For a full payment testing cycle, you must specify a payment amount greater than 10 rubles.


      ## SBP

      For a full testing cycle, Raiffeisenbank provides the opportunity to use a demo application for QR code payment on behalf of the buyer:

      [WEB application for payment by QR code](https://pay.raif.ru/pay/rfuture/)


      The application can be opened in the browser of any device with a camera. After opening the application, you need to click on the "Scan QR" button (if necessary, allow the browser to access the camera) and scan the image of the test QR code.


      **Bank apps won''t work for QR code payments in the test environment**


      # SDK

      Using JS SDK allows you to open a form from the frontend part in a pop-up window, or redirect the user to the Raiffeisenbank page, which provides a seamless payment scenario for the client.


      Additionally, you can customize the payment form interface and transfer additional parameters for subsequent payment.

      You can customize the visual part of the form (company name, logo, button color) in the [Payment Form Configurator](https://pay.raif.ru/pay/configurator/).


      The payment form configurator also allows you to obtain code for embedding it into a JS library.

      Available SDK:

      * [JS SDK](https://github.com/Raiffeisen-DGTL/ecom-sdk-javascript)

      * [PHP SDK](https://github.com/Raiffeisen-DGTL/ecom-sdk-php)

      * [NODE SDK](https://github.com/Raiffeisen-DGTL/ecom-sdk-node)

      * [JAVA SDK](https://github.com/Raiffeisen-DGTL/ecom-sdk-java)


      JS SDK allows you to open a payment form from the frontend of your application. When using other SDKs to work with the payment form, you must either use the methods described in the [[Payment form]](#tag/payform) section yourself, or use the JS SDK additionally.


      Plugins for various CMS can also be found on [GitHub](https://github.com/Raiffeisen-DGTL/).


      Questions regarding solution support can be sent to technical support: ecom@raiffeisen.ru'
  x-logo:
    url: images/raifflogo.png
    backgroundColor: '#FFFFFF'
    altText: Raiff logo
  description: 'Operations tagged payform across 2 of this provider''s published API definitions: raiffeisen-ru-raif-pay-payment-form-openapi.json, raiffeisen-ru-raif-pay-payment-form-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://pay-test.raif.ru/api
  description: Sandbox
- url: https://pay.raif.ru/api
  description: Production
tags:


# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/raiffeisen-ru/refs/heads/main/openapi/raiffeisen-ru-payform-api-openapi.yml