Scope
cpa-transactions
Описание
Метод предназначен для компаний, заинтересованных в возврате части стоимости покупок своим клиентам при выполнении условий специальных предложений, размещённых в приложении Альфа-Банка или на сайте партнёра. Позволяет отправить данные по заказу, оплаченному картой Альфа-Банка, для начисления или отмены начисления клиенту кэшбэка за покупку.
Параметры запроса
Bearer {access_token}, полученный по Client Credentials Flow
application/json
Наименование спонсора/бренда
Статус заказа для начисления кэшбэка. Возможные значения:
-
•
pending- предварительное начисление (новый заказ); -
•
approved- подтверждённое начисление (реализованный заказ); -
•
declined- отменённое начисление (отменённый заказ)
id заказа на стороне партнёра
Дата и время создания заказа в формате ISO 8601 c обозначением временной зоны
Дата и время последнего изменения заказа в формате ISO 8601 c обозначением временной зоны
Дата планируемой утилизации заказа в формате ISO 8601 c обозначением временной зоны. Используется в случае работы с предварительными начислениями. Поле должно быть согласовано с банком перед отправкой
Сумма заказа
Код валюты, использованный при оплате, в формате ISO 4217. Значение по умолчанию: RUB
ID клиента. Заполняется для заказов, оформленных клиентом при переходе по офферу из приложения Альфа-Банка, значением query-параметра sub1 из ссылки редиректа на сайт партнёра
Сумма, на которую необходимо начислить кэшбэк. Передаваемое значение не может быть больше значения sum, иначе в ответе будет получена ошибка. Если сумма не указана, то начисление кэшбэка будет происходить по значению sum
Сумма, которая должна быть начислена/отменена для начислению клиенту в бонусных единицах. Поле должно быть согласовано с банком перед отправкой
Маскированный номер карты, с которой клиент оплатил заказ. Хотя бы одно поле из cardMaskedNumber или rrn должно быть обязательно заполнено
ID банковской транзакции. Хотя бы одно поле из cardMaskedNumber или rrn должно быть обязательно заполнено
ID оффера. Поле должно быть согласовано с банком перед отправкой
Номер токена платежа, полученный при оплате через GooglePay/ApplePay
ID процентной категории по которой должен быть начислен кэшбэк. Поле должно быть согласовано с банком перед отправкой
Тип сервиса, в котором была совершена покупка. Поле должно быть согласовано с банком перед отправкой
Причина отмены заказа или комментарий к заказу. Заполняется партнёром и не отображается клиенту
Текстовое сообщение, которое может быть отображено клиенту. Заполняется партнёром
Объект с данными по заказу. Поле должно быть согласовано с банком перед отправкой
Тип товара
Адрес или город для одного из сценариев:
-
•доставка;
-
•место проведения мероприятия;
-
•место покупки
Наименование места для одного из сценариев:
-
•доставка;
-
•место проведения мероприятия;
-
•место покупки
Дата и время доставки или проведения мероприятия из заказа в формате ISO8601 c обозначением временной зоны
Наименование компании-продавца
Наименование компании-перевозчика
Список товарных позиций
ID товара
Наименование товара
Количество товара
Описание товара
1curl --location 'https://baas.alfabank.ru/api/cpa-transactions/pp/v1/cashbacks' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5 "brandName": "Market",
6 "cashbackStatus": "approved",
7 "externalId": "AJDJ-1234567890",
8 "createdAt": "2025-04-05T14:30:00+03:00",
9 "updatedAt": "2025-04-05T15:00:00+03:00",
10 "disposalAt": "2025-04-05T18:00:00+03:00",
11 "sum": 45999.99,
12 "currency": "RUB",
13 "customerId": "ABCDEF123456",
14 "goodsSum": 44000.99,
15 "cashbackSum": 440,
16 "cardMaskedNumber": "1234****1234",
17 "rrn": "AZ9876543210",
18 "offerId": 1234,
19 "tokenCode": 9081707001112346000,
20 "percentCategoryId": 8,
21 "serviceType": "market",
22 "comment": "Отменен покупателем",
23 "clientText": "Отмена по вашей инициативе",
24 "orderInfo": {
25 "type": "products",
26 "address": "г. Москва, ул. Пушкина - Колотушкина, д. 8",
27 "placeName": "Маркетплейс",
28 "date": "2025-04-05T17:30:00+03:00",
29 "seller": "Шестёрочка",
30 "carrier": "СДЭК",
31 "items": [
32 {
33 "id": 413413,
34 "name": "Астраханская икра осетровая забойная Золотой Стандарт АРК Белуга, 250 г.",
35 "count": 2,
36 "description": "Черная икра в банке"
37 }
38 ]
39 }
40}'Параметры ответа
1Нет тела ответаКод ошибки. Принимает возможные значения:
-
•
invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "invalid_request",
3 "error_description": "Authorization header is not present in request headers"
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}Код ошибки. Принимает возможные значения:
-
•
insufficient_scope- при запросе токена доступа не были переданы все необходимые scopes. Необходимо повторно отправить запрос на получение токена доступа с указанием всех доступных scopes
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_error",
3 "error_description": "Internal server error"
4}