# API Reference source: https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/index.md Before calling Mastercard APIs, obtain the following keys: * **Signing Key** : Create a [Signing Key](https://developer.mastercard.com/issuer-enrollment/documentation/tutorials-and-guides/key-management-click2pay-tutorial/index.md) for the [Sandbox Environment](https://developer.mastercard.com/issuer-enrollment/documentation/tutorials-and-guides/issuer-onboarding-click2pay-tutorial/index.md), then upload it to the [Production environment](https://developer.mastercard.com/issuer-enrollment/documentation/tutorials-and-guides/issuer-onboarding-click2pay-production-tutorial/index.md) to enable Production access. * **Consumer Key** : Obtain the Consumer Key that Mastercard uses to authenticate your API access. For more information, see [Key Management](https://developer.mastercard.com/issuer-enrollment/documentation/tutorials-and-guides/key-management-click2pay-tutorial/index.md). Note: Test the enrollment APIs in the Sandbox environment before requesting access to Production. For more details about this process, see: * [API Authentication](https://developer.mastercard.com/issuer-enrollment/documentation/api-basics/index.md#authentication) * [Gateway Error Codes](https://developer.mastercard.com/issuer-enrollment/documentation/code-and-formats/index.md) ## Available APIs {#available-apis} ### MDES Token Connect API {#mdes-token-connect-api} MDES Token Connect API provides the following API services to issuers: | API | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Get eligible token requestors](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/#tag/Get-Eligible-Token-Requestors) | Returns the list of token requestors that are enabled for one or more account ranges of the issuer. For each returned token requestor, metadata (such as name, image asset ID, Token Connect capabilities) is also supplied. | | [Get assets](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/#tag/Get-Assets) | Returns the logo of a token requestor, in PNG and SVG format. | | [Push multiple accounts](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/#tag/Push-Multiple-Accounts) | Triggers issuer-initiated digitization of a card or financial account to a target token requestor. The issuer obtains a receipt for their request, as well as the token requestor URI(s) where they should redirect the consumer to complete the provisioning. | ### Batch enrollment API (Asynchronous) {#batch-enrollment-api-asynchronous} | API | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------| | [Auto-enable single or multiple consumers in a batch](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#batchCredentialsInDirectory) | Auto-enable multiple consumers into an issuer credential directory and Click to Pay. | | [Check batch status](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#getDirectoryBatchStatus) | Check the status of an auto-enabled batch using the batch ID received in response to the above method. | ### Single enrollment API (Synchronous) {#single-enrollment-api-synchronous} | API | Description | |-------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------| | [Auto-enable single profile and credential](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#createDigitalCredential) | Auto-enable a single profile and credential into an issuer credential directory. | ### Lifecycle management APIs {#lifecycle-management-apis} | API | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| | [Get consumer credential](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#getCredentialByExternalCredentialId) | Retrieve and review the latest credential information. | | [Update consumer credential](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#updateCredentialsByExternalCredentialId) | Update credential billing information. | | [Delete consumer credential](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#deleteCredentialByExternalCredentialId) | Delete a credential from the directory if consumer opts out of a specific credential. | | [Get consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#getProfileByExternalConsumerId) | Retrieve the consumer profile to review details and required information. | | [Update consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#updateProfileByExternalConsumerId) | Update the consumer profile with any necessary information or latest details. | | [Delete consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#deleteProfileByExternalConsumerId) | Delete consumer profile and remove consumer from directory if they opt out of Click to Pay. | ### Authentication APIs {#authentication-apis} | API | Description | |------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| | [Sessions](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#authentication-apis) | Initiates a session for a cardholder, typically used to start a secure transaction or authentication flow. | | [Bind](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#authentication-apis) | To facilitate binding a new/existing Authenticator Instance to the supplied account reference(s). | ## Legacy Issuer Enrollment APIs {#legacy-issuer-enrollment-apis} Warning: As of September 2026, the Issuer Enrollment for Click to Pay APIs have been replaced with Mastercard's Credential Directory APIs that support multiple programs. For new integrations, use the Mastercard Credential Directory-supported APIs listed above. ### Enroll API - Synchronous {#enroll-api---synchronous} | API | Description | |--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------| | [Enroll consumer via push provisioning](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#enroll-api-synchronous) | Provision and enroll consumers into Click to Pay through enrollment steps on the issuer website or app. | ### Enroll API - Asynchonous {#enroll-api---asynchonous} | API | Description | |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------| | [Auto-Enable single or multiple consumers in a batch](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#enroll-api-asynchronous) | Auto-enable multiple consumers into Click to Pay. | ### Batch Status API {#batch-status-api} | Batch Status API | Description | |--------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| | [Check Batch Status](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#enroll-api-asynchronous) | Check the status of an auto-enabled batch using the batch ID received in response to the Batch Enroll method. | ### Lifecycle management APIs {#lifecycle-management-apis-1} | Lifecycle Management APIs | Description | |---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| | [Get consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Get the consumer profile to review details and required information. | | [Update consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Update the consumer profile with any necessary information or latest details. | | [Delete consumer profile](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Delete consumer profile and remove consumer from directory if they opt out of Click to Pay. | | [Get consumer card](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Retrieve and review the latest card information. | | [Update consumer card](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Update card information with latest details via the ABU process. | | [Delete consumer card](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#lifecycle-management-apis) | Delete a card from the directory if consumer opts out of a specific card. |