B2C

Подтверждение заказа

Пром
POST https://baas.alfabank.ru/api/order-core/pp/v1/orders/{orderId}/confirmations
Scope

coreorders

Описание

Метод позволяет подтвердить заказ в Альфа-Тревел и Альфа-Афише.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Accept
stringrequired

application/json

Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
orderId
stringrequired
BODY
Атрибут
Описание
comment
stringoptional

Комментарий к подтверждению

array of objectsoptional

Данные об оплате

sum
numberrequired

Сумма оплаты

currency
stringrequired

Валюта оплаты

maskedCardNumber
stringrequired

Маскированный номер карты

rrn
stringrequired

Уникальный идентификатор банковской транзакции

tokenCode
stringoptional

Номер токена, полученный при оплате через GooglePay/ApplePay

dateTime
stringrequired

Дата и время транзакции (GMT+3)

objectoptional

Данные о кэшбэке

totalSum
numberrequired

Общая сумма кэшбэка

array of objectsoptional

Данные детальной информации о кэшбэке

contentId
stringoptional

Идентификатор товарной категории

sum
numberoptional

Суммарный кэшбэк за категорию

Пример запроса
Язык
1curl --location --globoff 'https://baas.alfabank.ru/api/order-core/pp/v1/orders/{orderId}/confirmations' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "comment": "Подтвердить",
7  "paymentTransaction": [
8    {
9      "sum": 800,
10      "currency": "RUB",
11      "maskedCardNumber": "12345678******78912",
12      "rrn": "1498745362575217925125545565",
13      "tokenCode": "65941241914",
14      "dateTime": "2023-10-05T14:30:00.000Z"
15    }
16  ],
17  "cashback": {
18    "totalSum": 1850,
19    "cashbackDetailList": [
20      {
21        "contentId": "12",
22        "sum": 800
23      }
24    ]
25  }
26}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Order already confirmed"
4}
BODY
атрибут
описание
orderId
stringoptional

Идентификатор заказа в Банке

status
stringoptional

Результат подтверждения заказа

Пример ответа 200 (OK)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Order already confirmed"
4}
BODY
атрибут
описание
orderId
stringoptional

Идентификатор заказа в Банке

status
stringoptional

Результат подтверждения заказа

Пример ответа 201 (Created)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Confirmed"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    validation_error - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request)
1{
2  "error": "validation_error",
3  "error_description": "Field orderId: must not be null"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized)
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringoptional

Описание ошибки. Принимает возможные значения:

  • •
    forbidden / insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden)
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен;
  • •
    not_found - заказ не найден
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found)
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    incorrect_status - некорректный статус заказа
error_description
stringoptional

Описание ошибки

Пример ошибки 422 (Unprocessable Entity)
1{
2  "error": "incorrect_status",
3  "error_description": "Incorrect status"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    internal_server_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error)
1{
2  "error": "internal_server_error",
3  "error_description": "Internal server error"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    bad_gateway - ошибка взаимодействия с внешним сервисом при обработке запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 502 (Bad Gateway)
1{
2  "error": "bad_gateway",
3  "error_description": "Can't write off miles"
4}
Нет тела ответа