Any remaining balance stays on the card for next time.<\/li>\n<\/ol>\n\nFor Developers<\/h3>\n\nREST API<\/h4>\n\n
Base: https:\/\/your-store.example\/wp-json\/wc-bgcw\/v1\/<\/code>. Authenticate with WooCommerce REST API keys or a WordPress application password. Requires the manage_woocommerce<\/code> capability.<\/p>\n\n\n- GET \/gift-cards \u2014 List. Params: page, per_page (up to 100), search, status, source, orderby, order.<\/li>\n
- POST \/gift-cards \u2014 Create. Body: amount*, source* (paid_offline, promotion, compensation), recipient_name, recipient_email, sender_name, sender_email, message, expires_at, product_id, send_email (default true).<\/li>\n
- GET \/gift-cards\/{id} \u2014 Single card.<\/li>\n
- GET \/gift-cards\/code\/{code} \u2014 Single card by code.<\/li>\n
- PATCH \/gift-cards\/{id} \u2014 Update status (active\/disabled), source, recipient\/sender fields, message, expires_at, product_id.<\/li>\n
- POST \/gift-cards\/{id}\/adjust \u2014 Change balance. Body: amount (positive adds, negative deducts), note.<\/li>\n
- GET \/gift-cards\/{id}\/transactions \u2014 Transaction history.<\/li>\n
- DELETE \/gift-cards\/{id}?force=true \u2014 Permanently delete a card.<\/li>\n<\/ul>\n\n
Dates are ISO 8601 in UTC (for example 2032-01-31T00:00:00Z<\/code>). Every card includes source<\/code> and is_paid<\/code>, and orders that used a gift card record the paid and free amounts redeemed.<\/p>\n\nExample: curl -u ck_xxx:cs_xxx \"https:\/\/your-store.example\/wp-json\/wc-bgcw\/v1\/gift-cards?source=promotion\"<\/code><\/p>\n\nHooks<\/h4>\n\n
Actions: bgcw_gift_card_created<\/code>, bgcw_gift_card_deleted<\/code>, bgcw_after_deduct_balance<\/code>, bgcw_after_restore_balance<\/code>, bgcw_my_account_card_actions<\/code>, bgcw_product_form_after_recipient_fields<\/code>.<\/p>\n\nFilters: bgcw_gift_card_creation_args<\/code>, bgcw_add_to_cart_validation<\/code>, bgcw_add_to_cart_data<\/code>, bgcw_validate_amount_limits<\/code>, bgcw_should_send_email_now<\/code>, bgcw_email_template_html<\/code>, bgcw_coupon_valid_for_gift_card<\/code>, bgcw_refund_as_store_credit<\/code>, bgcw_show_recipient_name_field<\/code>, bgcw_show_recipient_email_field<\/code>, bgcw_show_personal_message_field<\/code>, bgcw_rest_permission<\/code>.<\/p>\n\nExample \u2014 hide the Recipient Email field (the buyer's email is used instead):<\/p>\n\n
add_filter( 'bgcw_show_recipient_email_field', '__return_false' );\n<\/code><\/pre>\n\nThe email template can be overridden by copying templates\/emails\/gift-card-delivery.php<\/code> to your theme's woocommerce\/emails\/<\/code> folder.<\/p>\n\n\n\n- Install the plugin from the Plugins screen, or upload the
beltoft-gift-cards<\/code> folder to \/wp-content\/plugins\/<\/code>.<\/li>\n- Activate the plugin.<\/li>\n
- Go to WooCommerce > Gift Cards > Settings<\/strong> to set amounts, expiry and other options.<\/li>\n
- Create a new product and choose Gift card<\/strong> as the product type.<\/li>\n
- Optionally change the email under WooCommerce > Settings > Emails > Gift Card Delivery<\/strong>.<\/li>\n<\/ol>\n\n\n
\nHow do customers use a gift card?<\/h3><\/dt>\nThey type the code in the normal coupon field at checkout, or click \"Shop Now\" in the gift card email to have it applied automatically.<\/p><\/dd>\n
Can I show a separate gift card field?<\/h3><\/dt>\nYes. Turn on \"Dedicated Gift Card Field\" under WooCommerce > Gift Cards > Settings. It can be placed automatically on the cart and checkout, or wherever you put the [bgcw_apply_field]<\/code> shortcode.<\/p><\/dd>\nCan a gift card be used more than once?<\/h3><\/dt>\nYes, until the balance runs out. If the card is worth more than the order, only what's needed is used and the rest stays on the card.<\/p><\/dd>\n
What happens when an order is refunded?<\/h3><\/dt>\nIf the order was paid with a gift card, the money goes back onto the card. Partial refunds put back a matching share.<\/p><\/dd>\n
Can I create gift cards by hand?<\/h3><\/dt>\nYes. Go to WooCommerce > Gift Cards and click \"Add Gift Card\". Choose the amount, the recipient and why the card is issued (paid offline, promotion or compensation).<\/p><\/dd>\n
Do gift cards expire?<\/h3><\/dt>\nBy default after 365 days. You can change the number of days, or set it to 0 so cards never expire.<\/p><\/dd>\n
Are gift cards taxed?<\/h3><\/dt>\nNo, the gift card product itself is not taxed. When a gift card is used, its value is deducted from the order the same way a coupon is.<\/p><\/dd>\n
Does it work with page builders like Bricks or Elementor?<\/h3><\/dt>\nYes. Use the [bgcw_product_form]<\/code> shortcode in your product template.<\/p><\/dd>\nDoes it work with the block checkout?<\/h3><\/dt>\nYes. Gift cards work on both the classic and the block cart and checkout.<\/p><\/dd>\n
Can customers see their balance?<\/h3><\/dt>\nYes. The \"Gift Cards\" page in My Account shows every card they bought or received, the balance and the history.<\/p><\/dd>\n
Can I connect it to my accounting system?<\/h3><\/dt>\nYes, through the REST API. See the developer notes below.<\/p><\/dd>\n\n<\/dl>\n\n\n
1.6.4<\/h4>\n\n\n- Improved: Readme rewritten in plain language. It now covers product-locked gift cards, expiry, block checkout support and all developer hooks, and the tax answer in the FAQ is corrected.<\/li>\n<\/ul>\n\n
1.6.3<\/h4>\n\n\n- Improved: The My Account gift cards list now stacks each card with labelled rows on small screens instead of a cramped table.<\/li>\n<\/ul>\n\n
1.6.2<\/h4>\n\n\n- Improved: Complete European Portuguese (pt_PT) translation.<\/li>\n<\/ul>\n\n
1.6.1<\/h4>\n\n\n- Fixed: A product-locked code from the email link now waits until the product is in the cart (variable products) and is applied automatically, instead of reporting success on a failed apply.<\/li>\n
- Fixed: The dedicated gift card field reports when a code could not be applied, and explains when a card is locked to a product not yet in the cart.<\/li>\n
- Fixed: Bulk \"Remove product restriction\" counts only cards that were locked; admin list loads product names in one query.<\/li>\n<\/ul>\n\n
1.6.0<\/h4>\n\n\n- Added: Gift cards can be locked to a specific product. A locked card only discounts that product, the email link adds the product to the cart with the code applied, and admins can remove the restriction from the gift card list.<\/li>\n
- Added:
product_id<\/code> on the REST API (read, create, update) and bgcw_validate_amount_limits<\/code> filter.<\/li>\n- Added: \"For: product\" shown in cart, My Account, admin list and emails for locked cards.<\/li>\n<\/ul>\n\n
1.5.1<\/h4>\n\n\n- Added:
bgcw_gift_card_deleted<\/code> and bgcw_my_account_card_actions<\/code> hooks for extensions.<\/li>\n<\/ul>\n\n1.5.0<\/h4>\n\n\n- Added: Gift card
source<\/code> (shop order, paid offline, promotion, compensation). Manual creation now asks for a source.<\/li>\n- Added: Redeeming orders record each gift card's source and paid\/free status on the coupon line, plus paid\/free redeemed totals on the order.<\/li>\n
- Added: REST API
wc-bgcw\/v1<\/code> for listing, creating, updating, adjusting, and deleting gift cards. Works with WooCommerce REST API keys.<\/li>\n- Added:
bgcw_rest_permission<\/code> filter.<\/li>\n- Changed: Existing gift cards are classified by source on upgrade: cards with an order ID become \"order\" (paid), all others \"promotion\" (free). If you use the Pro add-on's store credit or BOGO features, review those cards' source via the REST API and adjust with PATCH.<\/li>\n
- Fixed: Gift card balances were not deducted, and no gift card data was recorded, on orders placed through the block (Store API) checkout.<\/li>\n<\/ul>\n\n
1.4.8<\/h4>\n\n\n- Fixed: Search in the admin Gift Cards list did nothing.<\/li>\n<\/ul>\n\n
1.4.7<\/h4>\n\n\n- Added: \"Block Coupons on Gift Card Products\" setting (enabled by default). WooCommerce coupons no longer discount gift card line items, which closes a loophole where a discounted gift card was redeemed at full face value. Other items in the cart are still discounted.<\/li>\n
- Added:
bgcw_coupon_valid_for_gift_card<\/code> filter to allow specific coupons on gift card products.<\/li>\n- Tested with WordPress 7.1 and WooCommerce 10.7.<\/li>\n<\/ul>\n\n
1.4.6<\/h4>\n\n\n- Tested with WordPress 7.0.<\/li>\n<\/ul>\n\n
1.4.5<\/h4>\n\n\n- Fixed: Initial \"Show\" button label on the My Account \u2192 Gift Cards page now reads \"Show code\", matching the toggled \"Hide code\" \/ \"Show code\" labels for consistency.<\/li>\n<\/ul>\n\n
1.4.4<\/h4>\n\n\n- Added: Show\/Hide toggle for gift card codes on the My Account \u2192 Gift Cards page (codes are masked by default).<\/li>\n
- Added: Filters
bgcw_show_recipient_name_field<\/code>, bgcw_show_recipient_email_field<\/code>, and bgcw_show_personal_message_field<\/code> to hide individual recipient fields on the product page.<\/li>\n- Fixed: Transaction notes now translate at display time instead of being stored in the locale that was active when the row was written.<\/li>\n<\/ul>\n\n
1.4.3<\/h4>\n\n\n- Fixed General settings tab missing on non-gift-card products.<\/li>\n<\/ul>\n\n
1.4.2<\/h4>\n\n\n- Added GitHub Actions workflow for automated WordPress.org deployment.<\/li>\n<\/ul>\n\n
1.4.1<\/h4>\n\n\n- Added
width: 100%<\/code> to gift card product fields container for better theme compatibility.<\/li>\n- Added placeholder text to Predefined Amounts field on the product edit page.<\/li>\n<\/ul>\n\n
1.4.0<\/h4>\n\n\n- Renamed plugin slug and folder to
beltoft-gift-cards<\/code>.<\/li>\n- Renamed text domain to
beltoft-gift-cards<\/code>.<\/li>\n- Replaced inline scripts with
wp_add_inline_script()<\/code>.<\/li>\n- Fixed double-escaping on gift card price display.<\/li>\n
- Improved input sanitization on all add-to-cart POST data.<\/li>\n
- Moved all inline styles to external CSS files.<\/li>\n
- Added
wp_cache_delete()<\/code> calls after custom table writes.<\/li>\n- Updated author to beltoft.net.<\/li>\n<\/ul>\n\n
1.3.0<\/h4>\n\n\n- Improved: MySQL advisory lock for concurrent balance deductions.<\/li>\n
- Improved: SQL-level pagination for My Account gift cards.<\/li>\n
- Improved: Bulk gift card code lookups in cart and Store API.<\/li>\n
- Improved: Expiry sync moved to WP-Cron (hourly) with composite DB index.<\/li>\n
- Fixed: Tax-inclusive discount amount in balance deductions.<\/li>\n
- Fixed: Refund safety guard requires prior deduction before restoring balance.<\/li>\n
- Added: Block checkout support \u2014 gift card codes identified via Store API extension.<\/li>\n<\/ul>\n\n
1.0.0<\/h4>\n\n\n- Initial release.<\/li>\n
- Gift card product type with predefined and custom amounts.<\/li>\n
- Email delivery to recipients using WooCommerce email templates.<\/li>\n
- Auto-apply gift card from email \"Shop Now\" link.<\/li>\n
- Virtual coupon integration \u2014 gift card discounts display natively between subtotal and total with WooCommerce [Remove] link.<\/li>\n
- Optional dedicated \"Apply Gift Card\" field with automatic or shortcode-only placement.<\/li>\n
- Personal message displayed in cart and order details.<\/li>\n
- Price range display in shop catalog (e.g., \"$25 \u2013 $100\").<\/li>\n
- Balance tracking with partial redemption.<\/li>\n
- My Account tab for viewing gift cards and transactions.<\/li>\n
- Admin dashboard, gift card list with bulk actions, and manual creation.<\/li>\n
- Order meta box showing created and used gift cards.<\/li>\n
- Automatic balance restore on cancel\/refund with partial refund support.<\/li>\n
- Loyalty Rewards for WooCommerce integration \u2014 block or allow loyalty points for gift card purchases.<\/li>\n
- Atomic balance deduction to prevent race conditions.<\/li>\n
- Rate limiting on gift card code lookups.<\/li>\n
- HPOS compatibility.<\/li>\n
- Block checkout incompatibility declared (classic checkout required).<\/li>\n
- Portuguese (pt_PT) translation included.<\/li>\n<\/ul>","raw_excerpt":"Sell digital gift cards, deliver them by email, and let customers redeem them at checkout.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/290323","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=290323"}],"author":[{"embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/beltoftnet"}],"wp:attachment":[{"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=290323"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=290323"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=290323"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=290323"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=290323"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/sah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=290323"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}