Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yativo.com/llms.txt

Use this file to discover all available pages before exploring further.

Yativo’s gift card API (powered by Reloadly) lets you purchase digital gift cards across hundreds of brands globally — ideal for rewards programs, employee incentives, or customer cashback products. The cost is deducted from your USD wallet at purchase time.

​
List Gift Card Categories

Browse available gift card categories to help filter the product catalog. 
GET https://api.yativo.com/api/v1/giftcards/categories

curl -X GET 'https://api.yativo.com/api/v1/giftcards/categories' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "status": "success",
  "status_code": 200,
  "message": "Categories fetched successfully",
  "data": [
    { "id": 1, "name": "Entertainment" },
    { "id": 2, "name": "Gaming" },
    { "id": 3, "name": "Shopping" },
    { "id": 4, "name": "Food & Dining" },
    { "id": 5, "name": "Travel" }
  ]
}

​
List Available Gift Cards

Browse all purchasable gift card products. Filter by country or category. 
GET https://api.yativo.com/api/v1/giftcards
​
country
string
Filter by ISO 3166-1 alpha-2 country code (e.g. US, BR, MX, NG).
​
category_id
number
Filter by category ID from the categories endpoint.
curl -X GET 'https://api.yativo.com/api/v1/giftcards?country=US' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "status": "success",
  "status_code": 200,
  "message": "Operators retrieved successfully",
  "data": [
    {
      "id": 1,
      "name": "Amazon US",
      "brand": "Amazon",
      "country": "US",
      "currency": "USD",
      "min_amount": 1,
      "max_amount": 500,
      "fixed_amounts": [10, 25, 50, 100],
      "category": "Shopping"
    },
    {
      "id": 2,
      "name": "Netflix US",
      "brand": "Netflix",
      "country": "US",
      "currency": "USD",
      "min_amount": 15,
      "max_amount": 100,
      "fixed_amounts": [15, 25, 50, 100],
      "category": "Entertainment"
    }
  ]
}

​
Purchase a Gift Card

Purchase a gift card for a specific product. The amount is debited from your USD wallet. 
POST https://api.yativo.com/api/v1/giftcards
Requires Idempotency-Key header. The cost is charged to your wallet at purchase time — purchases are non-refundable.
​
product_id
number
required
The gift card product ID from the list endpoint.
​
amount
number
required
Face value of the gift card in its native currency. Must be within the product’s min_amount and max_amount range, or match one of its fixed_amounts.
​
quantity
number
Number of cards to purchase (default: 1).
​
recipient_email
string
Email address to deliver the gift card code to. Optional — if omitted, the code is returned in the API response only.
curl -X POST 'https://api.yativo.com/api/v1/giftcards' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: giftcard-amazon-001' \
  -d '{
    "product_id": 1,
    "amount": 50,
    "quantity": 1,
    "recipient_email": "jane@example.com"
  }'

{
  "status": "success",
  "status_code": 200,
  "message": "Giftcard request submitted successfully",
  "data": {
    "transaction_id": "gc-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "product_name": "Amazon US",
    "amount": 50,
    "currency": "USD",
    "status": "completed",
    "created_at": "2026-06-01T10:00:00.000000Z"
  }
}

​
Redeem / Get Card Instructions

Retrieve the redemption instructions and gift card code for a completed gift card purchase. 
GET https://api.yativo.com/api/v1/giftcards/redeem/{transactionId}
​
transactionId
string
required
The transaction_id returned from the purchase endpoint.
curl -X GET 'https://api.yativo.com/api/v1/giftcards/redeem/gc-a1b2c3d4-e5f6-7890-abcd-ef1234567890' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

{
  "status": "success",
  "status_code": 200,
  "message": "Giftcard instruction retrieved successfully",
  "data": {
    "transaction_id": "gc-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "product_name": "Amazon US",
    "redemption_code": "AMZN-XXXX-XXXX-XXXX",
    "pin": "1234",
    "instructions": "Visit amazon.com/redeem and enter your gift card code.",
    "expiry_date": "2028-06-01"
  }
}
Gift card redemption codes are sensitive. Treat them like cash — display them only to the intended recipient and do not log them in your application.