List gift card 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); 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.

{
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  },
  "payees": [
    {
      "payee_id": "1a079e9a-2bee-46e0-a993-32b714cf0c09",
      "name": "Amazon eGift - MEX",
      "category": "Giftcard",
      "type": "EGift",
      "currency": "MXN",
      "images": {
        "small": {
          "id": "MEDIUM",
          "url": "https://content.monato.com/giftcards/medium/amazon.png"
        },
        "large": {
          "id": "MEDIUM",
          "url": "https://content.monato.com/giftcards/medium/amazon.png"
        }
      },
      "price": "5.0"
    }
  ]
}