API (1.0)

Download OpenAPI specification:Download

License: Apache 2.0

Общая информация

Уведомления

Уведомление по операции Webhook

Запрос подписывается хедером: Authorization: Basic base64({login + “:” + api-key})

Пример: Authorization: Bearer ZGVtbzpkZW1vMTIzNDU2

Request Body schema: application/json
required
order_id
string <= 50 characters unique

ID заказа на стороне мерчанта
Должен быть уникален для всех типов операции в рамка одного мерчанта

id
string <= 50 characters unique

ID заказа на стороне шлюза

status
string
Enum: "created" "completed" "canceled"

Статус операции.
created - операция создана
completed - операция оплачена
canceled - операция не оплачена

amount
integer

Сумма операции в разменной денежной единице.
Для рублей в копейках.

processed_amount
integer or null

Финальная сумма операции в разменной денежной единице.
Для рублей в копейках.

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "id": "string",
  • "status": "created",
  • "amount": 1000,
  • "processed_amount": 1000
}

Запросы на авторизацию

Запрос на получения токена доступа

Request Body schema: application/json
required
username
required
string <= 50 characters

Merchant ID, полученный от администратора шлюза

password
required
string <= 50 characters

Пароль, полученный от администратора шлюза

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh": "string"
}

Запрос на обновления токена доступа

Request Body schema: application/json
required
refresh
required
string <= 50 characters

Токен, полученный на "Запрос на получения токена доступа"

Responses

Request samples

Content type
application/json
{
  • "refresh": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "refresh": "string"
}

Запрос на регистрацию платежа

Запрос на регистрацию платежа

Authorizations:
API_KEY
Request Body schema: application/json
required
order_id
required
string <= 50 characters unique

ID заказа на стороне мерчанта
Должен быть уникален для всех типов операции в рамка одного мерчанта

amount
required
integer

Сумма операции в разменной денежной единице.
Для рублей в копейках.

callback_url
required
string <uri>

Адрес для уведомлений о финальных статусах операции

transfer_method
string
Enum: "card" "qr_code" "card_number" "sbp"

Тип операции.
card - оплата картой
qr_code - оплата по QR-коду СБП
card_number - перевод на карту
sbp - перевод по СБП

object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
Example
{
  • "order_id": "string",
  • "id": "string",
  • "status": "created",
  • "amount": 1000,
  • "processed_amount": 1000
}

Запрос на регистрацию выплаты

Запрос на регистрацию выплаты

Authorizations:
API_KEY
Request Body schema: application/json
order_id
required
string <= 50 characters unique

ID заказа на стороне мерчанта
Должен быть уникален для всех типов операции в рамка одного мерчанта

amount
required
integer

Сумма операции в разменной денежной единице.
Для рублей в копейках.

callback_url
required
string <uri>

Адрес для уведомлений о финальных статусах операции

transfer_method
string
Enum: "card" "sbp" "qr_code" "card_number"

Тип операции.
card - оплата картой
qr_code - оплата по QR-коду СБП
card_number - перевод на карту
sbp - перевод по СБП

object
bank
string <= 32 characters

Код банка

sbp_phone_number
string^([7]9\d{9})$

Номер телефона получателя средств

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "amount": 1000,
  • "transfer_method": "card",
  • "card": {
    },
  • "bank": "Sber",
  • "sbp_phone_number": "79991234567"
}

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "id": "string",
  • "status": "created",
  • "amount": 1000,
  • "processed_amount": 1000
}

Статус операции

Запрос на получение статуса операции

Authorizations:
API_KEY
Request Body schema: application/json
required
order_id
string <= 50 characters

ID заказа на стороне мерчанта

id
string <= 50 characters

ID заказа на стороне шлюза

Responses

Request samples

Content type
application/json
{
  • "order_id": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "order_id": "string",
  • "id": "string",
  • "status": "created",
  • "amount": 1000,
  • "processed_amount": 1000
}