# API Reference
source: https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/index.md

Prior to calling Mastercard APIs, you will need the following keys:

* To authenticate your API calls, obtain and [create a Signing Key](https://developer.mastercard.com/issuer-enrollment/tutorial/key-management-click2pay/step1/index.md) for the [Sandbox Environment](https://developer.mastercard.com/issuer-enrollment/tutorial/issuer-onboarding-click2pay/step2/index.md). To enable Production, upload the Signing Key to the [Production environment](https://developer.mastercard.com/issuer-enrollment/tutorial/issuer-onboarding-click2pay/step6/index.md).
* Obtain the Consumer Key for Mastercard API server to authenticate you when you access the APIs. Refer to [Key Management](https://developer.mastercard.com/issuer-enrollment/tutorial/key-management-click2pay/index.md).

Note: Ensure to test the Enroll API in a Sandbox environment before requesting access to Production.

For more details about this process, refer to:

* [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 Service                                                   |                                                                                                                          Description                                                                                                                           |
|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [getEligibleTokenRequestors](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/) | 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.                                   |
| [getAsset](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/)                   | Returns the logo of a token requestor, in PNG and SVG format.                                                                                                                                                                                                  |
| [pushMultipleAccounts](https://developer.mastercard.com/mdes-token-connect/documentation/api-reference/)       | 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. |

### Enroll API-Synchronous {#enroll-api-synchronous}

Click to Pay push provisioning provides you with the following Enroll API endpoints:

|                                                                    Enroll API-Synchronous                                                                     |                                               Description                                               |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------|
| [Enroll consumer via push provisioning](https://developer.mastercard.com/issuer-enrollment/documentation/api-reference/apis/index.md#enroll-api-synchronous). | To provision and enroll consumers into Click to Pay through enrollment steps on the Issuer website/app. |

<br />

### Enroll API-Asynchronous {#enroll-api-asynchronous}

|                                                                           Enroll API-Asynchronous                                                                            |                     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). | To auto-enable multiple consumers into Click to Pay. |

<br />

### 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). | To check the status of an auto-enabled batch using the batch ID received in response to the above method. |

<br />

### Lifecycle Management APIs {#lifecycle-management-apis}

|                                                             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.                   |

### Authentication APIs {#authentication-apis}

|                                           Mastercard Payment Passkey Creation APIs                                            |                                                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).          |