Поиск
API docs by Redocly

WB Pay Online API (1.4.0)

API для интеграции продукта WB Pay Online на площадке партнёра

WB Pay Online API

API для интеграции продукта WB Pay Online на площадке партнёра

Платёжный токен плательщика

Методы для получения платёжного токена плательщика

Генерация токена плательщика{{ /api/v1/users/tokens }}

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

Метод возвращает ID операции регистрации в статусе pending

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 терминала

phone_number
required
string

Номер телефона плательщика

created_at
required
integer <int64>

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

client_id
required
string

Уникальный ID пользователя в системе мерчанта

currency_code
integer <int64>

Валюта операции

amount
integer <int64>

Сумма операции

Responses

Request samples

Content type
application/json
{
  • "terminal_id": "terminal_id",
  • "phone_number": "79990000000",
  • "created_at": 123435453,
  • "client_id": "123e4567-e89b-12d3-a456-426614174000",
  • "currency_code": 643,
  • "amount": 5000
}

Response samples

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

Получение статуса генерации токена плательщика{{ /api/v1/users/tokens/{registration_id}/status }}

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

Метод возвращает статус операции регистрации

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

Тип контента

X-Wbpay-Id
required
string

ID запроса

Responses

Response samples

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

Оплата по платёжному токену

Методы для проведения оплаты по ранее полученному платёжному токену плательщика

Регистрация онлайн-оплаты по токену{{ /api/v1/orders/online/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 операции мерчанта

token
required
string

Платёжный токен плательщика

amount
required
integer <int64>

Сумма в копейках

currency_code
required
integer <int64>

Код валюты

created_at
required
integer <int64>

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

client_id
required
string

Уникальный ID пользователя в системе мерчанта

Array of objects (Position)

Responses

Request samples

Content type
application/json
{
  • "terminal_id": "default_terminal",
  • "invoice_id": "invoice_id",
  • "token": "token_id",
  • "amount": 5000,
  • "currency_code": 643,
  • "created_at": 123435453,
  • "client_id": "123e4567-e89b-12d3-a456-426614174000",
  • "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 заказа

Responses

Request samples

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

Response samples

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

Получение статуса оплаты{{ /api/v1/orders/{order_id}/status }}

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

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

Authorizations:
BearerAuth
path Parameters
order_id
required
string

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/v1/orders/online/register-by-phone }}

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

Метод возвращает 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 операции мерчанта

phone_number
required
string

Номер телефона плательщика

amount
required
integer <int64>

Сумма в копейках

currency_code
required
integer <int64>

Код валюты

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",
  • "phone_number": "79991234567",
  • "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 заказа

Responses

Request samples

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

Response samples

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

Получение статуса оплаты{{ /api/v1/orders/{order_id}/status }}

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

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

Authorizations:
BearerAuth
path Parameters
order_id
required
string

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/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 заказа

amount
required
integer <int64>

Сумма к возврату в копейках

currency_code
required
integer <int64>

Код валюты

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 возврата

Responses

Request samples

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

Response samples

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

Получение статуса возврата{{ /api/v1/refunds/{refund_id}/status }}

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

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

Authorizations:
BearerAuth
path Parameters
refund_id
required
string

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": {
    }
}