Reference

List Gift Card Artwork

Retrieve all available gift card designs and artwork options to see what visual templates you can use for your gift cards. This helps you browse and select the design that best matches your brand before creating gift cards.

Upload Gift Card Artwork

Upload custom artwork images for your gift cards to create branded, professional-looking designs that match your business identity.

Get Company Details

Retrieve your company's profile information and settings from your Gift Up account. This gives you access to details about your business configuration and account setup.

List Gift Cards

Retrieve all gift cards from your account with optional filtering to find specific cards by status, amount, or other criteria. Use this to manage and track your gift card inventory and sales.

Redeem Gift Card

Process a purchase or transaction by deducting a specified amount from a customer's gift card balance. This ensures accurate balance tracking and prevents overdrafts on insufficient gift card funds.

Top Up Gift Card

Add funds or value to an existing gift card to increase its balance, enabling you to replenish inventory or fulfill customer requests for additional credit.

Get Gift Card by Code

Retrieve detailed information about a specific gift card using its code, including current balance, status, and transaction history.

Reactivate Gift Card

Restore a voided gift card back to active status so it can be used again by customers. This is helpful when a gift card was accidentally voided or a customer's transaction was cancelled.

Redeem Gift Card In Full

Process a complete gift card redemption by deducting the entire remaining balance in one transaction, useful for finalizing sales or clearing gift card inventory.

Undo Gift Card Redemption

Reverse a gift card redemption transaction and restore the redeemed amount back to the customer's gift card balance. This is useful when you need to correct mistakes or handle customer refunds related to gift card purchases.

Update Gift Card

Modify gift card details such as recipient information, expiry dates, balance adjustments, or terms after creation. Use this to keep gift card information current and manage customer needs without issuing replacement cards.

Void Gift Card

Permanently deactivates a gift card so it cannot be used for any future purchases or redemptions. Use this when you need to cancel or invalidate a gift card.

Get Stripe Connection

Retrieve your current Stripe payment integration settings to verify your payment configuration and connection status with Gift Up.

Update Stripe Connection

Reconfigure your Stripe payment settings to manage how customers pay for gifts through your Gift Up account, including updating payment methods and connection details.

Create Item

Add new products to your Gift Up store, such as gift cards, vouchers, or passes, with customizable pricing and availability settings.

List Items

Retrieve all available items (gift cards, passes, and other products) from your Gift Up account, with optional filtering by group to see inventory and pricing details.

Create Item Group

Creates a new item group to organize and bundle related products in your Gift Up checkout experience. This helps you structure your catalog and guide customers through a logical product selection process.

Delete Item

Remove items from your Gift Up checkout to stop selling them or correct inventory mistakes. Use this when you need to permanently delete a product listing.

Delete Item Group

Remove an empty item group from your Gift Up store to keep your product organization clean and streamlined. Use this when you've consolidated products or no longer need a particular category.

Get Item by ID

Retrieve complete details about a specific gift item including pricing, availability, stock levels, and settings. This helps you access accurate product information whenever you need to verify or display item data.

List Item Groups

Retrieve all available item groups to organize and filter products in your gift catalog. This helps you manage product categories and structure your gift offerings for better customer browsing.

Update Item

Modify any property of a gift card item such as name, price, description, or stock levels using targeted updates without replacing the entire item.

Update Item Group

Modify the properties of an existing item group, such as its name, description, display settings, and sorting order. This lets you refine how product collections or gift bundles are organized and presented to customers.

List Locations

Retrieves all physical locations where your gift cards are sold and redeemed, helping you track distribution across your business venues.

Create Order

Create a new gift card order that generates one or more gift cards ready for distribution to customers or employees. This operation captures all transaction details and produces gift card codes with balances that can be immediately used or sent out.

Add Note to Order

Attach internal notes to orders to track important order details, follow-ups, or custom requests without affecting the customer's order record.

Get Order by ID

Retrieve complete details about a specific order including all gift cards, payment information, and customer data to verify transactions and fulfill orders accurately.

Update Order

Modify order details such as purchaser name, email, and other properties after an order has been created. This is useful when you need to correct information or update order data in your gift card system.

List Promotions

Retrieve all available promotion codes and their details to manage discounts offered during the gift checkout process. This helps you understand what promotional offers are currently active and applicable to customers.

List Report Transactions

Retrieve a list of gift card transactions with optional filtering to view sales activity, customer purchases, and redemption details. Use this to monitor gift card performance and analyze customer engagement.

Get Report Transaction

Retrieve detailed transaction information for a specific gift card or payment transaction using its ID, enabling you to verify transaction details, reconcile records, and maintain accurate financial documentation.

Get Checkout Settings

Retrieve your current checkout configuration settings to verify how your gift campaigns are set up and ensure all payment and customer experience options match your business requirements.

Get Email Settings

Retrieve your Gift Up account's email configuration including sender details, receipt settings, and notification preferences to understand how your account is currently set up for email communications.

Get Gift Card Settings

Retrieves your gift card configuration details such as code format, expiration policies, and how gift cards appear to customers. Use this to understand and verify your current gift card settings before launching promotions or troubleshooting customer issues.

Get Shipping Settings

Retrieve your postal delivery configuration for physical gift cards to verify shipping settings and ensure proper delivery setup. This helps you understand how gift cards will be distributed to recipients.

Update Email Settings

Modify your gift card and receipt email settings such as sender details, content, branding, and footer text to match your business identity. This allows you to customize email communications without replacing your entire configuration.

Update Gift Card Settings

Modify your gift card configuration such as code format, expiration policies, and how gift cards appear to customers without recreating them from scratch.

API Health Check

Verify that your Gift Up! API connection is active and properly configured so you can ensure your integrations are working before processing gift card operations.

Health Check (POST)

Verify that your Gift Up integration is connected and working properly by sending a test request that confirms API accessibility.

List GiftUp Users

Retrieve all users who have access to your Gift Up! account to manage team members and permissions. Use this to maintain visibility over who can view and manage your gift campaigns and account settings.

Subscribe to Webhook

Register a callback URL to receive real-time notifications when Gift Up! events occur, such as new orders or gift card activities. This enables you to automatically respond to customer actions without manually checking your Gift Up! account.

Delete Webhook

Remove a webhook subscription that's no longer needed, stopping automated notifications from being sent to your application.

Get Webhook

Retrieve detailed configuration and status information for a specific webhook subscription by ID. This helps you verify webhook settings and troubleshoot delivery issues.

List Webhooks

Retrieve all webhooks configured for your Gift Up account to monitor and audit your event subscriptions and notification settings.