Welcome to the Giftees API! This API enables merchants, partners, and developers to seamlessly integrate Giftees' digital gifting platform into their applications, websites, and systems. With Giftees API, you can create, manage, and track digital gift cards, allowing you to provide a smooth and delightful gifting experience for your customers.

Whether you're building a simple e-commerce integration or a full-scale gifting solution, the Giftees API provides the flexibility and tools you need. This documentation will guide you through the core concepts, endpoints, and best practices for using our API.

To explore Giftees' services, you must create a Giftees account through our Dashboard. During the account creation process, Giftees will generate both a user account and a company account for you.

• The user account is used to log in to the Dashboard and manage your settings.
• The company account represents your business and is required for managing gift card offerings and processing transactions.

Once you've created your account, you’ll have full access to explore the Giftees platform in test mode. This allows you to simulate key features, such as creating and redeeming gift cards, without involving real transactions.

When you're confident with your setup and ready to offer real digital gift cards, you can proceed with account activation to go live and start processing real transactions.

Getting started with Giftees is quick and simple—your business will be ready to provide delightful gifting experiences in no time!

To process real transactions for digital gift cards, you must activate your Giftees account.

Account Activation

Activate your Giftees account by completing the activation application. We’ll request some basic information about your business, your products or services, and your personal relationship with the business. Once you submit your application, our team will review the details. Upon approval, you can immediately start processing real digital gift card transactions and go live.

Giftees complies with "Know Your Customer" (KYC) obligations, which require us to collect and verify this information. These regulations, established by our partners and regulatory authorities, help protect our platform from fraudulent activity and misuse. The information you provide is internally reviewed to ensure compliance with our terms of service.

If any issues arise during the review, our team will contact you to request additional information.

When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API's resources, ensuring that only authorized users can make requests.

Giftees Sample API uses API keys to authenticate requests.

To retrieve your API key from app.giftees.io, follow these steps:

1. Sign in: Navigate to app.giftees.io and sign in with your credentials.
2. User Settings: Once logged in, locate the user settings.
3. Tools & Integrations Tab: Within the user settings, find the "Tools & Integrations" tab. Click on it to access settings related to integrations and tools.
4. Locate API Key: In the Tools & Integrations tab, you should find your API key listed.

Add headers to an HTTP request

Giftees uses API keys to grant access to the API. You can generate a new API key in the Giftees Dashboard. The API key must be included in all API requests to the server, using a header formatted as follows:

Authorization: Bearere {{apiKey}}

Content Types

Accepts: application/json

Content-Type: application/json

Content-Type: application/json-patch+json

A company in Giftees is also referred to as a Giftees account. Multiple users can be granted access to manage a single Giftees company account.

In Giftees, a gift card is the thoughtful surprise sent to a recipient when someone places an order through the Giftees checkout or issues it via the dashboard or API. Each gift card carries its own unique code and balance (referred to as remaining_value in our API), along with additional properties that make each gift card special.

At the heart of every gift card is an order—the parent entity that holds all the details of the transaction. A single order can include multiple gift cards, making Giftees perfect for everything from single gifts to bulk gifting occasions.

Giftees makes gifting more than just a transaction—it’s a way to create memorable moments for recipients, while giving businesses a powerful and flexible tool to manage every step of the gifting experience.