# Onboarding and Registration in Production source: https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/onboarding-production-tutorial/index.md This tutorial guides you through program enrolment, directory creation, project creation, and the steps required to go live. ## Key Terms {#key-terms} To help you use the Mastercard Checkout Solutions onboarding application effectively, the following table lists some common terms used in the application and their purpose: | Term | Description | |--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Program** | Available Remote Commerce Programs - Secure Card on File, Guest Checkout Tokenization, and Click to Pay. The list of available programs is displayed in the Program Management tab. | | **Enroll Program** | Program enrollment in Production requires approval from Mastercard admin. Once you finish testing in the Sandbox environment for a program, you can enroll your program into the Production environment. | | **Create Project** | This step allows you to create a project in Production environment. Ensure that you have completed the necessary certifications and have received required approvals before you can create a project in Production. Your [Mastercard representative](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/support/index.md#get-help) will guide you in this process. | | **Directory** | Directory acts as a logical container for consumer credentials and program configurations. Creating one lets you manage credential sharing, governance, and program enablement across your Mastercard Checkout Solutions implementation. | ## 1. Order the Application from the Store {#1-order-the-application-from-the-store} 1. Log in to [Mastercard Connect](https://www.mastercardconnect.com), go to the **Store** tab and search for the application **"Mastercard Checkout Solutions"**. 2. Locate the application and click the **Request Access** button. You will be presented with an Order Confirmation. You should then notify your company's Mastercard Connect Security Administrator and request that they approve access. 3. From the Order Confirmation, you can either print the order (for your records) or click **Track status** to view its progress. The application will appear on the **My Items** tab with an **Access pending** status label. 4. The Mastercard Checkout Solutions onboarding application will look like the following where a **Company ID** (CID) identifies a customer's unique legal identity. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_programenrollment_prod1.png "Remote Commerce Application") ## 2. Add Email Address to Receive Notifications {#2-add-email-address-to-receive-notifications} Use the **Program notifications** button to sign up to receive email notifications about all company-level activities. You must provide an email address when you enroll in a program for the first time as all the updates to program settings (such as adding/updating a merchant name) and program enrollment are sent via email. Adding an email address is a mandatory requirement. On the **Program enrollment** tab, click the **Manage notifications** button. You can add additional email addresses, or edit the existing ones at any time. ![Program notifications](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_manage_notification_prod.png "Manage notifications button") ## 3. Enrollment as a Technical Integrator from Settings {#3-enrollment-as-a-technical-integrator-from-settings} Note: The information/instructions in this section is only applicable for Technical Integrators enrolling for 'On Behalf Of' programs. Mastercard recommends Technical Integrators take the following steps: 1. [Enroll as a Technical Integrator](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/onboarding-production-tutorial/index.md#1-enroll-as-a-technical-integrator) 2. [Register clients](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/onboarding-production-tutorial/index.md#2-register-clients)
### Step 1: Enroll as a Technical Integrator {#step-1-enroll-as-a-technical-integrator} * On the **Program enrollment** tab, select the **Settings** icon. ![Click Settings](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_settings_tab_prod.png "Settings Tab") * Proceed with the enrollment steps on the Settings page. The enrollment request takes 2-3 business days to get approval in the Production environment. ![Technical Integrator](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_settings_tab_request_prod.png "Technical Integrator") * Once the Technical Integrator enrollment is approved, you will be able to see the **Clients** tab to add and manage your clients. Approval of the enrollment may take 2-3 business days in the Production environment. ![See Clients](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_register_client_prod.png "See Clients") ### Step 2: Register Clients {#step-2-register-clients} The **Clients** tab enables the Technical Integrator to add and manage client's company names, and the associated company IDs (assigned by Mastercard) by using the **Register Client** button. Client registration takes 2-3 business days to get approval in the Production environment. ![Client Page Options](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_client_registered_prod.png "Client Page") Note: * Currently, you can add upto 20 clients in the list. To increase this number, connect with your [Mastercard representative](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/support/index.md#get-help). * It is recommended to use the legal name of your clients to expedite the internal approval process. * For Technical Integrators it is recommended to add client names and company IDs to enroll for 'On Behalf of Commerce Platform Model', 'On Behalf of Shared Merchant Model', and 'On Behalf of Merchant Model'. ## 4. Program Enrollment and Directory Creation {#4-program-enrollment-and-directory-creation} After completing Sandbox testing for your project, you can enroll in one or more programs, create a directory, or do both, depending on your project requirements. These actions serve different purposes and can be completed independently or together. * First, complete the certification process with your [Mastercard representative](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/support/index.md#get-help). * Mastercard will review your request and determine your eligibility. * Please ensure that you have ordered the Production version of the Mastercard Checkout Solutions onboarding application from the MCC store. You can order and get access to the application irrespective of your certification process. Onboarding application supports multiple types of enrollment, depending on the use case or program that you're enrolling into. Each program has different requirements, some require customer input, and some don't. Note: Program enrollment and directory creation are separate actions in the Mastercard Checkout Solutions onboarding application. Depending on your project requirements, you can complete either action independently or complete both. Enroll in the required programs to enable program configurations in Production. Create a directory if your project requires a logical container to manage consumer credentials, program associations, and configuration settings. Refer to Sections 4.1 and 4.2 for the respective instructions. ### 4.1 Enroll a Program {#41-enroll-a-program} 1. Access the Mastercard Checkout Solutions onboarding application from the **My Items** tab on Mastercard Connect. 2. The **Program enrollment** tab displays the programs available for your enrollment. 3. For the program you are enrolling in, click **Enroll Program** to initiate testing the program integration on the Program enrollment tab. For example, if you want to integrate to "Merchant Direct Model", click **Enroll Program** under the **Program enrollment** label in the **Merchant Direct Model** program tile. 4. Mastercard approves your program enrollment requests for the Production environment. Until approved, the status remains **Pending** . Once the program enrollment status changes to **Enrolled**, you can create a project for implementing these programs in your integration. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_programenrollment_prod1.png "Remote Commerce Application") #### Program Enrollment Status {#program-enrollment-status} | Program Enrollment Status | Description | |---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Pending | There are updates/approval pending for a program. You cannot add this program to a project until the update is completed. Even if the program was previously added to the project, it would cease to appear in the project details view unless the updates are accepted. | | Enrolled | Program enrolled successfully. You can add this program in a project but not edit project name. | | Rejected | Mastercard did not approve the request. The **Note** contains the reason for rejection. You must work on the resolution and click **Resubmit** to initiate the program enrollment request. | | Canceled | Either the Integrator or Mastercard has cancelled the enrollment request. Click **Enroll Program** to initiate the program enrollment request again. You can also edit project name during resubmission. | ### 4.2 Create a Directory {#42-create-a-directory} A directory helps you manage consumer credentials, program associations, and configuration settings within Mastercard Checkout Solutions. Directories can be associated with Click to Pay program and used across projects during onboarding. 1. On the **Directory Management** tab, select **Create Directory** . ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/create_directory_prod.png "Select create directory from Directory management tab") 2. Enter the **Directory name** , **Description** , and **Support email addresses** . You can optionally configure directory rules under Rules and configurations to customize the directory's behavior. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_directory-creation-step-1.png "Fill details for step 1") 3. Select the programs to associate with the directory: * **Click to Pay (C2P)** can be enabled if required. 4. Configure your directory details and program configurations. 5. Select **Create directory** to submit the request. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_directory-creation-step-2.png "Select programs for directory") 6. Your directory request will be sent to the administrator for review. You'll receive updates within 5 business days. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_directory_created_prod.png "Select programs for directory") 7. Track the request status on the **Directory Management** page. Once approved, your directory can be associated with a project and used for credential management and program enablement. ![Mastercard Checkout Solutions Onboarding Application](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_directory_list_prod.png "Directory approved") ### Directory Creation Status {#directory-creation-status} | Directory Creation Status | Description | |---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Pending | Mastercard is yet to approve the directory. You can add it to a project once it's approved. You can cancel this directory until its status is 'Pending'. | | Approved | Directory approved successfully, you can add it to a project. | | Rejected | Mastercard did not approve the request. The **Note** contains the reason for rejection. You must work on the resolution and select **Resubmit** to initiate the request. | | Canceled | You have canceled the enrollment request. Select **Resubmit** to re-initiate the request. You can also edit the directory name during resubmission. | ## 5. Create a Project in Production {#5-create-a-project-in-production} Once you have a test site working properly in Sandbox, you need to complete a certification process and receive required approvals from Mastercard. This is a required step to get approval on your project in Production. Your [Mastercard representative](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/support/index.md#get-help) will guide you through this process. Warning: * The Production project will have no data from any of the Sandbox projects. A Production project will have a separate SRC Client ID and you will need to add/create new keys and upload your DPA data. * The **Create project** button on the **Projects** tab is visible only after enrolling for a specific program or creating a directory. * By default, you can create one project in Production. Reach out to your [Mastercard representative](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/support/index.md#get-help) if you would like to increase this number. On the **Projects** tab, click **Create project**, fill out the form, and read the necessary requirements to create your first project. Tip: SRC Client ID is the identifier for the connecting client. ### 5.1 Provide Project Details {#51-provide-project-details} ![Create a Project](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_create_project_step_1.png "Fill Project Details") To create a project, provide the following information: * **Project Name** --- the name of the project. * **Description** --- a brief description of your project. * **Notification Settings** --- Support email addresses will receive notifications related to their Mastercard Checkout Solutions onboarding application project. These email addresses are used for support or troubleshooting. You can add up to 4 email addresses by clicking the **Add another email** button. * **Requirements** --- You should be eligible to accept payment credentials in the payload response returned by Mastercard. Select the check box and click **Continue** to create a project and move to Program selection. ### 5.2 Choose Programs and Directories for your Project {#52-choose-programs-and-directories-for-your-project} ![Choose a Program for a Project](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/select-program-for-project.png "Choose a Program") * **Choose enrolled programs** --- select the program(s) you want to include in this project. The enrollment form varies depending on the program type you request: There is no enrollment form for this program. There is no enrollment form for this program. For Commerce Platforms who want to become an integrator. You can specify only one Commerce Platform name. For merchants who want to integrate directly with Mastercard for tokenization programs, e.g. large streaming merchant, can have between 1 and 20 program names. There is no enrollment form for this program. It is for service providers who want to provide merchant tokenization programs to their merchants. The program names for this model are generated using the [Submit DPA Data API](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/api-reference/apis/index.md#registration) endpoint and do not require user input during enrollment. There is no enrollment form for this program. It is for service providers who want to provide tokenization programs to their sub-merchants. Payment Facilitator (Service Provider) uses a `serviceId` to register a group of sub-merchants. A `serviceId` is shared between sub-merchants. Tip: Mastercard provides upto five `serviceId` to Payment Facilitator. The Payment Facilitator should register their sub-merchants as `srcDpaId` within each `serviceId` that they will use. Mastercard recommends segmenting sub-merchants into `serviceId` based on Merchant Category Code (MCC). The program names for this model are generated using the [Submit DPA Data API](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/api-reference/apis/index.md#registration) endpoint. Up to five program names can be generated to be used amongst the sub-merchants. For Technical Integrators who want to provide technical integration service for their commerce platforms. In step 2 of project creation (refer to the above image), provide the consumer-facing name of the commerce platform, and assign the client name with the company ID combination. ![OBO Project](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/edo_obocp_prod.png "OBO Project") * The program name is mapped with the merchant's consumer-facing name, or the entity that stores the cardholder's credentials on file. It is recommended to choose an accurate program name that Issuer uses to identify the merchant during tokenization and transaction authorization. Depending upon the model you are enrolling in, you can edit or remove one or more Program Names or Commerce Platform Names for the selected program type. * Select the directory you want to include in this project. ![Choose a directory for a Project](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe-select-directory-project-creation-step.png "Choose directory") * Click **Create project** to complete the step. * Each project is visible as a separate tile on the **Projects** tab. ![Projects Tab](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_project_list_prod.png "Projects tab") ### Understanding a Project Tile {#understanding-a-project-tile} On the **Projects** tab, a tile isvisible for each project. The following callouts help you understand the information contained within a project tile. ![Understand Project Tile](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/mcc_project_tile_dpe.png "Project tile") 1. Denotes a program included in the project. 2. Denotes a program enrolled in Production but not included in this project. 3. A red dot indicates that Mastercard could not generate a `serviceid` for a program. An amber dot indicates that a `serviceid` generation for a program is in progress. 4. Denotes a directory included in the project. 5. Denotes a directory enrolled in Production but not included in this project. 6. Allows you to edit the email addresses and other details related to the project (except Project name). 7. Indicates the project status. Possible values are: **Approved** , **Pending** , **Canceled** and **Rejected** . To learn more about what each status indicates, go to [Program Enrollment Status](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/onboarding-production-tutorial/index.md). ## 6. View the Project Dashboard {#6-view-the-project-dashboard} On the **Projects** tab, click the Project Name to access the Dashboard. ![Project Dashboard](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/edo_view_project_dashboard.png "Project Dashboard") Alert: Make a note of your SRC Client ID (this may also be referred to as srcClientId, SRCI ID \& srcInitiatorId). You will need this to call our APIs. ## 7. Manage Keys {#7-manage-keys} Create new API Signing and Payload Encryption Keys; you will need these to call the APIs in your Production project. Note: * If you've enrolled in more than one program, the keys in your Production project can be used to call the APIs of all the selected programs. For example, if your Production project has Click to Pay, Guest Checkout Tokenization, and Secure Card on File - On Behalf Of Merchant Model, the project keys will be valid for calling the APIs of all selected programs. * If you have more than one projects, you need to create distinct, separate keys for each project. The keys are **not** shared between projects. For more information, refer to [Key Management](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/tutorials-and-guides/key-management-tutorial/index.md). ## 8. Manage DPAs {#8-manage-dpas} Digital Payment Applications (DPAs) could be a merchant e-commerce website or mobile application with unique registrations for each digital channel. To initiate payments for Click to Pay, Guest Checkout Tokenization or Secure Card on file programs, you must register your DPAs. | Program | DPA Registration | |--------------------------------|------------------| | Click to Pay | Mandatory | | Guest Checkout Tokenization | Mandatory | | Commerce Platform Direct | Optional | | On Behalf of Commerce Platform | Optional | | Merchants Direct | Mandatory | | On Behalf of Merchants | Mandatory | | On Behalf of Shared Merchants | Mandatory | #£ Program Information On the **DPA management** page, you will see all the available program types for that project. The program information for each of the active program types is listed in tabular form. When the program information shows "pending" approval, there is a pending tag beside the program information section. ### DPA Registration API {#dpa-registration-api} When you have finished testing, the sample DPA data should be replaced. You can create new DPA data by calling the [DPA Registration API](https://developer.mastercard.com/mastercard-checkout-solutions/documentation/api-reference/apis/index.md#registration). The following table outlines the required fields for UPDATE function for each program type: | Program Type | Mandatory fields for UPDATE function | |--------------------------------------|-------------------------------------------------------| | Click to Pay | * `dpaName` * `srcDpaId` * `dpaAddress.countrycode` | | Merchant Direct Model | * `serviceId` * `srcDpaId` * `dpaName` | | Commerce Platform Direct Model | * `serviceId` * `srcDpaId` * `dpaName` | | On Behalf of Merchant Model | * `serviceId` * `programName` | | On Behalf of Shared Merchant Model | * `serviceId` * `programName` | | On Behalf of Commerce Platform Model | * `serviceId` * `srcDpaId` * `dpaName` * `customerId` | | Guest Checkout | * `dpaName` * `srcDpaId` | Note: Under 'On Behalf of Commerce Platform Model', 'On Behalf of Merchant Model', and 'On Behalf of Shared Merchant Model', a Technical Integrator can execute DPA Registration APIs only for their approved clients. ## 9. Edit Project Details {#9-edit-project-details} Initially, you provide these details when you created the project. To make changes, use the **Edit project** button on the **Project details** tab. ![Edit Project](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/dpe_project_detail.png "Edit Project Details") Note: * You can also use **Edit project** to associate another available program type to an existing project. * You can edit the project details except for your Production project name. ## 10. Enable TAF/TAS {#10-enable-taftas} Use this option to enable payment authentication methods supported by TAF/TAS, such as 3DS, Passkeys, and other secure mechanisms. ### Steps to enable TAF/TAS {#steps-to-enable-taftas} 1. From the **Projects** tab, select the project for which you want to enable the TAF/TAS feature. 2. Select **Settings** option. 3. Under **Enable TAF/TAS** , select **Request enrollment**. All Payment Authentication requests require admin approval before they become active. This ensures Mastercard can control which customers are enabled for Payment Authentication. The following table describes the possible approval statuses for a TAF/TAS enrollment request and what each status means for feature availability. | Approval status | Description | Example | |------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Request Enrollment** | Submit a request to enable the TAF/TAS feature. The request is sent for review and does not take effect until it is approved. | ![Request enrollment](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/edo_request_enrollment.png "Request enrollment") | | **Pending** | The request is under review. Payment Authentication is not available until the request is approved. | ![Pending](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/edo_pending_status.png "Pending") | | **Rejected** | The request has been declined, and Payment Authentication is not enabled. After addressing the reason for rejection, select **Resubmit** to submit a new request. | ![Rejected](https://static.developer.mastercard.com/content/mastercard-checkout-solutions/documentation/images/edo_rejected_status.png "Rejected") | ## 11. Test Integration and Go Live {#11-test-integration-and-go-live} Once you've created the keys and registered the DPAs within your project, you can go live with your implementation.