SDK API requirements

Overview

Most NFC Wallet SDK APIs require an Android Context.

Some APIs also require the NFC Wallet SDK initialization to be complete.

Use this page to understand what happens if you call an API too early.

Prerequisite definitions

• SDK configuration: the SDK has an Android Context.

  • This is available after you call SDKInitializer.INSTANCE.configure(...).
  • This is also available after you start SDKInitializer.INSTANCE.initialize(...).
• SDK initialization: SDKInitializer.INSTANCE.initialize(...) completed successfully.

See Initialize the NFC Wallet SDK.

Some APIs can throw runtime exceptions (for example: NullPointerException) if prerequisites are missing.

DigitalizedCardManager

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
getAllCards	Required	Not required	Returns DigitalizedCardErrorCodes.NULL_CONTEXT with an empty String[].
getDefault	Required	Not required	Returns DigitalizedCardErrorCodes.NULL_CONTEXT with an empty String.
getDigitalizedCardId	Required	Not required	Returns null.
getTokenizedCardId	Required	Not required	Returns null.
unsetDefaultCard	Required	Required	Returns DigitalizedCardErrorCodes.SDK_NOT_INITIALIZED and does not perform the operation.
getTokenSyncSchedule	Required	Required	Throws NullPointerException.
isTokenSyncAllowed	Required	Required	Throws NullPointerException.
invokeTokenSync	Required	Required (Mobile Gateway initialized)	Throws IllegalStateException if CPS is not initialized. Returns TokenSyncErrorCode.TOKEN_SYNC_ERROR_SDK_NOT_INITIALIZED if Mobile Gateway is not initialized.

DigitalizedCard

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
getCardDetails	Required	Not required	Returns DigitalizedCardErrorCodes.NULL_CONTEXT with null.
getCardState	Required	Not required	Returns DigitalizedCardErrorCodes.NULL_CONTEXT with null.
isDefault	Required	Not required	Returns DigitalizedCardErrorCodes.NULL_CONTEXT with false.
setDefault	Required	Required	Returns DigitalizedCardErrorCodes.SDK_NOT_INITIALIZED and does not perform the operation.
isMultiAids	Required	Not required	Returns false.
hasAuxiliaryScheme	Required	Not required	Returns false.
getAllAids	Required	Not required	Returns an empty ArrayList.
updateAidList	Required	Not required	Does not perform the operation.

PaymentBusinessService

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
activate	Required	Required	Returns the errorCode: PaymentServiceErrorCode.PAYMENT_NOT_ALLOWED_SDK_NOT_INITIALIZED.
startAuthentication	Required	Required	Returns the errorCode: PaymentServiceErrorCode.PAYMENT_NOT_ALLOWED_SDK_NOT_INITIALIZED.
getAuthenticationFlowPriorToPayment	Required	Required	Returns the errorCode: PaymentServiceErrorCode.PAYMENT_NOT_ALLOWED_SDK_NOT_INITIALIZED.
generateQRCodePaymentData	Required	Required	Returns the errorCode: PaymentServiceErrorCode.PAYMENT_NOT_ALLOWED_SDK_NOT_INITIALIZED.
generateApplicationCryptogram	Required	Required	Returns the errorCode: PaymentServiceErrorCode.PAYMENT_NOT_ALLOWED_SDK_NOT_INITIALIZED.
deactivate	Required	Required	Does not perform the operation.

EnrollingBusinessService

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
isEnrolled	Required	Not required	Returns EnrollmentStatus.ENROLLMENT_NEEDED.
continueEnrollment	Required	Required	Returns ProvisioningServiceErrorCodes.NULL_CONTEXT if SDK configuration is missing. Returns ProvisioningServiceErrorCodes.SDK_NOT_INITIALIZED if initialization is missing.
enroll	Required	Required	Returns ProvisioningServiceErrorCodes.NULL_CONTEXT if SDK configuration is missing. Returns ProvisioningServiceErrorCodes.SDK_NOT_INITIALIZED if initialization is missing.

ProvisioningBusinessService

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
processIncomingMessage	Required	Required	Returns the errorCode: ProvisioningServiceErrorCodes.SDK_NOT_INITIALIZED.
sendActivationCode	Required	Not required	Returns the errorCode: ProvisioningServiceErrorCodes.NULL_CONTEXT.
sendRequestForReplenishment	Required	Not required	Returns the errorCode: ProvisioningServiceErrorCodes.NULL_CONTEXT.
updatePushToken	Required	Not required	Returns the errorCode: ProvisioningServiceErrorCodes.NULL_CONTEXT.
getAccessToken	Required	Not required	Returns the errorCode: ProvisioningServiceErrorCodes.NULL_CONTEXT.
sendRequestForODACertificateRenewal	Required	Not required	Returns the errorCode: ProvisioningServiceErrorCodes.NULL_CONTEXT.

WalletSecureEnrollmentService

API	Requires SDK configuration	Requires SDK initialization	If prerequisites are missing
getState	Required	Not required	Returns null.
startWalletSecureEnrollment	Required	Required (Mobile Gateway initialized)	Returns WalletSecureEnrollmentErrorCodes.WSE_CPS_COMPONENT_NOT_INITIALIZED or WalletSecureEnrollmentErrorCodes.WSE_MG_COMPONENT_NOT_INITIALIZED.