D1 API summary

This section provides a summary of the APIs used in the Click to Pay service.

The APIs are essentially grouped into:

• Mandatory: must be implemented by the issuer for a proper integration in D1 and compliance with the schemes.
• Conditional: to be implemented according to the integration model chosen by the issuer.
• Optional: to be implemented according to the issuer business needs.

Required APIs

API	Inbound/Outbound	Description
Get authorization token	Issuer -> Thales D1	Get an OAuth 2.0 access token to call the D1 backend.
Create card or Register card	Issuer -> Thales D1	Create or register a card in the D1 backend.
Renew card and Replace card	Issuer -> Thales D1	Renew a card. Replace card.
Delete card	Issuer -> Thales D1	Delete a card from D1 backend. NOTE: this request will automatically trigger a Click to Pay opt-out card.
Register consumer	Issuer -> Thales D1	Register a consumer in D1.
Delete consumer	Issuer -> Thales D1	Delete a consumer in D1. NOTE: this request will automatically trigger a Click to Pay opt-out consumer.
Click to Pay enrol	Issuer -> Thales D1	To enrol card and consumer in Click to Pay directory of the scheme.
Click to Pay get consumer profiles	Issuer -> Thales D1	Retrieve a Click to Pay profile for a given consumer from the Click to Pay directory.
Click to Pay update card	Issuer -> Thales D1	Update a card in the Click to Pay directory of the scheme.
Click to Pay update consumer	Issuer -> Thales D1	Update the consumer details in the Click to Pay directory of the scheme.
Click to Pay opt-out card	Issuer -> Thales D1	Opt-out a card from the Click to Pay directory of the scheme.
Click to Pay opt-out consumer	Issuer -> Thales D1	Opt-out a consumer and his cards from the Click to Pay directory of the scheme.

Conditional APIs

API	Inbound/Outbound	Description
Suspend card and Resume card	Issuer -> Thales D1	Suspend a card. Resume card.
Update consumer information	Issuer -> Thales D1	It is conditional to the storage of the consumer information in D1. If the data is stored in D1, issuer must update it.
Get consumer information	Issuer <- Thales D1	It is conditional to the storage of the consumer information in D1. If the data is stored in D1, this API is not triggered. It is conditional to the auto enrolment feature in case not all the details are provided in the input. D1 tries to get the missing details from issuer backend.
Get authorization token	Issuer <- Thales D1	Get an OAuth 2.0 access token to call the issuer backend. It is mandatory if Thales D1 calls the issuer backend.
Notify consumer operations	Issuer <- Thales D1	If the issuer wants to be notified for consumer operations.
Notify card operations	Issuer <- Thales D1	If the issuer wants to be notified for card operations.

Optional APIs

API	Inbound/Outbound	Description
Get card list	Issuer -> Thales D1	If the issuer wants to retrieve the list of cards linked to the consumer.
Get card operation	Issuer -> Thales D1	If the issuer needs to retrieve a specific card operation ID.
Get all card operation	Issuer -> Thales D1	If the issuer needs to retrieve all the operations for a given card.
Get consumer operation	Issuer -> Thales D1	If the issuer needs to retrieve a specific consumer operation ID.
Get all consumer operations	Issuer -> Thales D1	If the issuer needs to retrieve all the operations for a given consumer.