# The Priceless Platform API source: https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/index.md ## Overview {#overview} The Priceless Platform API is a comprehensive engine for offering cardholders the exclusive content of the Priceless experiences catalog (**Priceless Platform**), as well as the digital enablement of benefits, insurance, and all card assets that make up a consumer's payment card value proposition. In its most basic form, the Priceless Platform API empowers issuers to display card-feature content to their consumers digitally. The Priceless Platform API can bring together issuer card assets and Mastercard assets into one digital environment, driving consumer access, knowledge, and engagement---and ultimately fueling loyalty. Partners can choose between rolling out a full web-hosted solution or leveraging the Priceless Platform APIs in their technology stack. * The API is designed to be modular, so a partner can add relevant content and create a seamless experience in their own digital environment. * Based on the desired user experience, partners can choose one of the following API integration options: * Hybrid API Integration: Simplified * Hybrid API Integration: Advanced * Native API Integration: Checkout Integrated See the [use cases](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/use-cases/index.md) for more details. > You will deepen your customer's engagement by delivering the world of Priceless without them ever leaving your platform. All it takes is a thin layer of development that taps into the deep functionality and content at Mastercard's Priceless Platform. You can build applications on any digital platform, such as your mobile banking application (shown below), or something as simple as email offers that link your customers to Priceless Experiences. #### Sample mobile offering to your customer {#sample-mobile-offering-to-your-customer} ![API Integration Into Your App](https://static.developer.mastercard.com/content/mastercard-benefits-and-experiences-portal/uploads/your-app.png) #### Priceless platform content and components provided to your integration {#priceless-platform-content-and-components-provided-to-your-integration} * Experience information/metadata (description, pricing, event location, photo/video, etc.) * Filtered and categorized groupings of experiences by content type, BIN exclusivity, language, and other attributes * Inventory levels * Order creation * Checkout * Order status > Note: Availability of content and product data can vary by program and integration type. Some offer types, including punchout-based experiences, may expose a different data set than standard catalog items. #### System Diagram {#system-diagram} The system diagram below depicts the features described above at a high level. Your platform and customer interaction are on the left side, while the right side shows the key e-commerce components of the Priceless Platform. You can choose to simply show content at your end, or also handle the checkout within your app or service. Order fulfillment is facilitated by the Priceless Platform, except for punchout products, where fulfillment is completed by the third party the user is redirected to. ![System Diagram](https://static.developer.mastercard.com/content/mastercard-benefits-and-experiences-portal/uploads/system-diagram.png) ## How It Works {#how-it-works} Diagram howitworks ## Getting Started {#getting-started} ### Before You Start {#before-you-start} Use `partnerId = 659` to retrieve mock responses when you integrate and test your API requests. To complete onboarding for your assigned `partnerId`, contact your API Integration Manager. Your API Integration Manager will guide you through the onboarding process and provide the required credentials and configuration details, including: * `partner_id` - the ID that identifies you as the user of this API; * `consumer key` - the key you will use for authentication in each call to the API endpoints; * `segment codes` - you will need to agree the range of customer segment codes you will be using in the calls to the API. Segment codes may be specific to issuers. ### Prerequisite {#prerequisite} Before implementing the APIs, discuss the following requirements and preferences with your API integration manager: * Your content strategy, loyalty programs, and language requirements. * Your preferred user experience and integration model. * Whether Single Sign-On (SSO) is required. * Whether to use webviews and place orders directly through Priceless. * Whether to use order estimates before placing an order. See the [use cases](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/use-cases/index.md) for more details. Note: Please be aware that for security reasons, you are not allowed to use iFrames to display Priceless webviews inside them. On rare occasions, your domain might be granted access to Priceless webviews via an iFrame. Reach out to your API integration manager for further information. ## Glossary {#glossary} Here is a glossary of common terms used throughout this API documentation. | **Term** | **Meaning** | |-----------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Benefit | Offers, privileges, or experiences made available to cardholders based on their card product, tier, or issuer configuration. | | Bundle | A collection of benefit *instances* grouped by a theme, provider, or promotion. A bundle can have one or more instances. | | Cardholder | An owner of a credit card. | | Category | A category of *products*, usually grouped by their theme or type of activity, for example, "Books" or "Shopping". | | Checkout | A product that supports in-platform checkout and redemption through the Priceless user experience. | | Child product | A product linked to a master product and redeemable as a distinct experience or benefit. It inherits attributes and eligibility rules from the master product, but may also have its own content, redemption process, and fulfillment logic. | | Cobranded Microsite | A standalone or embedded Priceless-branded website co-designed with an issuing partner to present curated Priceless content and benefits to eligible cardholders. The microsite can be web-hosted by Mastercard and integrated with Single Sign-On (SSO). | | Combination of master and children | A product structure where the master product is the item shown in catalog results, and its child products are the options the *cardholder* can choose on the product detail page. Use the master product identifier for catalog calls and the child product identifier when constructing the WebView handoff URL for a specific option. | | Core benefit | See *fixed* benefit. | | Customer segment | An arbitrary category of *cardholders* formed by demographics, geographic locations, spending, or other metrics. For example, "London" for cardholders living in London or "Lifestyle" for cardholders who often purchase lifestyle products and services. | | Eligibility Check | A validation process that confirms a user or card can access Priceless content, programs, or benefits based on predefined rules. | | Estimate | A temporary order request used to calculate the final price of an actual order. An estimate does not charge the *cardholder's* credit card. | | Event | A digital or physical activity with a fixed date and time that a *cardholder* can attend. An *event* is a type of *product*. | | Experience | An activity, usually guided by the *vendor* or their representative, that involves the *cardholder* doing something for pleasure. An experience is a type of *product* . Unlike an *event* , an *experience* may not have a fixed date and/or location. | | Fixed benefit | Same as *core* benefit. A *benefit* that is attached to the cardholder's card and can be viewed, but cannot be activated or deactivated using this API. | | Global Benefits Platform | The Mastercard platform that powers the delivery, eligibility, and orchestration of card benefits and experiences at a global level, including Priceless. | | Hybrid APIs | An integration model that combines Priceless Platform APIs with a web-hosted or webview user experience. Content is accessed through APIs while the user experience partly relies on Mastercard-hosted components, typically with Single Sign-On (SSO). | | Instance | A specific offering that may come in a package (*bundle*) with other offerings. | | Inventory | The number of items of a particular *product* available for purchase. | | Locale | A set of country-specific settings, such as language, currency, and date and time format, that customize the user experience. | | Locations | A content classification and filtering dimension that allows Priceless experiences and benefits to be browsed or targeted by geography. | | Master product | A top-level offering in the Priceless Platform that acts as the parent for related experiences or benefits. It can include multiple child products and helps manage merchandising, eligibility, and configuration across the associated offerings. | | Native APIs | A full API-based integration where the partner builds and controls the entire user experience within their own app or site using Priceless Platform APIs. | | PAN gate | A gating mechanism that validates card eligibility using the card PAN (Primary Account Number) or derived data to restrict access to Priceless content and benefits. | | Partner | A card issuer that is granted access to the Priceless Platform API and has the authority to provide its *cardholders* with *benefits*. | | Passion categories / Priceless Passions | High-level thematic groupings used to organize Priceless content, such as Culinary, Travel, Entertainment, Sports, Art \& Culture, Wellness, and Shopping. | | Personalization (of benefits) | Choosing from the range of available card *benefits* and opting out of unneeded benefits. | | Physical product | An item, a material thing that can be shipped to the *cardholder* . This is a type of *product*. | | PID | A Priceless Platform identifier used to uniquely reference a specific product, program, or content entity within platform configurations, APIs, and integration flows. It acts as the system-level ID that enables partners and internal teams to retrieve, map, and manage Priceless content consistently across environments. | | Primary categories | Top-level content categories used for merchandising and navigation across the Priceless Platform, often aligned with passions or benefit types. | | Priceless Programs | Structured collections of experiences, benefits, or offers grouped under a specific proposition, partner, or use case. | | Product / Product type | A unit of redeemable content on the Priceless Platform, categorized by how it is fulfilled and experienced by the cardholder. | | Product tiles | The visual cards used across the Priceless user experience to represent individual products or experiences in listings, carousels, or search results. A product tile typically includes key merchandising elements such as image, title, location, category, and pricing or call to action, and serves as the entry point to the product detail page. | | Product Detail Page (PDP) | The page that displays full information about a specific Priceless product or experience, including description, imagery, terms, and a redemption call to action. | | Punchout product | A product that redirects the user outside of the Priceless Platform to complete booking or redemption with a third party. | | Redemption type | The method by which a user accesses or redeems an experience or benefit, such as checkout, code, link-out, voucher, or contact-to-book. | | Selectable benefit | A benefit that the *cardholder* can activate for their card. Normally, a selectable *bundle* consists of a single *instance*. | | Selection (of benefits) | Activating a predefined number of available card *benefits* within the current *selection window*. | | Selection window | A time frame within which the *cardholder* can make a *selection* of available benefits. Outside of the window, the cardholder must use the existing or previously selected benefits or wait for the next selection window. | | Single Sign-On (SSO) | An authentication and access handoff mechanism used in Priceless Platform integrations to allow eligible cardholders to move from a partner app, website, or digital banking environment into a Mastercard-hosted Priceless experience without creating a separate Priceless login. In this flow, the partner authenticates the user and passes the required user, eligibility, or session information to Mastercard so the Priceless Platform can recognize the user, apply the correct access rules, and deliver a seamless, personalized experience. | | Single Sign-On (SSO) Token | A sequence of characters that identifies a cardholder and allows them to browse and personalize their benefits from a web page in a browser. An SSO token is similar to a session ID. | | The Mastercard Collection | A curated set of premium dining, travel, and lifestyle experiences available on the Priceless Platform, often highlighted as a distinct catalog. | | Tiered benefit | A benefit that combines multiple *instances* within the same *bundle*. Normally, only one tiered benefit can be selected for a card. | | Tile punchout | A *punchout* product flagged as `isTilePunchout: true` in the product response. The product tile in the partner UI carries a direct destination URL. When a *cardholder* selects this tile, your app opens that URL instead of starting a standard handoff to the Priceless product detail page. | | Vendor | A person or company that published the product. This term has aliases: *celebrity* and *luminary*. Both are now deprecated. | | Webhosted | A Mastercard-hosted Priceless user experience accessed through a redirect or link-out from a partner app or website. | | Webview | An embedded browser window within a partner mobile app that displays Mastercard-hosted Priceless content while maintaining in-app navigation. | ## Mastercard branding requirement {#mastercard-branding-requirement} You are required to overlay the Mastercard symbol (logo) on all Priceless experience images. You can ask for the latest version of the logo or download it directly from the link below: [Mastercard logo](https://designcenter.mastercard.com/designcenter/asset-details.html?assetPath=logos/ma_symbol_cmyk_EPS_AI.zip) ## Next Steps {#next-steps} * If you are new to Mastercard Developers, familiarize yourself with the Authentication scheme, and [API Basics](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/api-basics/index.md) to our gateway. * Already a Mastercard Developer? Jump right to our [use cases](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/use-cases/index.md) and [tutorials](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/tutorials-and-guides/index.md).