Журнал подарочных карт
Строки журнала карт: выпуск, погашение, возврат на карту, корректировка, аннулирование и блокировка. Только дописывается.
Журнал подарочных карт
Объекты
GiftCardTransaction
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
gift_card_idintegerобязательноID подарочной карты (/v1/gift-cards).
typestringобязательноВид строки: issue — выпуск; redeem — оплата картой; refund — возврат покупки на карту; adjust — ручная корректировка; void — аннулирование (карту вернули или не оплатили); block и unblock — блокировка и её снятие, без суммы; transfer_out и transfer_in — перенос остатка перевыпуском со старой карты на новую.
- Значения:
issueredeemrefundadjustvoidblockunblocktransfer_outtransfer_in
amountintegerобязательноСумма со знаком в минимальных единицах валюты: плюс — долг вырос, минус — уменьшился, 0 — блокировка и её снятие.
balance_afterintegerобязательноОстаток карты после этой строки.
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
order_idinteger или nullобязательноID заказа.
payment_idinteger или nullобязательноID платежа (/v1/payments): оплата картой способом gift_card или оплата продажи карты; null, если платежа нет.
refund_idinteger или nullобязательноID возврата (/v1/refunds), вернувшего деньги на карту или за саму карту; null, если возврата нет.
notestring или nullобязательноПричина корректировки или заметка сотрудника; null, если её нет.
created_atstring (date-time)обязательноКогда запись создана.
Методы
Журнал подарочных карт: выпуск, погашение, возврат на карту, корректировка, аннулирование, блокировка и перенос остатка
get/gift-card-transactions
Scope: finance:read
Параметры
Строка запроса
limitintegerРазмер страницы: до 250 записей; по умолчанию 50.
- Минимум:
- 1
- Максимум:
- 250
cursorstringНепрозрачный курсор: next_cursor предыдущей страницы или sync_cursor последней страницы, сохранённый прошлой синхронизацией. Список идёт в порядке коммитов, поэтому курсор синхронизации позже отдаёт только изменённое после него.
- Макс. длина:
- 4096
updated_sincestring (date-time)Только записи, изменённые после этого момента, ISO 8601 с часовым поясом. Фильтр первой синхронизации; дальше — курсор.
- Шаблон:
^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,6})?(Z|[+-]\d{2}:\d{2})$
gift_card_idintegerТолько строки этой подарочной карты.
- Минимум:
- 1
payment_idintegerТолько строки этого платежа.
- Минимум:
- 1
Ответы
200Успешно
application/json
Записи страницы.
deletedмассив objectобязательноЗаписи, стёртые из базы с момента курсора, отметками об удалении: только с include_deleted=true в продолжении по курсору синхронизации.
Поля · 2
idintegerобязательноID стёртой записи.
deleted_atstring (date-time)обязательноКогда запись стёрта.
next_cursorstring или nullобязательноКурсор следующей страницы; null на последней.
has_morebooleanобязательноtrue, если есть следующая страница.
sync_cursorstring или nullобязательноНа последней странице — курсор, с которого продолжить позже: по нему придёт только изменённое после этой страницы. null на остальных.
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
410Курсор синхронизации старше срока хранения удалений или выдан до восстановления базы
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Отказы метода
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/gift-card-transactions" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"gift_card_id": 0,
"type": "issue",
"amount": 0,
"balance_after": 0,
"currency": "ARS",
"order_id": 0,
"payment_id": 0,
"refund_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z"
}
],
"deleted": [
{
"id": 0,
"deleted_at": "2026-01-15T12:00:00Z"
}
],
"next_cursor": "string",
"has_more": true,
"sync_cursor": "string"
}Строка журнала подарочной карты
get/gift-card-transactions/{entry}
Scope: finance:read
Параметры
Путь
entryintegerобязательноID строки журнала подарочной карты.
Ответы
200Успешно
application/json
Возвращает GiftCardTransaction
401Токена нет, он неверен, истёк или отозван
Заголовки
WWW-AuthenticatestringобязательноСхема аутентификации (RFC 6750).
- Пример:
Bearer
application/problem+json
Возвращает Problem
403Запрос не разрешают тариф, IP-адрес или scopes токена
Заголовки
WWW-AuthenticatestringСхема аутентификации (RFC 6750).
- Пример:
Bearer error="insufficient_scope", scope="locations:read"
application/problem+json
Возвращает ForbiddenProblem
404Объекта нет или он недоступен приложению
application/problem+json
Возвращает Problem
422Параметр неверен или неизвестен
application/problem+json
Возвращает ValidationProblem
429Лимит запросов исчерпан
Заголовки
Retry-AfterintegerобязательноСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает RateLimitProblem
503Магазин временно недоступен
Заголовки
Retry-AfterintegerСколько секунд подождать перед повтором.
- Минимум:
- 0
application/problem+json
Возвращает Problem
Общие отказы — токен, доступ, проверка входа, лимит запросов — может вернуть любой метод, они собраны в каталоге: Ошибки
curl "https://api.saleya.app/v1/gift-card-transactions/{entry}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"gift_card_id": 0,
"type": "issue",
"amount": 0,
"balance_after": 0,
"currency": "ARS",
"order_id": 0,
"payment_id": 0,
"refund_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z"
}