Подарочные карты
Подарочные карты магазина: номинал, остаток и долг магазина по карте. Код карты не хранится и не отдаётся.
Подарочные карты
Объекты
GiftCard
idintegerобязательноID записи, уникальный среди записей своего вида в магазине.
last4stringобязательноПоследние четыре символа кода карты — по ним её узнают в руках покупателя. Сам код не хранится.
statusstringобязательноСостояние: active — принимается к оплате, пока есть остаток и не истёк срок; pending_payment — продана безналичным способом, оплата ещё не подтверждена; disabled — заблокирована (утеряна, спор), долг сохраняется; deactivated — аннулирована, остаток погашен.
- Значения:
activepending_paymentdisableddeactivated
currencystringобязательноВалюта сумм, код ISO 4217: валюта магазина.
- Значения:
ARSUSDBRLCLPCOPMXNPENRUB
initial_amountintegerобязательноНоминал при выпуске, в минимальных единицах валюты.
balanceintegerобязательноОстаток на карте в минимальных единицах валюты — сумма строк её журнала (/v1/gift-card-transactions).
outstandingintegerобязательноДолг магазина по карте: остаток, кроме неоплаченной карты (pending_payment) — за неё денег не поступало. Заблокированная и истёкшая карта долг сохраняют.
expires_atstring (date-time) или nullобязательноКонец срока действия; null — бессрочная. Истёкшая карта к оплате не принимается.
issued_atstring (date-time)обязательноКогда карта выпущена.
issued_order_idinteger или nullобязательноID заказа (/v1/orders), которым карту продали; null — выпуск без продажи (компенсация, промо).
reissued_from_idinteger или nullобязательноID карты, с которой перевыпуском перенесён остаток; null у обычного выпуска.
customer_idinteger или nullID покупателя-владельца (/v1/customers); null — карта на предъявителя. Только с доступом к покупателям.
notestring или nullобязательноЗаметка сотрудника при выпуске; null, если её нет.
created_atstring (date-time)обязательноКогда запись создана.
updated_atstring (date-time)обязательноКогда запись менялась последний раз.
Методы
Подарочные карты: номинал, остаток и долг магазина по каждой карте
get/gift-cards
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})$
Ответы
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-cards" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"data": [
{
"id": 0,
"last4": "string",
"status": "active",
"currency": "ARS",
"initial_amount": 0,
"balance": 0,
"outstanding": 0,
"expires_at": "2026-01-15T12:00:00Z",
"issued_at": "2026-01-15T12:00:00Z",
"issued_order_id": 0,
"reissued_from_id": 0,
"customer_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_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-cards/{card}
Scope: finance:read
Параметры
Путь
cardintegerобязательноID подарочной карты.
Ответы
200Успешно
application/json
Возвращает GiftCard
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-cards/{card}" \
-H "Authorization: Bearer $SALEYA_API_TOKEN"{
"id": 0,
"last4": "string",
"status": "active",
"currency": "ARS",
"initial_amount": 0,
"balance": 0,
"outstanding": 0,
"expires_at": "2026-01-15T12:00:00Z",
"issued_at": "2026-01-15T12:00:00Z",
"issued_order_id": 0,
"reissued_from_id": 0,
"customer_id": 0,
"note": "string",
"created_at": "2026-01-15T12:00:00Z",
"updated_at": "2026-01-15T12:00:00Z"
}