B2C

Получение платёжной информации и статуса по заказу

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

system-core-orders

Описание

Метод позволяет системе партнёра получить платёжную информацию по заказу, созданному в сервисах Альфа-Тревел и Альфа-Афиша, и статус по нему.

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

application/json

QUERY
Атрибут
Описание
includeTransactions
booleanoptional

Признак включения в ответ массива transactions с данными о транзакциях по заказу. Возможные значения:

  • •
    true - массив transactions будет включён в ответ (может быть пустым);
  • •
    false - массив transactions не будет включён в ответ
PATH
Атрибут
Описание
orderId
stringrequired
Пример запроса
Язык 
1curl --location --globoff 'https://baas.alfabank.ru/api/order-core/pp/v1/orders/{orderId}/payment-details?includeTransactions={includeTransactions}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'
Параметры ответа
Пример ответа 200 (OK) 
1{
2  "orderId": "8be4df61-93ca-11d2-aa0d-00e098032b8c",
3  "status": "EXECUTED",
4  "paymentType": "MIXED",
5  "totalSum": 10000.22,
6  "bonusPayment": [
7    {
8      "bonusAccountType": "Мили",
9      "confirmAt": "2023-10-05T14:30:00.000Z",
10      "sum": 5000.11,
11      "type": "BASIC_PAYMENT"
12    }
13  ],
14  "cashPayment": [
15    {
16      "confirmAt": "2023-10-05T14:30:00.000Z",
17      "cardMaskedNumber": "111111**1234",
18      "rrn": "123456789012",
19      "sum": 5000.11,
20      "type": "BASIC_PAYMENT",
21      "currency": "RUB"
22    }
23  ],
24  "transactions": [
25    {
26      "id": 67946879687,
27      "status": "SUCCESS",
28      "type": "WITHDRAW",
29      "accountTypeId": 180,
30      "amount": 500011,
31      "operationDate": "2023-10-05T14:30:00.000Z",
32      "createdAt": "2023-10-05T14:30:00.000Z"
33    }
34  ]
35}
BODY
атрибут
описание
orderId
stringrequired

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

status
stringrequired

Статус заказа в сервисе управления заказами. Принимает возможные значения:

  • •
    CREATED - заказ создан;
  • •
    EXECUTED - заказ полностью оплачен;
  • •
    CANCELLED - заказ отменён до подтверждения;
  • •
    REFUNDED - заказ отменён, списанные средства возвращены
paymentType
stringrequired

Тип оплаты в сервисе управления заказами. Принимает возможные значения:

  • •
    CASH - оплата деньгами;
  • •
    MIXED - смешанная оплата;
  • •
    BONUS - оплата бонуснымми единицами
totalSum
numberrequired

Общая сумма заказа (2 знака после запятой)

array of objectsrequired

Данные бонусной части оплаты заказа (может быть пустым)

bonusAccountType
stringrequired

Тип бонусного счёта оплаты. Принимает возможные значения:

  • •
    Мили
  • •
    Cashback баллы
confirmAt
stringoptional

Дата и время подтверждения оплаты бонусной частью в формате ISO 8601 по UTC

sum
numberrequired

Общая сумма бонусных единиц (2 знака после запятой)

type
stringrequired

Тип оплаты. Принимает возможные значения:

  • •
    BASIC_PAYMENT - основная оплата;
  • •
    ADDITIONAL_SERVICES - покупка доп. услуг;
  • •
    EXCHANGE - обмен;
  • •
    PARTLY_REFUNDED - частичный возврат
array of objectsrequired

Данные денежной части оплаты заказа (может быть пустым)

confirmAt
stringoptional

Дата и время подтверждения оплаты денежной частью в формате ISO 8601 по UTC

refundType
integeroptional

Тип возврата при частичном возврате. Принимает возможные значения:

  • •
    0 - возврат по основному заказу;
  • •
    1 - возврат доп. услуги
cardMaskedNumber
stringoptional

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

rrn
stringoptional

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

sum
numberrequired

Сумма оплаты денежными единицами (2 знака после запятой)

type
stringrequired

Тип оплаты. Принимает возможные значения:

  • •
    BASIC_PAYMENT - основная оплата;
  • •
    ADDITIONAL_SERVICES - покупка доп. услуг;
  • •
    EXCHANGE - обмен;
  • •
    PARTLY_REFUNDED - частичный возврат
currency
stringrequired

Валюта оплаты денежной частью

array of objectsoptional

Данные транзакций по заказу (может быть пустым)

id
integerrequired

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

status
stringrequired

Статус операции. Принимает возможные значения:

  • •
    IN_PROGRESS - в процессе;
  • •
    SUCCESS - успех;
  • •
    ERROR - ошибка;
  • •
    CANCELLED - отмена
type
stringrequired

Тип операции. Принимает возможные значения:

  • •
    WITHDRAW - списание;
  • •
    CANCEL_WITHDRAW - отмена списания
accountTypeId
integerrequired

Идентификатор типа бонусного счёта

amount
integerrequired

Сумма бонусов в минорных единицах

operationDate
stringrequired

Дата и время выполнения операции в формате ISO 8601

createdAt
stringrequired

Дата и время создания транзакции в системе в формате ISO 8601

Пример ответа 200 (OK) 
1{
2  "orderId": "8be4df61-93ca-11d2-aa0d-00e098032b8c",
3  "status": "EXECUTED",
4  "paymentType": "MIXED",
5  "totalSum": 10000.22,
6  "bonusPayment": [
7    {
8      "bonusAccountType": "Мили",
9      "confirmAt": "2023-10-05T14:30:00.000Z",
10      "sum": 5000.11,
11      "type": "BASIC_PAYMENT"
12    }
13  ],
14  "cashPayment": [
15    {
16      "confirmAt": "2023-10-05T14:30:00.000Z",
17      "cardMaskedNumber": "111111**1234",
18      "rrn": "123456789012",
19      "sum": 5000.11,
20      "type": "BASIC_PAYMENT",
21      "currency": "RUB"
22    }
23  ],
24  "transactions": [
25    {
26      "id": 67946879687,
27      "status": "SUCCESS",
28      "type": "WITHDRAW",
29      "accountTypeId": 180,
30      "amount": 500011,
31      "operationDate": "2023-10-05T14:30:00.000Z",
32      "createdAt": "2023-10-05T14:30:00.000Z"
33    }
34  ]
35}
BODY
атрибут
описание
error
stringoptional

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

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

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

Пример ошибки 400 (Bad Request) 
1{
2  "error": "validation_error",
3  "error_description": "Query parameter 'includeTransactions' must be a boolean value (true or false)"
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

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

  • •
    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 - эндпоинт не найден или неактивен
  • •
    order_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

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

  • •
    internal_error/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

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

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

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

Пример ошибки 502 (Bad Gateway) 
1{
2  "error": "external_error",
3  "error_description": "External error"
4}
Нет тела ответа
Получение списка промокодов клиентаПроверка доступности оформления новой кредитной заявки