Added

2026-04 Gift Card & Transaction Endpoints

New 2026-04 Gift Card and Gift Card Transaction endpoints are now available. These endpoints follow the 2026-04 API conventions while delegating to the same underlying gift card business logic.

What's New

Gift Card Endpoints

MethodPathDescription
POST/api/2026-04/gift_cardsCreate and activate a new gift card
GET/api/2026-04/gift_cardsList gift cards with pagination and filtering
GET/api/2026-04/gift_cards/by_number/{card_number}Find a gift card by its number
GET/api/2026-04/gift_cards/by_id/{id}Find a gift card by its ID
DELETE/api/2026-04/gift_cards/by_number/{card_number}Void a gift card by its number
DELETE/api/2026-04/gift_cards/by_id/{id}Void a gift card by its ID

Gift Card Transaction Endpoints

MethodPathDescription
POST/api/2026-04/gift_cards/{card_number}/transactionsCreate a transaction (reload or redeem)
DELETE/api/2026-04/gift_cards/transactions/{transaction_id}Reverse a redemption transaction
GET/api/2026-04/gift_cards/transactions/{transaction_id}Find a gift card by transaction ID

Key Changes

  • Response structure: All responses return the resource inside a top-level data key in the response object.
  • Monetary values as strings: Fields such as balance, total_sold, total_redeemed, and amount are now returned as strings for precision.
  • POST returns 201: Create endpoints now return 201 Created instead of 200 OK.
  • system_id support: The GET gift card by transaction ID endpoint accepts an optional system_id query parameter (defaults to x-series, also supports e-series).

These endpoints are fully backward compatible — no changes have been made to existing 2.0/3.0 or 2026-01 endpoints.