---
title: "List gift card payees"
method: GET
path: "/api/v1/payees"
---

# List gift card payees

`GET /api/v1/payees`

Returns the payees available to the authenticated client. Gift cards are the payees whose
`category` is `Giftcard` (their `type` is `EGift`), so to obtain the available gift cards call
this endpoint with `category=Giftcard`.

Each returned payee's `payee_id` is the id you use to purchase a gift card via
`POST /api/v1/gift_cards`.

This is the same payees endpoint exposed by the Billpay API (see the
[List Payees endpoint](/products/billpay/billpay-v1/other/listpayees)); it is documented here
for convenience since it is the way to discover gift cards.

**Caching:** Gift card products are not updated very often, so the catalog returned by this
endpoint when filtered by `category=Giftcard` should be cached by your application server for
**at least 7 days** to avoid unnecessary requests.

## Query parameters

- `category` string
- `page` integer
- `name` string

## Response `200`

Gift card payees retrieved successfully.

- PayeesIndexResponse
  - `meta` PayeesMeta, required — Pagination metadata.
    - `current_page` integer
    - `next_page` integer, nullable
    - `prev_page` integer, nullable
    - `total_pages` integer
    - `total_count` integer
  - `payees` GiftcardPayee[], required
    - `payee_id` string, uuid — The id you use to purchase a gift card.
    - `name` string
    - `category` string
    - `type` string
    - `currency` string
    - `reference_config` object
      - `regex` string, nullable
    - `images` object — Product images by size.
      - `small` PayeeImage
        - `id` string
        - `url` string, uri
      - `large` PayeeImage
        - `id` string
        - `url` string, uri
    - `redemption_info` string
    - `price` string — Gift card value amount.

## Other responses

- `401` — Missing or invalid Bearer token.

---

[API](https://skmtc.dev/monato/apis/monato-s-giftcards-api.md) · [All operations](https://skmtc.dev/monato/apis/monato-s-giftcards-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/monato/monato-s-giftcards-api/revisions/2ad543a96907/schema)
