API Overview
Introduction
Overview
Prezzee API is a powerful and scalable solution designed to simplify the creation and management of digital value. It enables businesses to seamlessly integrate rewards, incentives, prepaid experiences, and gift card marketplaces directly into their own platforms. Whether you're looking to boost employee recognition, enhance customer loyalty, drive specific behaviors, or run large-scale promotional campaigns, Prezzee's API provides the flexibility you need.
Built for reliability and efficiency, our API ensures secure transactions, high uptime, and rapid response times, delivering a smooth experience for both your business and your end-users. From celebrating employee milestones to powering massive consumer promotions, Prezzee's API adapts to a wide range of use cases.
With robust documentation and dedicated support, integrating Prezzee API is straightforward. This means you can focus on delivering exceptional user experiences while leveraging the full potential of digital value distribution.
Powering Diverse Digital Value Experiences
Prezzee's API fuels a wide array of digital value delivery scenarios, empowering organizations to create seamless, branded experiences across multiple sectors. Its flexibility goes beyond traditional rewards, enabling use cases that align precisely with your unique goals, audiences, and industries:
- Employee Recognition: Acknowledge achievements, milestones, or performance with digital rewards that integrate smoothly into your internal HR or engagement platforms.
- Customer Loyalty & Retention: Deliver digital incentives as part of loyalty programs, referral campaigns, or targeted promotions to drive repeat engagement and customer satisfaction.
- Behavior-Based Incentives: Encourage desired actions like completing surveys, trying new features, or participating in health initiatives (e.g., blood donation) with timely, meaningful rewards.
- Gift Card Marketplace Integration: Power fully branded marketplaces that allow users to choose from a wide selection of digital cards. This is ideal for customer choice models, points redemption, or flexible incentive schemes.
- Brand-Aligned Delivery: Maintain full control over user-facing communication. You can tailor messaging to exclude certain terms or align precisely with your brand's tone of voice, ensuring a consistent brand experience.
- Corporate Reward Programs: Streamline the distribution of digital value across a wide range of business needs, including recognition schemes, campaign rewards, and operational reimbursements.
- Promotional Prize Campaigns: Support large-scale consumer promotions where participants receive digital rewards for collecting entries, unlocking achievements, or winning randomized draws, enhancing engagement through instant value redemption.
These examples highlight the adaptability of Prezzee's API in delivering digital value across diverse scenarios, supporting both customer-facing and internal initiatives with ease.
Access & Set-up
Simplify backend management and streamline integration with Prezzee API. Our seamless onboarding experience empowers businesses to quickly integrate our services and focus on building exceptional frontend experiences or integrating with internal processes. Leave the backend complexities to Prezzee.
The sandbox environment URL is https://sandbox.prezzee.com.au/business/ .
In-order to access the sandbox environment you will be prompted to enter a username and password. This can be requested from the sales or business development representative you are liaising with.
Sign up and create a sandbox Prezzee Business Account.
Once registered, You'll need to request a unique business API key, which grants secure access to our services. Once your request is approved, you can begin placing orders.
Testing and Live Operations
Prezzee API offers two environments: sandbox and production, allowing customers to test integrations before going live.
Sandbox Access
This risk-free testing environment lets you place orders that return valid responses with fake gift card numbers, simulating real-world scenarios. Emails sent from the sandbox include a "[Sandbox]" prefix. The sandbox is dynamic and may reset periodically, so orders might disappear or change state. It's designed for flexibility with a limited set of test cards.
The sandbox is a virtual playground that empowers businesses to experiment confidently, ensuring integrations work flawlessly before going live. Additionally, in the sandbox, if you run out of funds, your account will automatically be replenished with $10,000 after the first order failure due to insufficient funds.
Production Access
After thoroughly testing in the sandbox, you can transition to the production environment for live operations with reliable performance. The production environment URL is https://business.prezzee.com.au/. Once registered, you’ll receive a unique business api_key that grants secure access to our services where you can begin placing orders.
However, before granting access to our API, we require customers to sign a Prezzee agreement, which is essential for securing discounts and other commercial benefits. Additionally, we recommend discussing how you intend to use the API, as this information can be valuable for optimising your experience and stored for future reference. Please note that before placing live orders, customers must load real funds as a prepaid float into their account.
Prezzee Platform Features
Prezzee API offers a wide array of features designed to help businesses seamlessly integrate and automate their internal business processes with the ability to send rewards, incentives and digital vouchers in real time. These versatile features can be integrated into any business solution or platform.
Authentication & Access
Utilize client credentials to create, manage user profiles, and securely access our sandbox and production environments.
Transaction Management
Submit and manage transactions through the API, with options for customization including themes, templates, and recipient notification details.
Flexible Delivery Options
Prezzee-Managed Delivery: Prezzee can send the digital value card for your business using a customised email or SMS, handling the entire notification process.
Client-Managed Delivery: Alternatively, Prezzee can provide the necessary details for you to include in your own email or SMS, allowing you to manage the notification process directly.
Product Catalogue & Customization
Access and manage your product catalogue to display available items, with options for customization, such as themes and tags/catalogue filters. Each product is designed to be easily configurable to align with your business requirements.
Notifications & Status Updates
Retrieve real-time status and details of a transaction to maintain transparency and control over the process.
Enhanced Security
Prezzee API offers robust security features, including strong encryption and secure communication protocols, to protect sensitive data and ensure safe transactions.
Language Support
Leverage Prezzee's API to support multilingual digital voucher transactions, ensuring that your users receive responses in their preferred language. Our API allows you to request translations for transaction-related data, providing a seamless and inclusive experience across diverse languages.
Managing Account Balances
Prepaid
With the prepaid option, you can top up your account with a specified amount in advance. This balance is then used to cover the cost of orders as they are placed. Prepaid funding offers control over your spending and ensures that you only use the funds available in your account.
You can check your account balance by using the Retrieve Float Balance API endpoint, which returns the following response:
{
"prepaid_credit_enabled": true,
"prepaid_balance": 715.0,
"postpaid_credit_enabled": true,
"postpaid_credit_limit": 10000.0,
"postpaid_available_balance": 5653.2
}
Order Creation
Overview
The Prezzee API focuses on efficiently creating and managing digital gift card orders. It supports issuing single or bulk vouchers, customizing delivery options, and managing complex workflows. Designed to streamline the ordering process, the API offers flexible integration with frontend applications and internal systems, ensuring seamless and reliable transactions for all your digital gifting needs.
Currency Management
Depending on the region in which you are operating, you must specify the relevant currency and ensure the correct denomination for successful order placement. Please note that each regional API only supports a single currency. If you wish to operate in a new region, you will need to clone your integration route, obtain new API keys, and configure the appropriate currency for that region. This ensures that transactions are processed accurately according to regional financial standards and exchange rates. Properly configuring your API requests with the appropriate currency code and denominations helps avoid issues with order fulfillment and ensures smooth transaction processing. You can obtain the available denominations by using the List Products or Retrieve Product API endpoints, which will return the following response.
{
"denominations": [
{
"amount": 2500,
"currency": "USD",
"price": 2500,
"price_currency": "USD",
"stock_level": "GOOD"
},
{
"amount": 5000,
"currency": "USD",
"price": 5000,
"price_currency": "USD",
"stock_level": "GOOD"
},
]
}
Order Types
Single-Item Order
Create and manage individual digital voucher orders with precise details, including recipient information and delivery preferences, for straightforward transactions.
Multi-Item Order
Facilitate bulk orders of digital vouchers, allowing you to issue multiple vouchers in a single request with parameters for efficient processing and delivery.
Order Fulfillment and Delivery
Prezzee is committed to delivering gift cards to customers promptly. From the moment an order instruction is received and processed, we aim to dispatch the card to the recipient within 10 seconds, based on the 99th percentile on a monthly basis. Exceptions include:
Stock Availability Issues
We may face delays if there are problems with stock availability or third-party supplier issues.
Delivery Options
Choose from various delivery methods to ensure vouchers reach recipients through their preferred channels, including email, SMS, or direct voucher URLs.
Send digital vouchers via email, with the option to include personalized messages and customizable email templates to enhance the recipient's experience. When placing an order with additional delivery details, including the recipient_email, the field enables a customized email to be sent to the recipient, all handled seamlessly by the Prezzee API.
Voucher_urls
Generate and manage unique URLs for digital vouchers, providing a secure way for recipients to access and redeem their vouchers directly online. If you choose to manage the delivery of digital vouchers yourself, the List Order Items API endpoint will provide you with all the necessary details for the recipient to access their digital voucher.
SMS
Deliver digital vouchers via SMS, allowing for quick and convenient access with customizable text messages to suit different contexts and recipient preferences. When placing an order with additional delivery details including the recipient_phone field enables an SMS to be sent to the recipient, all handled seamlessly by the Prezzee API.
Client-facing Services
Customization and Branding
Although our platform is powered by Prezzee, it offers the flexibility to fully integrate and showcase your brand in all customer interactions. This design ensures you can maintain a strong brand presence and deliver a personalized experience that resonates with your customers.
Custom Logos
Even though our platform is powered by Prezzee, you have the ability to brand a Prezzee Smart Card with your company's logo and a personal video or written message for emails sent to your customers. This ensures that all customer communications reflect your brand’s identity and maintain consistency across all touch_points.
Seamless Integration
Easily add your branding to emails with a straightforward setup, ensuring a consistent brand experience from the moment your customers receive an email through their interaction with your services. This approach reinforces brand recognition and fosters loyalty.
Enhanced Customer Engagement
Build trust and professionalism with well-branded emails that are both engaging and effective. Strengthen brand recognition through consistent and customized email interactions, differentiating your business from competitors.
Ongoing Support and Updates
Benefit from our expert developer support and dedicated team, ensuring your integrations run smoothly and efficiently. We provide ongoing assistance and regular updates to keep your systems up-to-date and functioning at their best. We're committed to your success and here to help every step of the way.
Expert Developer Support
Our team of expert developers is dedicated to assisting with any issues during the integration of our platform. We provide technical guidance and best practices to ensure a seamless process and help you maximize the benefits of our platform while avoiding common pitfalls.
Regular Updates
We continuously improve our platform with new features, performance upgrades, and security updates to keep your integrations current. Our updates are guided by user feedback and industry trends, ensuring the platform evolves to meet your evolving needs.
Dedicated Support Team
Our support team is available 24/7 to resolve any issues, minimizing any disruption to your operations.
Internal Services
Service Level Objectives (SLOs)
Our SLOs are crafted to deliver reliable, high-performance service consistently. This commitment ensures that you receive dependable and efficient support, allowing you to concentrate on providing exceptional experiences to your customers.
Response Time
Our SLO offers a response time of less than 5 seconds for 99% of API requests per month.
API Availability
Our API boasts high availability, with a reliability of over 99.9%, ensuring consistent accessibility and minimal downtime for smooth operations. Built on a robust infrastructure, our platform is designed to handle high volumes of requests while maintaining excellent performance and uptime.
Performance Monitoring
We continuously monitor performance metrics in real-time to ensure we meet and exceed our service Levels. Our team also proactively manages and optimizes the platform to prevent potential issues, ensuring uninterrupted service.
Support and Incident Management
Our dedicated support team is available for rapid response to address any issues or concerns promptly, ensuring minimal disruption to your operations. With clear incident management procedures, we quickly identify and resolve any service-related issues.
Flexibility and Scalability
Prezzee API offers unparalleled flexibility and scalability, empowering businesses to grow and adapt their services. By leveraging best-in-class services, businesses can seamlessly integrate with their existing processes and create innovative experiences for customers and employees. Our platform evolves with your business, ensuring that your technology infrastructure meets your needs as you scale, so you can focus on driving innovation and enhancing customer satisfaction.
Flexible Integration Options
Our API supports various programming languages, making it easy to integrate regardless of your tech stack.
Adaptable Data Management
Manage data processing in real-time, ensuring your applications can respond quickly to user actions and events.
Scalable Infrastructure
Our platform features elastic scaling to handle increased loads, whether from spikes in traffic or steady user growth. Advanced load balancing techniques ensure high availability and performance by distributing requests evenly across servers. Additionally, our robust infrastructure includes redundancy and failover mechanisms to maintain service continuity in case of failures.
High Performance and Reliability
Our platform delivers optimized performance with low latency and high throughput, ensuring fast and reliable responses for your applications. You can also rely on our impressive uptime service levels to keep your services consistently available and operational.
Future-Proof Solutions
Stay ahead with regular updates and enhancements that incorporate the latest technologies and industry best practices.
Global Reach and Support
Leverage our geographically distributed servers for fast and reliable access worldwide, complemented by comprehensive 24/7 support and a rich knowledge base to assist you in troubleshooting issues and optimizing your integration.
Security
At Prezzee API, the security of your data and transactions is our highest priority. Our platform is built with security at its core, incorporating robust measures to ensure safety and compliance with the highest industry standards. By choosing Prezzee API, you benefit from advanced encryption, comprehensive fraud detection, and proactive monitoring, ensuring that your integration remains secure and your data protected. This allows you to confidently focus on delivering exceptional services to your customers.
Data Encryption
All data transmitted between your systems and our API is encrypted using HTTPS protocols to protect against interception and tampering.
Authentication and Authorization
Secure access to our API is managed through API keys, ensuring that only authorized users and systems can interact with our services.
Fraud Prevention
We employ advanced fraud monitoring tools and real-time analysis to detect and prevent fraudulent transactions. This proactive approach helps us mitigate risks and protect your transactions from potential threats.
Monitoring
Our platform is equipped with state-of-the-art monitoring tools to ensure the reliability and performance of our services. Here’s how we manage and enhance your experience:
Comprehensive Monitoring with Datadog
We utilize Datadog for real-time monitoring of API usage and performance, capturing detailed logs and traces of all transactions. This comprehensive oversight provides us with deep visibility into each transaction, enabling us to promptly identify and address any issues that arise.
Performance Tracking
We track essential performance metrics such as response times, error rates, and throughput to assess the health of our application and identify areas needing attention. Custom dashboards are created to visualize these key metrics and trends, allowing us to stay informed and make proactive adjustments as necessary.
API Capabilities
Our comprehensive API specifications cover all endpoints, including query parameters, response details, specific use cases, and important considerations. This thorough documentation ensures a smooth and effective integration process. With detailed API guidance and practical tips, you can confidently leverage the full potential of our platform, ensuring a seamless and efficient development experience.
Endpoint Documentation
Our documentation offers detailed information on all available endpoints, including comprehensive guidance on how to interact with each one. Each endpoint is thoroughly documented with all possible query parameters, explaining their purpose and usage to help you construct precise and effective API requests.
Response Details
Detailed descriptions of the expected responses for each endpoint, including data structures, fields, and example values.
Use Cases and Considerations
Guidelines and best practices to consider when using our API, ensuring optimal performance, security, and reliability.
Our API provides a wide range of capabilities designed to enhance your experience and streamline your operations. With a comprehensive set of endpoints, you can manage and interact with products, orders, and promotions effectively. Here’s a summary of the functionalities available to you:
- Retrieve a list of products available for purchase, including details such as themes and valid amounts.
- Obtain detailed information on specific products, including customization options and associated details.
- Access available styles for customizing the appearance of products.
- View all orders placed, with essential details for tracking and management.
- Place new orders, specifying products, themes, templates, promotions, senders, recipients, and custom messages.
- Get detailed information on specific orders, including status, delivery updates, and costs.
- View items included in an order, with details on each item's status and attributes.
- Check the balance of available funds or credits for managing financial transactions.
- Access detailed invoices for specific orders, including cost breakdowns and applied promotions.
- Get information on available sender profiles for personalizing orders.
- Obtain consolidated invoices summarizing multiple orders for comprehensive financial tracking.
- Access available discounts that can be applied to orders for promotional purposes.
- Retrieve current promotions applicable to orders, with details on terms and eligibility.
- Get detailed information on items included in specific promotions, including applicable discounts.
- Generate a new PIN for a gift voucher if needed, ensuring continued security and validity.
Voucher PIN Solution
Our API includes a robust Voucher PIN security feature that enhances the protection of digital vouchers, ensuring that voucher URLs remain secure and unusable if intercepted. By implementing the Voucher PIN security solution, you can ensure that your digital vouchers are protected against unauthorized use, providing both senders and recipients with greater peace of mind.
How It Works
PIN-Enabled Vouchers
When a digital voucher is created, a unique PIN is generated and associated with the voucher. This PIN is required to redeem the voucher, adding an extra layer of security.
Secure Redemption Process
To redeem a voucher, the recipient must not only have the voucher URL but also enter the correct PIN. This two-step verification ensures that even if the URL is intercepted, it cannot be redeemed without the corresponding PIN. When the consumer clicks on the link to unwrap their voucher, they will be forwarded to the voucher_pin validation page. Once the user has entered a valid voucher_pin, they will be forwarded to the product page.
Encrypted Communication
The voucher PIN is transmitted securely using encryption, further protecting it from unauthorized access during transmission.
Invalidation on Unauthorized Attempts
After too many incorrect attempts, the voucher_pin and voucher_url will expire. The recipient will be asked to request a new voucher_pin and voucher_url via email/SMS. This is when Prezzee handles delivery of the voucher.
Key Benefits
Enhanced Security
The voucher cannot be redeemed without both the URL and the correct PIN, protecting against interception.
Peace of Mind
Senders can be confident that their vouchers are delivered securely, reducing the risk of fraud or unauthorized access.
User-Friendly
The redemption process is straightforward for legitimate recipients, while potential attackers are thwarted by the additional security layer.