A complete reference for listing and purchasing virtual prepaid cards — Visa, Mastercard, American Express, PayPal, Paysafe, and more — via the Yativo API.

Authentication

All Pay Card endpoints require a Bearer Token in the request header.

Authorization: Bearer <your_token>

1. List Available Gift Cards

Retrieve all available prepaid card products.

Method: GETEndpoint: /giftcards

Example Request

GET /giftcards
Authorization: Bearer <your_token>

Response Fields Explained

Each card object in the response contains the following fields:

Field Type Description
id integer Internal record ID in Yativo
product_id string The product ID used when placing an order
product_name string Full display name of the card product
global boolean Whether the card is available globally
status string Product availability — ACTIVE means purchasable
supports_pre_order boolean Whether the card can be pre-ordered before stock is available
brand_id integer Unique ID for the card brand (e.g. Mastercard, Visa)
brand_name string Human-readable brand name
category_id integer Category grouping (e.g. 1 = Payment Cards)
category_name string Human-readable category label
country_iso string Two-letter ISO code for the card's country (e.g. US, FR)
country_name string Full country name
country_flag_url string URL to the country flag image
logo_urls string (JSON array) One or more URLs to the card's logo image
sender_currency_code string The currency you pay in (almost always USD)
recipient_currency_code string The currency loaded onto the card (e.g. USD, EUR, CAD)
sender_fee string Fixed flat fee charged to the sender on top of card value
sender_fee_percentage string Percentage-based fee charged to the sender (applied to card value)
discount_percentage string Discount applied to the product, if any
denomination_type string Either RANGE or FIXED — determines how amounts work (see below)
min_recipient_denomination string / null Minimum card value in recipient currency (for RANGE type)
max_recipient_denomination string / null Maximum card value in recipient currency (for RANGE type)
min_sender_denomination string / null Minimum amount you pay in sender currency (for RANGE type)
max_sender_denomination string / null Maximum amount you pay in sender currency (for RANGE type)
fixed_recipient_denominations string (JSON array) Available card values in recipient currency (for FIXED type)
fixed_sender_denominations string (JSON array) Corresponding amounts you pay per option (for FIXED type)
fixed_recipient_to_sender_map string (JSON object) Maps each recipient value to its exact sender cost
user_id_required boolean Whether a recipient user ID must be supplied at order time
redeem_instruction_concise string Short redemption instructions shown to the card recipient
redeem_instruction_verbose string Full redemption instructions including terms and conditions
created_at string When this product was added to the system
updated_at string When this product was last updated

Understanding Denomination Types

RANGE — Flexible Amount

The buyer can load any amount within the specified minimum and maximum.

"denomination_type": "RANGE",
"recipient_currency_code": "USD",
"min_recipient_denomination": "100.00",
"max_recipient_denomination": "499.99"