Package com.thalesgroup.gemalto.d1.clicktopay

Interface ClickToPayService

public interface ClickToPayService

Main interface for Click to Pay operations.

Since:

4.3.0

Method Summary

Modifier and Type	Method	Description
void	enrol(String cardID, ConsumerInfo consumerInfo, String name, BillingAddress billingAddress, D1Task.Callback<Status> callback)	Enrolls the card to the Click to Pay service.
void	getProfiles(D1Task.Callback<ProfileResult> callback)	Retrieves the list of profiles which contains the consumer details.
void	optOutCard(String cardID, D1Task.Callback<Status> callback)	Opts the card out of the Click to Pay service.
void	optOutConsumer(D1Task.Callback<Status> callback)	Opts the consumer out of the Click to Pay service.
void	updateCard(String cardID, String name, BillingAddress billingAddress, D1Task.Callback<Status> callback)	Updates the card information in the Click to Pay service.
void	updateConsumer(ConsumerInfo consumerInfo, BillingAddress billingAddress, D1Task.Callback<Status> callback)	Updates the consumer information in the Click to Pay service.

Method Details

enrol

void enrol(@NonNull
 String cardID,
 @NonNull
 ConsumerInfo consumerInfo,
 @Nullable
 String name,
 @Nullable
 BillingAddress billingAddress,
 @NonNull
 D1Task.Callback<Status> callback)

Enrolls the card to the Click to Pay service. The enrollment status in the issuer application will be updated via a push notification. Before calling this Click to Pay API, the integrator should display the default value of `consumerInfo` and `billingAddress` to collect the inputs of `consumerInfo` given by the end user.

Parameters:

cardID - The card identifier.

consumerInfo - ConsumerInfo The `consumerInfo` object is initialised using the first name,middle name, last name, language, phone number, country code and email entered by the end user.

name - The cardholder name as shown on the card. This is applicable only to Visa.

billingAddress - The billing address that is associated to the card enroled to Click to Pay. This is mandatory for Visa.

callback - The callback for the result. When it is successful, the returned argument of the D1Task.Callback.onSuccess(Object) is Status.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_CARD_NOT_FOUND
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_INVALID_ARGUMENT
• D1Exception.ErrorCode.ERROR_NOT_ACTIVE
• D1Exception.ErrorCode.ERROR_CARD_OPERATION_NOT_ALLOWED
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_FIRST_NAME
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_LAST_NAME
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_LANGUAGE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_PHONE_NUMBER_COUNTRY_CODE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_PHONE_NUMBER
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_BILLING_ADDRESS_COUNTRY_CODE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_SCHEME_AMBIGUOUS_PROFILE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_SCHEME_RESOURCE_EXISTS
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_SCHEME_CARD_INELIGIBLE

Since:

4.3.0

optOutCard

void optOutCard(@NonNull
 String cardID,
 @NonNull
 D1Task.Callback<Status> callback)

Opts the card out of the Click to Pay service. The enrollment status in the issuer application will be updated via a push notification.

Parameters:

cardID - The card identifier.

callback - The callback for the result. When it is successful, the returned argument of the D1Task.Callback.onSuccess(Object) is Status.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_CARD_NOT_FOUND
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_CARD_OPERATION_NOT_ALLOWED

Since:

4.3.0

getProfiles

void getProfiles(@NonNull
 D1Task.Callback<ProfileResult> callback)

Retrieves the list of profiles which contains the consumer details. Each profile includes the list of associated cards enrolled in the Click to Pay service for a specific consumer.

For end users who have not enrolled their cards in the Click to Pay service, an empty list will be returned by the API.

Parameters:

callback - The callback for the result. When it is successful or partial error, the returned argument of the D1Task.Callback.onSuccess(Object) is ProfileResult.

• Success: ProfileResult is returned with an array of Profile objects and an empty ProfileResult.errorMessage.
• Partial error: When two or more cards are enrolled in both Scheme.VISA and Scheme.MASTERCARD schemes (where one fails, the other succeeds), ProfileResult is returned with the Profile objects from successful enrollment scheme, together with ProfileResult.errorMessage from failed enrollment scheme.

Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_INVALID_ARGUMENT
• D1Exception.ErrorCode.ERROR_CARD_NOT_MANAGED_BY_D1

Since:

4.3.0

updateCard

void updateCard(@NonNull
 String cardID,
 @Nullable
 String name,
 @NonNull
 BillingAddress billingAddress,
 @NonNull
 D1Task.Callback<Status> callback)

Updates the card information in the Click to Pay service. The integrator will be notified of the final update status via a push notification.

Parameters:

cardID - The card identifier.

name - The cardholder name as shown on the card. This is applicable only to Visa.

billingAddress - The billing address that is associated to the card enrolled to Click to Pay.

callback - The callback for the result. When it is successful, the returned argument of the D1Task.Callback.onSuccess(Object) is Status.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_CARD_NOT_FOUND
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_INVALID_ARGUMENT
• D1Exception.ErrorCode.ERROR_CARD_OPERATION_NOT_ALLOWED
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_BILLING_ADDRESS_COUNTRY_CODE

Since:

4.3.0

updateConsumer

void updateConsumer(@NonNull
 ConsumerInfo consumerInfo,
 @Nullable
 BillingAddress billingAddress,
 @NonNull
 D1Task.Callback<Status> callback)

Updates the consumer information in the Click to Pay service. The integrator will be notified of the final update status via a push notification.

Parameters:

consumerInfo - ConsumerInfo The `consumerInfo` object is initialized using the first name,middle name, last name, language, phone number, country code and email entered by the end user.

billingAddress - The billing address that is associated to the cards enroled in the Click to Pay service. This is mandatory for Visa.

callback - The callback for the result. When it is successful, the returned argument of the D1Task.Callback.onSuccess(Object) is Status.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_CARD_NOT_FOUND
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_INVALID_ARGUMENT
• D1Exception.ErrorCode.ERROR_CARD_OPERATION_NOT_ALLOWED
• D1Exception.ErrorCode.ERROR_CARD_NOT_MANAGED_BY_D1
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_FIRST_NAME
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_LAST_NAME
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_LANGUAGE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_PHONE_NUMBER_COUNTRY_CODE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_PHONE_NUMBER
• D1Exception.ErrorCode.ERROR_CLICKTOPAY_INVALID_BILLING_ADDRESS_COUNTRY_CODE

Since:

4.3.0

optOutConsumer

void optOutConsumer(@NonNull
 D1Task.Callback<Status> callback)

Opts the consumer out of the Click to Pay service. The enrollment status in the issuer application will be updated via a push notification.

Parameters:

callback - The callback for the result. When it is successful, the returned argument of the D1Task.Callback.onSuccess(Object) is Status.
Possible errors:

• D1Exception.ErrorCode.ERROR_NOT_LOGGED_IN
• D1Exception.ErrorCode.ERROR_NOT_AUTHORIZED
• D1Exception.ErrorCode.ERROR_DEVICE_ENVIRONMENT_UNSAFE
• D1Exception.ErrorCode.ERROR_CLICKTOPAY
• D1Exception.ErrorCode.ERROR_CARD_NOT_MANAGED_BY_D1

Since:

4.3.0