Search
API docs by Redocly

WB Pay Offline API (1.0.0)

API для проведения оффлайн оплат и возвратов

WB Pay Offline API

API для проведения оффлайн оплат и возвратов

Оффлайн-оплата

Методы API предназначены для проведения оффлайн оплаты. Процесс оплаты состоит из трех этапов: регистрация оплаты, выполнение оплаты и проверка статуса.

Регистрация оффлайн оплаты{{ /api/v1/orders/offline/register }}

Описание метода

Метод возвращает ID заказа в статусе created

Authorizations:
(BearerAuthSignatureAuth)
header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

X-Request-Country
required
string^[a-zA-Z]{2}$

Код страны в формате ISO 3166-1

X-Request-Region
required
string^[a-zA-Z]{2}-[a-zA-Z]{2,3}$

Код региона в формате ISO 3166-2

Request Body schema: application/json
required
terminal_id
required
string

ID терминала

invoice_id
string

ID операции мерчанта

qr_code
required
string

QR код

amount
required
integer <int64>

Сумма в копейках, без разделителя. 50 = "5000"

currency_code
required
integer <int64>

Код валюты. Для оплаты в рублях передавать значение 643

created_at
required
integer <int64>

Дата создания заказа в формате Unix timestamp

Array of objects (Position)

Корзина товаров

Responses

Request samples

Content type
application/json
{
  • "terminal_id": "terminal_id",
  • "invoice_id": "invoice_id",
  • "qr_code": "qr_code",
  • "amount": 5000,
  • "currency_code": 643,
  • "created_at": 123435453,
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "Запрос выполнен успешно",
  • "data": {
    }
}

Выполнение оффлайн оплаты{{ /api/v1/orders/do }}

Описание метода

Метод применяется для финализации оплаты

Authorizations:
BearerAuth
header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

Request Body schema: application/json
required
order_id
required
string

ID заказа. Используется значение параметра order_id, полученного ранее в методе регистрации оплаты

Responses

Request samples

Content type
application/json
{
  • "order_id": "alskdjfhalksjdhf_84765384765"
}

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "string",
  • "data": { }
}

Запрос статуса оплаты{{ /api/v1/orders/{order_id}/status }}

Описание метода

Метод возвращает статус оплаты заказа

Authorizations:
BearerAuth
path Parameters
order_id
required
string

ID заказа. Используется значение параметра order_id, полученного ранее в методе регистрации оплаты

header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

X-Wbpay-Id
required
string

ID заказа

Responses

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "Запрос выполнен успешно",
  • "data": {
    }
}

Возвраты

Методы API предназначены для проведения возврата (полного или частичного) по ранее завершённой оплате. Процесс возврата состоит из трех этапов: регистрация возврата, выполнение возврата и проверка статуса.

Регистрация возврата{{ /api/v1/refunds/register }}

Описание метода

Метод возвращает ID возврата в статусе pending

Authorizations:
(BearerAuthSignatureAuth)
header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

X-Wbpay-Id
required
string

ID заказа

Request Body schema: application/json
required
terminal_id
required
string

ID терминала

invoice_id
string

ID операции мерчанта

order_id
required
string

ID заказа. Используется значение параметра order_id, полученного ранее в методе регистрации оплаты

amount
required
integer <int64>

Сумма к возврату в копейках, без разделителя. 50 = "5000"

currency_code
required
integer <int64>

Код валюты. Для оплаты в рублях передавать значение 643

created_at
required
integer <int64>

Дата создания заказа в формате Unix timestamp

Array of objects (Position)

Корзина товаров

Responses

Request samples

Content type
application/json
{
  • "terminal_id": "terminal_id",
  • "invoice_id": "invoice_id",
  • "order_id": "asdkjfhgaskdjhfg_743568374",
  • "amount": 123,
  • "currency_code": 643,
  • "created_at": 13453453345,
  • "positions": [
    ]
}

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "Запрос выполнен успешно",
  • "data": {
    }
}

Выполнение возврата{{ /api/v1/refunds/do }}

Описание метода

Метод применяется для финализации возврата

Authorizations:
BearerAuth
header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

X-Wbpay-Id
required
string

ID заказа

Request Body schema: application/json
required
refund_id
required
string

ID возврата. Используется значение параметра refund_id, полученного ранее в методе регистрации возврата

Responses

Request samples

Content type
application/json
{
  • "refund_id": "sjdhfgjshdgfjsdfasdfa_345345"
}

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "string",
  • "data": { }
}

Запрос статуса возврата{{ /api/v1/refunds/{refund_id}/status }}

Описание метода

Метод возвращает статус возврата

Authorizations:
BearerAuth
path Parameters
refund_id
required
string

ID возврата. Используется значение параметра refund_id, полученного ранее в методе регистрации возврата

header Parameters
Content-Type
required
string
Value: "application/json"

Тип контента

X-Wbpay-Id
required
string

ID заказа

Responses

Response samples

Content type
application/json
{
  • "error_code": "ERR_NONE",
  • "error_description": "Запрос выполнен успешно",
  • "data": {
    }
}