Scope
system-core-orders
Описание
Метод позволяет системе партнёра получить операции по заказу, созданному в сервисах Альфа-Тревел и Альфа-Афиша, и статус по нему.
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
Идентификатор заказа в Банке, полученный в методах «Создание заказа в Альфа-Тревел» / «Создание заказа в Альфа-Афише»
1curl --location --globoff 'https://baas.alfabank.ru/api/order-core/pp/v1/orders/{orderId}/status' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1{
2 "status": "EXECUTED",
3 "transactions": [
4 {
5 "id": 67946879647,
6 "status": "SUCCESS",
7 "type": "CANCEL_WITHDRAW",
8 "accountTypeId": 140,
9 "amount": 1000,
10 "operationDate": "2024-01-15T14:30:00.000Z",
11 "createdAt": "2024-01-15T14:30:00.000Z"
12 }
13 ]
14}Статус обработки заказа. Принимает возможные значения:
-
•
EXECUTED- заказ подтвержден; -
•
CREATED- заказ создан; -
•
REFUNDED- заказ возвращен; -
•
CANCELLED- заказ отменён
Массив транзакций по заказу
Уникальный идентификатор транзакции в системе
Статус операции. Принимает возможные значения:
-
•
IN_PROGRESS- в процессе; -
•
SUCCESS- успех; -
•
ERROR- ошибка; -
•
CANCELLED- отмена
Тип операции. Принимает возможные значения:
-
•
WITHDRAW- списание; -
•
CANCEL_WITHDRAW- отмена списания
Идентификатор типа бонусного счёта
Сумма бонусов в минорных единицах
Дата и время выполнения операции в формате ISO 8601
Дата и время создания транзакции в системе в формате ISO 8601
1{
2 "status": "EXECUTED",
3 "transactions": [
4 {
5 "id": 67946879647,
6 "status": "SUCCESS",
7 "type": "CANCEL_WITHDRAW",
8 "accountTypeId": 140,
9 "amount": 1000,
10 "operationDate": "2024-01-15T14:30:00.000Z",
11 "createdAt": "2024-01-15T14:30:00.000Z"
12 }
13 ]
14}Код ошибки. Принимает возможные значения:
-
•
validation_error/invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "validation_error",
3 "error_description": "Field sum: must not be null"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. Необходимо получить новый токен доступа
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
access_denied- доступ к счету запрещен; -
•
insufficient_scope- у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен; -
•
order_not_found- заказ не найден
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_server_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_server_error",
3 "error_description": "Internal server error"
4}Код ошибки. Принимает возможные значения:
-
•
external_error- ошибка взаимодействия с внешним сервисом при обработке запроса; -
•
cant_get_transactions- не удалось получить информацию об операциях запроса;
Описание ошибки
1{
2 "error": "external_error",
3 "error_description": "External error"
4}