# 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 e-commerce 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. Financial institutions can choose between rolling out a web-hosted solution or leveraging APIs to the Priceless Platform into their technology stack with a native solution. * API is designed to be modular in nature, so that an issuer can add product solutions and create a seamless experience in their own digital environment. * A web-hosted solution with Single Sign-On (SSO) access from the issuer's digital environment. See the [product page](https://developer.mastercard.com/product/mastercard-benefits-and-experiences-portal) 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.com. #### 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) #### E-commerce content and components provided to your integration {#e-commerce-content-and-components-provided-to-your-integration} * Experience information (description, pricing, event location, photo/video, etc.) * Filtered and categorized groupings of Experiences * Inventory levels * Order creation * Checkout * Order status #### 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 will always be facilitated by the Priceless Platform. ![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} Reach out to your API integration manager to go through the onboarding process. You will need to receive the following details: * `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. ### Configure your partner account {#configure-your-partner-account} Let your API integration manager / customer support contact know your partner preferences, such as: * whether you want to use webviews only with no direct order placement via Priceless. See the following scenario for more details: [Show Priceless products natively; checkout via a webview on Priceless.com](https://developer.mastercard.com/mastercard-benefits-and-experiences-portal/documentation/use-cases/use-cases-4/index.md). * whether you want to skip order estimates and go straight to placing an order 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 | An offer, reward, cashback, or other perk or service offered to a *cardholder* as part of the card product loyalty program. | | Bundle | A collection of benefit *instances* grouped by a theme, provider, promotion, etc. 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, e.g. "Books" or "Shopping". | | Child product | A product that cannot be booked to purchased on its own and instead is an add-on to another (*master*) product, or is included in it. | | Core benefit | See *fixed* benefit. | | Customer segment | An arbitrary category of *cardholders* formed by demographics, geographic locations, spending, or other metrics or parameters. For example, "London" for cardholders living in London or "Lifestyle" for cardholders who often purchase lifestyle products and services. | | Estimate | A temporary order request sent for the purpose of calculating the final price of an actual order. An estimate does not entail any charges on the *cardholder's* credit card. | | 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. | | Event | A digital or physical activity with a fixed date and time that a *cardholder* can attend. An *event* is a type of *product*. | | Fixed benefit | Same as *core* benefit. A *benefit* that is attached to the cardholder's card and can be neither activated (selected) nor deactivated using this API. It can, however, be viewed. | | Instance | A specific offering that may come in a package (*bundle*) with other offerings (instances). | | Inventory | The number of items of a particular *product* available for purchasing. | | Locale | A set of country-specific settings, such as language, currency, date and time format, etc. that customize user experience. | | Master product | A product that can be booked or purchased on its own, as opposed to *child* products. | | Partner | A card issuer that is granted the access to the Priceless Platform API and has the authority to provide its *cardholders* with *benefits*. | | Physical product | An item, a material thing that can be shipped to the *cardholder* . This is a type of *product*. | | Product | A physical item, event, offer, experience, or benefit that can be presented to a cardholder as part of the Priceless catalog. | | Personalization (of benefits) | Choosing from the range of available card *benefits* and opting out of unneeded benefits. | | 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 will have to use the existing/previously selected benefits or wait for the next window to make a new *selection*. | | 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 very similar to a session ID. | | Tiered benefit | A benefit that combines multiple *instances* within the same *bundle*. Normally only one tiered benefit can be selected for a card. | | Vendor | A person or company that published the product. This term has aliases: *celebrity* and *luminary*. Both are now deprecated. | ## 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/content/designcenter/library/asset-details.html?assetpath=logos/mc_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/tutorial/index.md).