Получение подарочной карты по ID

Возвращает информацию о подарочной карте по ее уникальному идентификатору.

Request

GET

https://api.kit.yandex.net/v1/gift_cards/{gift_card_id}

Responses

200 OK

Подарочная карта.

Body

application/json

{
  "id": "019b21d9-c5d9-777d-80bd-d67c664bc6d9",
  "code": "GIFTCARD-****-1234",
  "initial_amount": "1000.00",
  "spent_amount": "300.00",
  "status": "ACTIVATED",
  "expires_at": "2026-12-31T23:59:59Z",
  "buyer_name": "Иван Иванов",
  "buyer_email": "buyer@example.com",
  "buyer_phone": "+79998887766",
  "holder_email": "holder@example.com",
  "sending_date": "2026-01-01T10:30:00Z",
  "purchased_date": "2026-01-01T10:30:00Z",
  "message": "С днём рождения!"
}

Name	Description
buyer_email	Type: string Email покупателя. Example: `buyer@example.com`
buyer_name	Type: string Имя покупателя. Example: `Иван Иванов`
buyer_phone	Type: string Телефон покупателя. Example: `+79998887766`
code	Type: string Код подарочной карты. Example: `GIFTCARD-****-1234`
holder_email	Type: string Email получателя. Example: `holder@example.com`
id	Type: GiftCardID Идентификатор подарочной карты Example: `019b21d9-c5d9-777d-80bd-d67c664bc6d9`
initial_amount	Type: string<decimal> Номинал подарочной карты. Example: `1000.00`
spent_amount	Type: string<decimal> Потраченная сумма. Example: `300.00`
status	Type: GiftCardStatus Статус подарочной карты: `ACTIVATED` — активен. `DEACTIVATED` — деактивирован. `REFUND_IN_PROGRESS` — в процессе возврата. `REFUNDED` — возвращен. `CANCELLED` — отменен. Enum: `ACTIVATED`, `DEACTIVATED`, `REFUND_IN_PROGRESS`, `REFUNDED`, `CANCELLED`
expires_at	Type: string<date-time> Срок действия подарочной карты. Example: `2026-12-31T23:59:59Z`
message	Type: string Сообщение получателю. Example: `С днём рождения!`
purchased_date	Type: string<date-time> Дата покупки подарочной карты. Example: `2026-01-01T10:30:00Z`
sending_date	Type: string<date-time> Дата отправки подарочной карты получателю. Example: `2026-01-01T10:30:00Z`

GiftCardID

Идентификатор подарочной карты

Type: string<uuid>

Example: 019b21d9-c5d9-777d-80bd-d67c664bc6d9

GiftCardStatus

Статус подарочной карты:

ACTIVATED — активен.
DEACTIVATED — деактивирован.
REFUND_IN_PROGRESS — в процессе возврата.
REFUNDED — возвращен.
CANCELLED — отменен.

Type: string

Enum: ACTIVATED, DEACTIVATED, REFUND_IN_PROGRESS, REFUNDED, CANCELLED

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Получение списка подарочных карт

Список ресурсов