Samsung Pay | Samsung Developer

Overview Package Class Tree Help

All Classes and Interfaces|All Packages|Constant Field Values

A

activateSamsungPay() - Method in class com.samsung.android.sdk.samsungpay.v2.SamsungPay: API to bring the Samsung Pay app to a state in which cards can be added.
Samsung Pay might be either in stub only state or Samsung Account is not signed in state.
Partner app checks the Samsung Pay status with SamsungPay.getSamsungPayStatus(StatusListener) API.

If the status is #SPAY_NOT_READY and #EXTRA_ERROR_REASON is #ERROR_SPAY_SETUP_NOT_COMPLETED,
partner app can call this API to launch Samsung Pay and user can sign in to the app.
activateSamsungPay() - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to bring the Samsung Pay on watch app to a state in which cards can be added.
Samsung Pay on watch might be Samsung Account is not signed in state.
Partner app checks the Samsung Pay on watch status with getSamsungPayStatus(StatusListener) API.

If the status is #SPAY_NOT_READY and #EXTRA_ERROR_REASON is #ERROR_SPAY_SETUP_NOT_COMPLETED,
partner app can call this API to launch Samsung Pay on watch and user can sign in to the app.
ACTIVE - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is fully registered on Samsung Pay and current state is "active".
addCard(AddCardInfo, AddCardListener) - Method in class com.samsung.android.sdk.samsungpay.v2.card.CardManager: API to add a card from partner app (example: issuer/bank app) to Samsung Pay.
Partner app uses this API to add card to Samsung Pay by providing the required card details.
addCard(AddCardInfo, AddCardListener) - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to add a card from partner app (example: issuer/bank app) to Samsung Pay on watch.
Partner app uses this API to add card to Samsung Pay on watch by providing the required card details.
AddCardInfo - Class in com.samsung.android.sdk.samsungpay.v2.card: This class provides card information for enrollment.
AddCardInfo(String, String, Bundle) - Constructor for class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Constructor to create AddCardInfo instance.
AddCardListener - Interface in com.samsung.android.sdk.samsungpay.v2.card: The requested add card operation status is returned via this interface.
addControl(int, SheetControl) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to add SheetControl in specific location.
addControl(SheetControl) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to add SheetControl.
addItem(int, String, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to add item in specific location.
addItem(int, String, String, double, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to add item in specific location.
addItem(String, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to add item.
addItem(String, String, double, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to add item.
ADDRESS - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Controltype for Address(shipping / billing) Component.
AddressConstants - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class contains constants for AddressControl
AddressConstants() - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressConstants
AddressControl - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides AddressControl on custom payment sheet.
AddressControl is used for displaying billing address or shipping address
on custom payment sheet from "My Info" menu option on Samsung Pay app.

Caution: AddressControl must be returned in onResult() on SheetUpdatedListener to remove progress bar on custom payment sheet.
AddressControl(String, SheetItemType) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: Constructor to create AddressControl.
AMERICANEXPRESS - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for AMERICAN EXPRESS.
AMOUNTBOX - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Controltype for AmountBox Component.
There must be one AMOUNTBOX type in SheetControls.
AmountBoxControl - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides AmountBoxControl on custom payment sheet.
AmountBoxControl is used for displaying amount information on custom payment sheet.
AmountBoxControl(String, String) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: Constructor to create AmountBoxControl.
AmountConstants - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class contains constants for AmountControlBox.
AmountConstants() - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants
APP2APP - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using Issuer service.
AppToAppConstants - Interface in com.samsung.android.sdk.samsungpay.v2: This interface provides the common values of WatchManager and CardManager.

B

BILLING_ADDRESS - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: It is used for designating billing address in AddressControl.
BINDING_FAIL - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
build() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo.Builder: Builds the CardInfo object.
build() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the Address object.
build() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to build CustomSheetPaymentInfo object.
Builder() - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo.Builder
Builder() - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder

C

Card - Class in com.samsung.android.sdk.samsungpay.v2.card: This class provides card information related to the card management operations.
CARD_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the key for card type.
CARD_TYPE_CREDIT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is credit card.
CARD_TYPE_CREDIT_DEBIT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is either credit or debit.
CARD_TYPE_DEBIT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is debit card.
CARD_TYPE_GIFT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is gift card.
CARD_TYPE_LOYALTY - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is loyalty card.
CARD_TYPE_TRANSIT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is transit card.
CARD_TYPE_VACCINE_PASS - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Indicates that the card type is vaccine pass
CardInfo - Class in com.samsung.android.sdk.samsungpay.v2.payment: This class provides card information related to payment operations.
CardInfo.Builder - Class in com.samsung.android.sdk.samsungpay.v2.payment: This is builder class for constructing CardInfo object which is passed to Samsung Pay from merchant.
CardListener - Interface in com.samsung.android.sdk.samsungpay.v2.card: The requested operation about card is returned via this interface.
CardManager - Class in com.samsung.android.sdk.samsungpay.v2.card: This class provides APIs for card management.
CardManager(Context, PartnerInfo) - Constructor for class com.samsung.android.sdk.samsungpay.v2.card.CardManager: API to get the CardManager instance.
The caller should set valid ServiceId.
CHINAUNIONPAY - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for CHINA UNIONPAY.
com.samsung.android.sdk.samsungpay.v2 - package com.samsung.android.sdk.samsungpay.v2
com.samsung.android.sdk.samsungpay.v2.card - package com.samsung.android.sdk.samsungpay.v2.card
com.samsung.android.sdk.samsungpay.v2.payment - package com.samsung.android.sdk.samsungpay.v2.payment
com.samsung.android.sdk.samsungpay.v2.payment.sheet - package com.samsung.android.sdk.samsungpay.v2.payment.sheet
COMMON_STATUS_TABLE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This table shows the status codes used commonly.
Status Bundle Keys Bundle Values SpaySdk.SPAY_NOT_SUPPORTED (0) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_DEVICE_NOT_SAMSUNG (-350) SpaySdk.ERROR_SPAY_PKG_NOT_FOUND (-351) SpaySdk.ERROR_SPAY_SDK_SERVICE_NOT_AVAILABLE (-352) SpaySdk.ERROR_DEVICE_INTEGRITY_CHECK_FAIL (-353) SpaySdk.ERROR_SPAY_APP_INTEGRITY_CHECK_FAIL (-360) SpaySdk.ERROR_ANDROID_PLATFORM_CHECK_FAIL (-361) SpaySdk.SPAY_NOT_READY (1) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_SPAY_SETUP_NOT_COMPLETED (-356) SpaySdk.ERROR_SPAY_APP_NEED_TO_UPDATE (-357) SpaySdk.ERROR_SPAY_INTERNAL (-1) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_SERVER_INTERNAL (-311) N/A N/A SpaySdk.ERROR_NOT_ALLOWED (-6) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_INVALID_PARAMETER (-12) SpaySdk.ERROR_SDK_NOT_SUPPORTED_FOR_THIS_REGION (-300) SpaySdk.ERROR_SERVICE_ID_INVALID (-301) SpaySdk.ERROR_SERVICE_UNAVAILABLE_FOR_THIS_REGION (-302) SpaySdk.ERROR_PARTNER_APP_SIGNATURE_MISMATCH (-303) SpaySdk.ERROR_PARTNER_APP_VERSION_NOT_SUPPORTED (-304) SpaySdk.ERROR_PARTNER_APP_BLOCKED (-305) SpaySdk.ERROR_USER_NOT_REGISTERED_FOR_DEBUG (-306) SpaySdk.ERROR_SERVICE_NOT_APPROVED_FOR_RELEASE (-307) SpaySdk.ERROR_PARTNER_NOT_APPROVED (-308) SpaySdk.ERROR_UNAUTHORIZED_REQUEST_TYPE (-309) SpaySdk.ERROR_EXPIRED_OR_INVALID_DEBUG_KEY (-310) SpaySdk.ERROR_MISSING_INFORMATION (-354) SpaySdk.ERROR_UNABLE_TO_VERIFY_CALLER (-359) SpaySdk.ERROR_INVALID_PARAMETER (-12) N/A N/A SpaySdk.ERROR_NO_NETWORK (-21) N/A N/A SpaySdk.ERROR_SERVER_NO_RESPONSE (-22) N/A N/A SpaySdk.ERROR_PARTNER_INFO_INVALID (-99) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_PARTNER_SDK_API_LEVEL (-10) SpaySdk.ERROR_PARTNER_SERVICE_TYPE (-11) SpaySdk.ERROR_PARTNER_SDK_VERSION_NOT_ALLOWED (-358) SpaySdk.ERROR_INITIATION_FAIL (-103) N/A N/A SpaySdk.SPAY_NOT_ALLOWED_TEMPORALLY (3) SpaySdk.EXTRA_ERROR_REASON SpaySdk.ERROR_SPAY_CONNECTED_WITH_EXTERNAL_DISPLAY (-605) SpaySdk.ERROR_SPAY_FMM_LOCK (-604) N/A N/A PaymentManager.ERROR_MAKING_SHEET_FAILED (-115) N/A N/A
CRYPTOGRAM_TYPE_ICC - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the ICC cryptogram type of Mastercard.
CRYPTOGRAM_TYPE_UCAF - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the UCAF cryptogram type of Mastercard.
CUSTOM_MESSAGE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateSheet(CustomSheet, int, String) API with this error when it wants to Display a custom error message on CustomSheet.
CustomSheet - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides custom payment sheet which contains various SheetControls.
CustomSheet() - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: Constructor to create CustomSheet.
CustomSheet is used to contain various SheetControls.
CustomSheetPaymentInfo - Class in com.samsung.android.sdk.samsungpay.v2.payment: This class provides APIs to fetch Payment information details with custom payment sheet information.
That is, transaction details set by the merchant app.
CustomSheetPaymentInfo.Address - Class in com.samsung.android.sdk.samsungpay.v2.payment: This class provides APIs to create Address Parcel object.
CustomSheetPaymentInfo.Address.Builder - Class in com.samsung.android.sdk.samsungpay.v2.payment: This is builder class for constructing Address objects.
CustomSheetPaymentInfo.AddressInPaymentSheet - Enum Class in com.samsung.android.sdk.samsungpay.v2.payment: This enumeration provides types of address UI on the payment sheet, based on merchant requirement.
CustomSheetPaymentInfo.Builder - Class in com.samsung.android.sdk.samsungpay.v2.payment: This is builder class for constructing CustomSheetPaymentInfo object.

D

DEVICE_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent unique device ID.
DEVICE_SERIAL_NUM - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: Key to represent device serial number to generate the paymentAppInstanceId.
DEVICE_TYPE_GEAR - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Device type is Gear.
DEVICE_TYPE_PHONE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Device type is phone.
DISCOVER - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for DISCOVER.
DISPLAY_OPTION_ADDRESS - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressConstants: This is an option to display country, addressLine, city, state, postalCode of AddressControl on custom payment sheet.
DISPLAY_OPTION_ADDRESSEE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressConstants: This is an option to display addressee of AddressControl on custom payment sheet.
DISPLAY_OPTION_EMAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressConstants: This is an option to display email address of AddressControl on custom payment sheet.
DISPLAY_OPTION_PHONE_NUMBER - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressConstants: This is an option to display phone number of AddressControl on custom payment sheet.
DISPOSED - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is deleted from Samsung Pay.
DO_NOT_SHOW - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Shipping and billing address are not required for payment.
DUPLICATED_REQUEST - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType

E

ECI - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for Spain ECI.
enableEnforcePaymentSheet() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to enforce the payment sheet.
If partner wants to show payment sheet even though Fast Checkout is enabled,
they can show payment sheet using this API method.
ERROR_ADDRESS_UPDATED_TIME_OUT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that online payment address updating is timed out.
ERROR_ANDROID_PLATFORM_CHECK_FAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that Android platform version check has failed.
For in-app Payment, the Samsung Pay SDK requires Android 6.0(M) (Android API level 23) or later versions of the Android OS.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
ERROR_AUTH_CODE_EXPIRED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that auth code is expired.
This is returned as SpaySdk.EXTRA_ERROR_REASON for AppToAppConstants.ERROR_VERIFY_CARD error.
ERROR_AUTH_CODE_INVALID - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that auth code is invalid.
This is returned as SpaySdk.EXTRA_ERROR_REASON for AppToAppConstants.ERROR_VERIFY_CARD error.
ERROR_AUTH_CODE_MAX_TRY_REACHED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that maximum IDnV try reached.
This is returned as SpaySdk.EXTRA_ERROR_REASON for AppToAppConstants.ERROR_VERIFY_CARD error.
ERROR_AUTH_CODE_TYPE_INVALID - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that auth code type is invalid.
This is returned as SpaySdk.EXTRA_ERROR_REASON for AppToAppConstants.ERROR_VERIFY_CARD error.
ERROR_AUTHENTICATION_CLOSED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that authentication is force closed during update card service.
ERROR_AUTHENTICATION_FAILED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that authentication is failed during update card service.
ERROR_AUTHENTICATION_NOT_READY - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that authentication is not ready state during update card service.
ERROR_AUTHENTICATION_TIMED_OUT - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that authentication is closed due to timeout during update card service.
ERROR_BILLING_ADDRESS_INVALID - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateAmountFailed(int) or PaymentManager.updateSheet(CustomSheet, int, String) API with this error when the billing address shared by Samsung Pay to the merchant is invalid.
ERROR_BILLING_ADDRESS_NOT_EXIST - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateAmountFailed(int) or PaymentManager.updateSheet(CustomSheet, int, String) API with this error when the billing address shared by Samsung Pay does not exist.
ERROR_CARD_ALREADY_REGISTERED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the requested operation is already done and this operation cannot be performed again.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_CARD_IDV_NOT_SUPPORTED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the card does not support any IDnV.
This is returned as SpaySdk.EXTRA_ERROR_REASON for AppToAppConstants.ERROR_VERIFY_CARD error.
ERROR_CARD_NOT_SUPPORTED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that card is not supported.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_CARD_NOT_SUPPORTED_ONLINE_PAY - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that this card does not support online pay.
ERROR_DEVICE_INTEGRITY_CHECK_FAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that device integrity check has failed.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
ERROR_DEVICE_NOT_SAMSUNG - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the device is not a Samsung device.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
ERROR_DUPLICATED_SDK_API_CALLED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that duplicate API called by Partner.
ERROR_EXPIRED_OR_INVALID_DEBUG_KEY - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that debug key is invalid or expired.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app uses expired debug-api-key, then the partner app verification will be failed.
ERROR_FRAMEWORK_INTERNAL - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that an error occurred in payment framework while processing the request.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
For example, unable to load certificate from TA, unable to access payment framework db, and so on.
ERROR_INITIATION_FAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that session initiation or service binding has failed.
For example, if the service connection with Samsung Pay was not successful.
ERROR_INTERNAL_ADDRESS_UPDATED - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates address update internal error.
ERROR_INVALID_CARD - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the card is invalid.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_INVALID_CARDINPUT - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the user entered invalid card information.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_INVALID_PARAMETER - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.CardManager: This error indicates that the given parameter is invalid.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_INVALID_PARAMETER - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that requested operation contains invalid parameter or invalid bundle key/value.
ERROR_INVALID_PARAMETER - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that the given parameter is invalid.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_MAKING_SHEET_FAILED - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that making sheet has failed.
ERROR_MAX_CARD_NUM_REACHED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the maximum number of card limit has reached and user cannot add more card to Samsung Pay.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_MAX_PAN_PROVISION_NUM_REACHED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the limit number of enrollments of this PAN has reached and user cannot add this PAN this time.
ERROR_MISSING_INFORMATION - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that some information of partner is missing.
This error code is returned as an SpaySdk.EXTRA_ERROR_REASON of SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app does not deliver a required information to Samsung Pay to get the wallet information, then Samsung Pay will send this error to partner app.
Also if the partner does not define the issuer name in Samsung Pay Developer portal, Samsung Pay will send this error to partner app.
ERROR_NO_NETWORK - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that Samsung Pay is unable to connect to the server since there is no network.
For example, partner app tries to verify with server while network is not connected.
ERROR_NONE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that requested operation is success with no error.
ERROR_NOT_ALLOWED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that requested operation is not allowed.
For example, partner app verification has failed in Samsung Pay server.
ERROR_NOT_FOUND - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that given card ID is not found in Samsung Pay.
ERROR_NOT_READY_PAYMENT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that online payment is not ready to complete because of various types of errors.
For example, internal error, unexpected error from Samsung Pay app, and so on.
ERROR_NOT_SUPPORTED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that requested operation is not supported in Samsung Pay.
ERROR_PARTNER_APP_BLOCKED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that partner app version is removed/blocked by the Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app is blocked, then the partner app verification will be failed.
ERROR_PARTNER_APP_SIGNATURE_MISMATCH - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the app signature is different from the one registered from Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if different signature is used for signing apk, the partner app verification will be failed.
Checking signature logic will be activated in case debug mode is "N".
ERROR_PARTNER_APP_VERSION_NOT_SUPPORTED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that app version is not supported by Samsung Pay.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the version registered from developer portal is higher than current version(or no any version registered), then the partner app verification will be failed.
ERROR_PARTNER_INFO_INVALID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that partner information is invalid.
For example, partner app is using SDK version not allowed, invalid service type, wrong api level, and so on.
ERROR_PARTNER_NOT_APPROVED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that partner registration is not done on the Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app is submitted but not approved, then the partner app verification will be failed.
ERROR_PARTNER_SDK_API_LEVEL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that SDK API level is missing or invalid.
Partner must set valid API level in the AndroidManifest file.
ERROR_PARTNER_SDK_VERSION_NOT_ALLOWED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the partner app is using Samsung Pay SDK not allowed.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_PARTNER_INFO_INVALID error.
ERROR_PARTNER_SERVICE_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the Service Type is invalid.
Partner must set valid Service Type in PartnerInfo when calling APIs.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_READY error.
ERROR_REGISTRATION_FAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the card provisioning has failed.
ERROR_SDK_NOT_SUPPORTED_FOR_THIS_REGION - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the Samsung Pay SDK is not supported in particular region.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the device is from the country that Samsung Pay SDK is not supported, then the partner app verification will be failed.
ERROR_SERVER_INTERNAL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that server fails to proceed request due to unknown internal error.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_SPAY_INTERNAL error.
For example, if the server error occurred while the partner verification is going on, then the partner app verification will be failed.
ERROR_SERVER_NO_RESPONSE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that server did not respond to the Samsung Pay request.
ERROR_SERVER_REJECT - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that the server declined the request.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ERROR_SERVICE_ID_INVALID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that service ID is not registered with the Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if invalid service ID was used in partner app, then the partner app verification will be failed.
ERROR_SERVICE_NOT_APPROVED_FOR_RELEASE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that service version is not approved for release by the Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app is not registered for release mode, then the partner app verification will be failed.
ERROR_SERVICE_UNAVAILABLE_FOR_THIS_REGION - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that SDK support is not available for partner's service in particular region.
ERROR_SHIPPING_ADDRESS_INVALID - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateAmountFailed(int) or PaymentManager.updateSheet(CustomSheet, int, String) API with this error when the shipping address shared by Samsung Pay to the merchant is invalid.
ERROR_SHIPPING_ADDRESS_NOT_EXIST - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateAmountFailed(int) or PaymentManager.updateSheet(CustomSheet, int, String) API with this error when the shipping address shared by Samsung Pay does not exist.
ERROR_SHIPPING_ADDRESS_UNABLE_TO_SHIP - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: The merchant can call the PaymentManager.updateAmountFailed(int) or PaymentManager.updateSheet(CustomSheet, int, String) API with this error when the shipping address shared by Samsung Pay is not available for delivery by the merchant.
ERROR_SPAY_APP_INTEGRITY_CHECK_FAIL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that Samsung Pay app integrity check has failed.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
ERROR_SPAY_APP_NEED_TO_UPDATE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the Samsung Pay should be updated.
Partner app need to ask user to update Samsung Pay app.
ERROR_SPAY_CONNECTED_WITH_EXTERNAL_DISPLAY - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that device is connected with an external display.
Due to security reason, Samsung Pay cannot be launched at this moment.
In this case, partner can guide user to disconnect any external display if connected.
ERROR_SPAY_FMM_LOCK - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that device is locked due to FMM(Find My Mobile).
Partner app needs to ask user to unlock the Samsung Pay app.
ERROR_SPAY_INTERNAL - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that internal error has occurred while the requested operation is going on.
ERROR_SPAY_PIN_LOCK_SETUP_CANCELED - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that user canceled the PIN lock setup.
Partner app should ask user to setup PIN for Samsung Pay Gear.
ERROR_SPAY_PKG_NOT_FOUND - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the Samsung Pay application is not on the device.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
This could mean that the device does not support Samsung Pay.
ERROR_SPAY_RESET - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that spay will be reset.
ERROR_SPAY_SDK_SERVICE_NOT_AVAILABLE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that SDK service is not available on this device.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.SPAY_NOT_SUPPORTED error.
ERROR_SPAY_SETUP_NOT_COMPLETED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the Samsung Pay setup was not completed.
Partner app need to ask user to set up Samsung Pay app.
ERROR_SPAY_WATCH_CONNECTION - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that Samsung Pay(Watch Plug-in) can not connect with Samsung Pay(Watch).
Partner app should ask user to check bluetooth connection or pairing.
ERROR_SPAY_WATCH_PAY_PROGRESS - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that Samsung Pay(Watch) is in a process of payment.
ERROR_SPAY_WATCH_PIN_LOCK_SETUP_CANCELED - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that user canceled the PIN lock setup.
Partner app should ask user to setup PIN for Samsung Pay(Watch).
ERROR_TRANSACTION_CLOSED - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that transaction UI has closed.
ERROR_TRANSACTION_TIMED_OUT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that online payment processing has timed out.
ERROR_TSM_FAIL - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that TSM error is reported during card downloading.
ERROR_UNABLE_TO_VERIFY_CALLER - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that Samsung Pay is unable to verify partner app at this moment.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, Samsung Pay tried to connect to the server and validate partner ID, but the device does not have the network connectivity.
ERROR_UNAUTHORIZED_REQUEST_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that the partner is not authorized for this request type such as payment or enrollment.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the merchant app calls enrollment API, then the partner app verification will be failed.
ERROR_USER_CANCELED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that user has cancelled before completing the requested operation.
For example, user taps the cancel or back key on the payment sheet.
ERROR_USER_NOT_REGISTERED_FOR_DEBUG - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This error indicates that user account is not registered for using debug mode on the Samsung Pay Developers.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_NOT_ALLOWED error.
For example, if the partner app is in debug mode but the Samsung Account is not registered for the debug-api-key, then the partner app verification will be failed.
ERROR_VERIFY_CARD - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that server was unable to verify the card operation.
This may be due to invalid verification code.
ERROR_WALLET_ID_MISMATCH - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: This error indicates that wallet id is mismatch.
This is returned as SpaySdk.EXTRA_ERROR_REASON for SpaySdk.ERROR_REGISTRATION_FAIL error.
ErrorType - Enum Class in com.samsung.android.sdk.samsungpay.v2
existItem(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to check the item is existing or not.
existItem(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to check the item is existing or not.
EXPIRED - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is registered on Samsung Pay, but its current status is "expired".
This might occur if the card or token expiration time has reached and Samsung Pay has not renewed it.
EXTRA_ACCEPT_COMBO_CARD - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent that a merchant accepts combo card.
Partner can use this key to let customers to choose debit/credit in case of combo card.
EXTRA_APP2APP_INTENT - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: Key to represent App2App intent name defined by issuer server.
EXTRA_APP2APP_PAYLOAD - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: Key to represent App2App payload sent by issuer server.
EXTRA_CARD_BALANCE - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: Key to represent card balance.
EXTRA_CARD_STATUS_REASON - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: Key to represent extra card status for issuer app.
EXTRA_CARD_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent card type.
The possible values are:
Card.CARD_TYPE_CREDIT_DEBIT
Card.CARD_TYPE_CREDIT
Card.CARD_TYPE_DEBIT
Card.CARD_TYPE_GIFT
Card.CARD_TYPE_LOYALTY
Card.CARD_TYPE_TRANSIT
EXTRA_COUNTRY_CODE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent country code.
Device Country code(ISO 3166-1 alpha-2)
EXTRA_CPF_HOLDER_NAME - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to get CPF holder name in extra payment data.
When Partner requests CPF by SpaySdk.EXTRA_REQUIRE_CPF key, the Samsung Pay would bundle CPF information in the extraPaymentData parameter of PaymentManager.CustomSheetTransactionInfoListener.onSuccess(com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo, java.lang.String, android.os.Bundle) callback
EXTRA_CPF_NUMBER - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to get CPF number in extra payment data.
When Partner requests CPF by SpaySdk.EXTRA_REQUIRE_CPF key, the Samsung Pay would bundle CPF information in the extraPaymentData parameter of PaymentManager.CustomSheetTransactionInfoListener.onSuccess(com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo, java.lang.String, android.os.Bundle) callback
EXTRA_CRYPTOGRAM_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the DSRP (Digital Secure Remote Payments) cryptogram type of Mastercard.
EXTRA_DEVICE_CARD_LIMIT_REACHED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the maximum registered card number has reached or not.
EXTRA_DEVICE_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent type of the device (Mobile or Gear).
EXTRA_ERROR_REASON - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent extra error reasons.
EXTRA_ERROR_REASON_MESSAGE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent extra error reason messages.
EXTRA_ISSUER_APP_CARD_LINKED - Static variable in interface com.samsung.android.sdk.samsungpay.v2.AppToAppConstants: Key to represent extra card information for card link
EXTRA_ISSUER_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Key to represent issuer bin range.
EXTRA_ISSUER_NAME - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent name of the issuer.
This key can be used in the bundle for PartnerInfo(String, Bundle).
EXTRA_ISSUER_PKGNAME - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent package name of the issuer app on Android.
EXTRA_KEY_ADDITIONAL_DATA - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_KEY_CARD_BRAND_FILTER - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent request card filter list.
Partner can use this key to put filter into bundle for PaymentManager.requestCardInfo(Bundle, CardInfoListener)
EXTRA_KEY_MOSCOW_TRANSIT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Key to send extra transit card data to Samsung Pay for Russia Virtual Troika project.
The format of the data should be JSON string object.
EXTRA_KEY_TEST_MODE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent PG test mode to prevent payment transaction being processed.
If the value is true, Samsung-PG interface server redirects payment info to test PG server.
This is only for PG-Indirect model.
EXTRA_LAST4_DPAN - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the last four digits of digitalized Personal Identification Number (DPAN).
EXTRA_LAST4_FPAN - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent the last four digits of funding Personal Identification Number (FPAN).
EXTRA_LOGO_IMAGE_URL - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent the URL of partner logo image on Simple Pay.
Image width: Max.
EXTRA_MEMBER_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent member ID of the issuer.
This is for Korean issuers only.
EXTRA_MERCHANT_REF_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to set/get merchant reference ID beyond marketplace app or service(i.e.
EXTRA_PARTNER_NAME - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent name of the partner app.
This key can be used in the bundle for PartnerInfo(String, Bundle).
EXTRA_PAY_OPERATION_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent start Simple Pay operation type.
The possible values are:
PaymentManager.PAY_OPERATION_TYPE_PAYMENT
PaymentManager.PAY_OPERATION_TYPE_REFUND
EXTRA_PROVISION_PAYLOAD - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Key to represent encrypted blob from issuer on cardDetail bundle.
EXTRA_REQUEST_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent request id.
When a request is failed, TR will send this key to partner app.
EXTRA_REQUIRE_CPF - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent that a partner requires CPF.
Partner can use this key to ask Samsung Pay to show CPF information in the payment sheet.
EXTRA_RESOLVED_1 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_2 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_3 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_4 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_5 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_6 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_RESOLVED_7 - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent additional data.
Partner can use this key to put tagged data to a bundle before sending to Samsung Pay.
EXTRA_SAMSUNG_PAY_CARD - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Key to represent a Samsung Pay Card for push provisioning.
If the key value is true, the current push provisioning card will have a Samsung Pay Card type in Samsung Pay application.
This is only for specific issuer in UK.
EXTRA_TRANSACTION_DATE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent transaction date value when start Simple Pay to refund.
This is for Korean issuers only.

Example value mapped with this key : 201906211428(yyyyMMddHHmm)
EXTRA_TRANSACTION_NUMBER - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent transaction number value when start Simple Pay to refund.
This is for Korean issuers only.

Maximum length is 14.
EXTRA_TRANSACTION_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Key to represent transaction type.
The possible values are:
PaymentManager.TRANSACTION_TYPE_MST
PaymentManager.TRANSACTION_TYPE_NFC

F

FORMAT_TOTAL_AMOUNT_PENDING - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Amount pending)" with price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_AMOUNT_PENDING_TEXT_ONLY - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Amount pending" instead of price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_ESTIMATED_AMOUNT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Estimated amount)" with price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_ESTIMATED_CHARGE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Estimated charge)" with price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_ESTIMATED_FARE - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Estimated fare)" with price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_FREE_TEXT_ONLY - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Free" instead of price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_PENDING - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Pending)" with price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_PENDING_TEXT_ONLY - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Pending" instead of price value for AmountTotal on custom payment sheet.
FORMAT_TOTAL_PRICE_ONLY - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display price value only for AmountTotal on custom payment sheet.
FORMAT_TOTAL_UP_TO_AMOUNT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountConstants: This is an option to display "Total (Up to amount)" with price value for AmountTotal on custom payment sheet.

G

getAddress() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to get address.
getAddressee() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the addressee of Address details.
getAddressInPaymentSheet() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the address display option on the payment sheet.
getAddressLine1() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the address line 1 of Address details.
getAddressLine2() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the address line 2 of Address details.
getAddressTitle() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to get address title.
getAddressType() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to get address type.
getAllCards(Bundle, GetCardListener) - Method in class com.samsung.android.sdk.samsungpay.v2.card.CardManager: API to get all the cards from Samsung Pay for the given filter.
getAllCards(Bundle, GetCardListener) - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to get all the cards from Samsung Pay on watch for the given filter.
getAllowedCardBrands() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the brand of cards supported by merchant.
getBrand() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo: API to get the card brand.
getCardBrand() - Method in class com.samsung.android.sdk.samsungpay.v2.card.Card: API to get card brand.
getCardDetail() - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to get card details.
getCardId() - Method in class com.samsung.android.sdk.samsungpay.v2.card.Card: API to get unique identification of a card in Samsung Pay.
getCardId() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo: API to get unique identification of a card in Samsung Pay.
getCardInfo() - Method in class com.samsung.android.sdk.samsungpay.v2.card.Card: API to get extra card information(if any) related to the card.
getCardInfo() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the selected card information in Samsung Pay.
GetCardListener - Interface in com.samsung.android.sdk.samsungpay.v2.card: The requested getAllCards operation status is returned via this interface.
getCardMetaData() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo: API to get extra card information(if any) related to the card.
getCardStatus() - Method in class com.samsung.android.sdk.samsungpay.v2.card.Card: API to get current status of the card.
getCardType() - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to get card type.
getCity() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the city of Address details.
getControlId() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl: API to get controlId.
getControltype() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl: API to get controltype.
getCountryCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the country code of Address details.
getCurrencyCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to return the currency code.
ISO 4217 currency code (example: USD, KRW, EUR, and so on).
getCustomSheet() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return customSheet.
getData() - Method in class com.samsung.android.sdk.samsungpay.v2.PartnerInfo: API to get partner information extra.
Extra data differs from partners.
getDisplayOption() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to get display option of SheetItemType.SHIPPING_ADDRESS on custom payment sheet.
getEmail() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the email address of Address details.
getErrorCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to get error code of the AddressControl.
getExtraAddressInfo() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the configured extra addressInfo.
getExtraPaymentInfo() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the configured extra PaymentInfo.
getIsCardHolderNameRequired() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return whether card holder's name should be displayed on the card list on the payment sheet.
getIsRecurring() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return whether the payment is recurring or not.
getMerchantCountryCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the country code, where merchant is operating.
getMerchantId() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the merchant reference ID.
getMerchantName() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the merchant name.
getOrderNumber() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the order number for transaction.
getPaymentCardBrand() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the card brand which was used in the current transaction.
Partner can get this information if needed.
getPaymentCardLast4DPAN() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the last 4 digits of DPAN which was used in the current transaction.
Partner can get this information if needed.
getPaymentCardLast4FPAN() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the last 4 digits of FPAN which was used in the current transaction.
Partner can get this information if needed.
getPaymentCurrencyCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the ISO currency code which was used in the current transaction.
Partner can get this information if needed.
getPaymentShippingAddress() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the shipping/delivery address which was used in the current transaction.
Partner can get this information if needed.
getPaymentShippingMethod() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the shipping method which was used in the current transaction.
Partner can get this information if needed.
getPhoneNumber() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the phone number of Address details.
getPostalCode() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the postal code of Address details.
getSamsungPayStatus(StatusListener) - Method in class com.samsung.android.sdk.samsungpay.v2.SamsungPay: API to get the Samsung Pay status on the device.
Partner (Issuers, Merchants, and so on) applications must call this API to check the current state of Samsung Pay before doing any operation.
getSamsungPayStatus(StatusListener) - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to get the Samsung Pay on watch status on the device.
Partner (Issuers) applications must call this API to check the current state of Samsung Pay on watch before doing any operation.
getSelectedItemId() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to get the ID of selected item.
getServiceId() - Method in class com.samsung.android.sdk.samsungpay.v2.PartnerInfo: API to get service ID.
getSheetControl(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to get SheetControl.
getSheetControls() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to get SheetControl list.
getState() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address: API to return the state of Address details.
getText() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.PlainTextControl: API to get text.
getTitle() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.PlainTextControl: API to get title.
getTitle() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to get spinner title.
getTokenizationProvider() - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to get tokenization provider (example: VI, MC, AX, DS, and so on).
getValue(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to get value for ID.
getVersion() - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo: API to return the version name of the Samsung Pay package.
getVersionCode() - Static method in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Returns the version code of the Samsung Pay SDK.
getVersionName() - Static method in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Returns the version name of the Samsung Pay SDK.
getWalletInfo(List<String>, StatusListener) - Method in class com.samsung.android.sdk.samsungpay.v2.SamsungPay: API to get the requested wallet information from Samsung Pay.
Partner app can use this information to uniquely identify the user and Samsung Pay app on a particular device.
getWalletInfo(List<String>, StatusListener) - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to get the requested wallet information from Samsung Pay on watch.
Partner app can use this information to uniquely identify the user and Samsung Pay on watch app on a particular device.
goToUpdatePage() - Method in class com.samsung.android.sdk.samsungpay.v2.SamsungPay: API to go to Samsung Pay update page.
Partner app checks the Samsung Pay status with SamsungPay.getSamsungPayStatus(StatusListener) API.

If the status is #SPAY_NOT_READY and #EXTRA_ERROR_REASON is #ERROR_SPAY_APP_NEED_TO_UPDATE,
partner app can call this API to go to update Samsung Pay app.

If Samsung Pay App version is same or bigger than 2.1.00, it goes to "About SamsungPay" menu.
If Samsung Pay App version is lower than 2.1.00 or KR device, it launches Samsung Pay App main screen.
goToUpdatePage() - Method in class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to go to Samsung Pay on watch update page.
Partner app checks the Samsung Pay on watch status with getSamsungPayStatus(StatusListener) API.

If the status is #SPAY_NOT_READY and #EXTRA_ERROR_REASON is #ERROR_SPAY_APP_NEED_TO_UPDATE,
partner app can call this API to go to update Samsung Pay on watch app.

I

INAPP_PAYMENT - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using Online in-app payment service.
InAppPaymentCallback(PartnerRequest) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
InAppUserInfoCallback(UserInfoListener) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppUserInfoCallback
INSTALLMENT_SPINNER - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: It is used for designating installment in SpinnerControl.
This is for Korean issuers only.
INTERNAL_APK - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using Samsung Pay internal service.

M

MASTERCARD - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for MASTERCARD.
MOBILEWEB_PAYMENT - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using Mobile web payment service.

N

NAME_NOT_FOUND_EXCEPTION - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
NEED_BILLING_AND_SHIPPING - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Merchant requires billing and shipping address from Samsung Pay for payment.
Show both address lists on the payment sheet.
NEED_BILLING_SEND_SHIPPING - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Merchant requires billing address from Samsung Pay and sends the shipping address for payment.
Show both billing and shipping address on the payment sheet.
NEED_BILLING_SPAY - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Merchant requires billing address from Samsung Pay for payment.
Show only billing address list on the payment sheet.
NEED_SHIPPING_SPAY - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Merchant requires shipping address from Samsung Pay for payment.

O

OCTOPUS - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for HK OCTOPUS.
onAddressInfoChanged(PaymentInfo) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onApproveTransaction(PaymentInfo, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onCardInfoChanged(CardInfo) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onCardInfoUpdated(CardInfo, CustomSheet) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.CustomSheetTransactionInfoListener: This callback is received when the user changes card on the custom payment sheet in Samsung Pay.
In this callback, updateSheet() method must be called to update current payment sheet.
onCustomSheetCardInfoUpdated(CardInfo, CustomSheet) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onCustomSheetTransactionApproved(String, Bundle, CustomSheetPaymentInfo) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onCustomSheetUpdated(String, CustomSheet) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onFail(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.AddCardListener: This API is invoked when request operation has failed.
onFail(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.CardListener: This API is invoked when request operation has failed.
onFail(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.GetCardListener: This API is invoked when request operation has failed.
onFail(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.StatusListener: This API is invoked when request operation has failed.
onFailPayment(int, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onFailPaymentForCustomSheet(int, Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onFailure(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.CardInfoListener: This callback is received when the card information cannot be retrieved.
For example, when SDK service in the Samsung Pay app dies abnormally.
onFailure(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.CustomSheetTransactionInfoListener: This callback is received when the online payment transaction has failed.
onGetUserInfoInitiated(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppUserInfoCallback
onInitiateCompleted(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppPaymentCallback
onProgress(int, int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.AddCardListener: This API is invoked when progress is updated.
In case of TSM solution, it takes time for card provisioning.
onReceived(int, Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.InAppUserInfoCallback
onResult(String, CustomSheet) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetUpdatedListener: This callback is received when Controls are updated.
In this callback, updateSheet() method must be called to update current payment sheet.
onResult(List<CardInfo>) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.CardInfoListener: This callback is received when the card information is received successfully.
onSuccess(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.CardListener: This API is invoked when request operation is success.
onSuccess(int, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.StatusListener: This API is invoked when request operation is success.
onSuccess(int, Card) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.AddCardListener: This API is invoked when request operation is success.
onSuccess(CustomSheetPaymentInfo, String, Bundle) - Method in interface com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager.CustomSheetTransactionInfoListener: This callback is received when the online (in-app) payment transaction is approved by user and able to successfully generate in-app payload.
onSuccess(List<Card>) - Method in interface com.samsung.android.sdk.samsungpay.v2.card.GetCardListener: This API is invoked when request operation is success.

P

PAGOBANCOMAT - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for Italy PagoBancomat.
PARTNER_INFO_INVALID - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
PARTNER_SERVICE_TYPE - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent unique Service Type.
This key must be set in the bundle for PartnerInfo(String, Bundle).
PartnerInfo - Class in com.samsung.android.sdk.samsungpay.v2: This class holds the partner information.
PartnerInfo(String) - Constructor for class com.samsung.android.sdk.samsungpay.v2.PartnerInfo: Constructor to create Partner Information.
PartnerInfo(String, Bundle) - Constructor for class com.samsung.android.sdk.samsungpay.v2.PartnerInfo: Constructor to create Partner Information.
PAY_OPERATION_TYPE_PAYMENT - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates start Simple Pay option to make payment.
PAY_OPERATION_TYPE_REFUND - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates start Simple Pay option to make refund.
This is for Korean issuers only.
PaymentManager - Class in com.samsung.android.sdk.samsungpay.v2.payment: This class provides APIs for payment related operations (example: in-app payment).
Partner (Merchants and other third party) applications can use these APIs to perform variety of payment operations.

For instance, partner apps can:
- Request in-app payment
- Start Simple Pay on Samsung Pay
- Fetch available cards on Samsung Pay for payment
PaymentManager(Context, PartnerInfo) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Constructor of PaymentManager class.
The caller should set a valid serviceId in PartnerInfo.
PaymentManager.CardInfoListener - Interface in com.samsung.android.sdk.samsungpay.v2.payment: This interface is for listening requestCardInfo() callback events.
PaymentManager.CustomSheetTransactionInfoListener - Interface in com.samsung.android.sdk.samsungpay.v2.payment: This interface is for listening callback events of online (in-app) custom sheet payment.
This is invoked when card is changed by the user on the custom payment sheet, and also with the success or failure of online (in-app) payment.
This listener is registered when PaymentManager.startInAppPayWithCustomSheet(CustomSheetPaymentInfo, CustomSheetTransactionInfoListener) API is called.

Caution: AmountBoxControl must be returned in onCardInfoUpdated() on SheetUpdatedListener to remove progress bar on custom payment sheet.
PaymentManager.InAppPaymentCallback - Class in com.samsung.android.sdk.samsungpay.v2.payment
PaymentManager.InAppUserInfoCallback - Class in com.samsung.android.sdk.samsungpay.v2.payment
PENDING_ACTIVATION - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is registered on Samsung Pay but not activated yet.
A notification of card activation is expected to be pushed to Samsung Pay in a moment.
PENDING_PROVISION - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is not fully registered on Samsung Pay and current state is "pending provision".
Usually, this state returns when the user has not completed the secondary authentication(IDV).
PLAINTEXT - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Controltype for PlainText Component.
PlainTextControl - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides PlainTextControl on custom payment sheet.
This control is used for displaying 2-line text with title or 1-line text without title.
PlainTextControl(String) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.PlainTextControl: Constructor to create PlainTextControl.
PROVIDER_AMEX - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is AMEX.
PROVIDER_DISCOVER - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is DISCOVER.
PROVIDER_GEMALTO - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is GEMALTO.
PROVIDER_GIFT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is GIFT.
PROVIDER_LOYALTY - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is LOYALTY.
PROVIDER_MASTERCARD - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is MASTERCARD.
PROVIDER_MIR - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is MIR.
PROVIDER_NAPAS - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is NAPAS.
PROVIDER_PAGOBANCOMAT - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is PagoBANCOMAT.
PROVIDER_PAYPAL - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is PayPal.
PROVIDER_PLCC - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is PLCC.
PROVIDER_VACCINE_PASS - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is VaccinePass.
refer CardManager.addCard(AddCardInfo, AddCardListener) in detail.
PROVIDER_VISA - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: Indicates that the card tokenization provider is VISA.

R

REMOTE_EXCEPTION - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
removeControl(SheetControl) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to remove SheetControl.
removeItem(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to remove item.
removeItem(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to remove item.
requestCardInfo(Bundle, PaymentManager.CardInfoListener) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: API to request card information of the available cards for payment using Samsung Pay.
The partner app can use this API to query available cards (user already has registered) in Samsung Pay and decide whether to display Samsung Pay button or not on their application.
For example, if merchant app supports only one specific card brand, but the user has not registered any card with the brand, then merchant app decides not to display the Samsung Pay button with this query.

S

SamsungPay - Class in com.samsung.android.sdk.samsungpay.v2: This class provides APIs to get the Samsung Pay status on the device.
SamsungPay(Context, PartnerInfo) - Constructor for class com.samsung.android.sdk.samsungpay.v2.SamsungPay: Constructor to get the SamsungPay instance.
The caller should set the valid serviceId in PartnerInfo.
SEND_SHIPPING - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Merchant will send the shipping address for payment.
Show only shipping address shared by merchant as fixed value on the payment sheet.
SERVICE_DISCONNECTED - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
setAddress(CustomSheetPaymentInfo.Address) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to set address.
setAddressee(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the addressee for Address details.
setAddressInPaymentSheet(CustomSheetPaymentInfo.AddressInPaymentSheet) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the address display option for payment sheet.
setAddressLine1(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the address line 1 for Address details.
setAddressLine2(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the address line 2 for Address details.
setAddressTitle(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to set address title.
setAllowedCardBrands(List<SpaySdk.Brand>) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the card brands list supported by merchant.
setAmountTotal(double, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to set the amount total.
setCardDetail(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to set extra card details.
setCardHolderNameEnabled(boolean) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the flag if merchant wants to display card holder's name.
setCardId(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo.Builder: API to set unique identification of a card in Samsung Pay.
setCardMetaData(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CardInfo.Builder: API to set extra card information(if any) related to the card.
setCardType(String) - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to set card type.
setCity(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the city for Address details.
setCountryCode(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the country code for Address details.
setCurrencyCode(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to set the currency code.
setCustomSheet(CustomSheet) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set customSheet.
setData(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.PartnerInfo: API to set partner information extra.
setDisplayOption(int) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to set display option of SheetItemType.SHIPPING_ADDRESS on custom payment sheet.
setEmail(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the email address for Address details.
setErrorCode(int) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to set error code of the AddressControl.
setExtraAddressInfo(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the extra address information for Address details.
setExtraPaymentInfo(Bundle) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the extra payment information data.
setMerchantCountryCode(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the merchant country code.
setMerchantId(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the merchant reference ID.
setMerchantName(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the merchant name.
setOrderNumber(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the order number.
setPaymentCardBrand(SpaySdk.Brand) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the card brand for payment transaction.
This API can be used with CustomSheetPaymentInfo.Builder.setPaymentCardLast4DPAN(String) or
CustomSheetPaymentInfo.Builder.setPaymentCardLast4FPAN(String) API method to designate specific card for the transaction.
setPaymentCardLast4DPAN(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the last 4 digits of DPAN for payment transaction.
This API can be used with CustomSheetPaymentInfo.Builder.setPaymentCardBrand(SpaySdk.Brand) API method to designate specific card for the transaction.
setPaymentCardLast4FPAN(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the last 4 digits of FPAN for payment transaction.
This API can be used with CustomSheetPaymentInfo.Builder.setPaymentCardBrand(SpaySdk.Brand) API method to designate specific card for the transaction.
setPaymentShippingMethod(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set the shipping method for payment transaction.
setPhoneNumber(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the phone number for Address details.
setPostalCode(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the postal code for Address details.
setRecurringEnabled(boolean) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Builder: API to set if payment is recurring.
setSelectedItemId(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to set selected item with ID.
setSheetUpdatedListener(SheetUpdatedListener) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AddressControl: API to register a callback which is invoked when AddressControl is updated.
setSheetUpdatedListener(SheetUpdatedListener) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to register a callback which is invoked when SpinnerControl is updated.

SheetUpdatedListener.onResult(String, CustomSheet) is invoked when SpinnerControl is updated.
setState(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.Address.Builder: API to set the state for Address details.
setText(String, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.PlainTextControl: API to set the title and text.
setTitle(String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to set spinner title.
setTokenizationProvider(String) - Method in class com.samsung.android.sdk.samsungpay.v2.card.AddCardInfo: API to set tokenization provider.
SheetControl - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class is basic class for each component on custom payment sheet.
SheetControl.Controltype - Enum Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This enumeration provides SDK supported SheetControl type such as
PLAINTEXT, AMOUNTBOX, ADDRESS and SPINNER.
SheetItemType - Enum Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides ControlSheet item type to distinguish each item type on custom payment sheet.
SheetUpdatedListener - Interface in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This interface is for listening SheetControl events.
SHIPPING_ADDRESS - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: It is used for designating shipping address in AddressControl.
SHIPPING_METHOD_SPINNER - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: It is used for designating shipping method in SpinnerControl.
User will be able to change shipping method only when CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_SHIPPING_SPAY or CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_BILLING_AND_SHIPPING is set when building a CustomSheetPaymentInfo
SPAY_HAS_NO_TRANSIT_CARD - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This code is returned if Samsung Pay doesn't have a registered transit card This is for Korean issuers only.
SPAY_HAS_TRANSIT_CARD - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: This code is returned if Samsung Pay has a registered transit card.
This is for Korean issuers only.
SPAY_NOT_ALLOWED_TEMPORALLY - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Samsung Pay is not allowed temporally.
Refer extra reason delivered with SpaySdk.EXTRA_ERROR_REASON.
SPAY_NOT_READY - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Samsung Pay is not completely activated.
Usually, this status code is returned if the user did not complete the mandatory update or if the user is not signed in with the Samsung Account yet.
In this case, partner app can call SamsungPay.activateSamsungPay() API to launch Samsung Pay or can call SamsungPay.goToUpdatePage() API to update Samsung Pay app.
SPAY_NOT_SUPPORTED - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Samsung Pay is not supported on this device.
Usually, this status code is returned if the device is not compatible to run Samsung Pay or if the Samsung Pay app is not installed.
SPAY_READY - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Samsung Pay is activated and ready to use.
Usually, this status code is returned after user completes all the mandatory updates and is signed in.
SPAY_VALIDITY_FAIL - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
SPAY_WATCH_TAKING_LOG_FOR_REPORT - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that Samsung Pay(Watch) is taking log for error report.
SPAY_WATCH_UPDATE_IS_ONGOING - Static variable in class com.samsung.android.sdk.samsungpay.v2.WatchManager: This error indicates that Samsung Pay(Watch) being updated.
SpaySdk - Class in com.samsung.android.sdk.samsungpay.v2: This class allows to define Samsung Pay SDK information, common error codes, and constants.
SpaySdk.Brand - Enum Class in com.samsung.android.sdk.samsungpay.v2: This enumeration provides SDK supported card brands such as AMERICAN EXPRESS, MASTERCARD, VISA, DISCOVER, CHINA UNIONPAY, OCTOPUS, ECI and PAGOBANCOMAT.
SpaySdk.ServiceType - Enum Class in com.samsung.android.sdk.samsungpay.v2: This enumeration provides Service Types.
Partners must set their Service Type in the PartnerInfo when they call any APIs.
SPINNER - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Controltype for Spinner Component.
SpinnerControl - Class in com.samsung.android.sdk.samsungpay.v2.payment.sheet: This class provides SpinnerControl on custom payment sheet.
SpinnerControl is used for displaying spinner option on custom payment sheet.
SpinnerControl(String, String, SheetItemType) - Constructor for class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: Constructor to create SpinnerControl.
startInAppPayWithCustomSheet(CustomSheetPaymentInfo, PaymentManager.CustomSheetTransactionInfoListener) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: API to request online(in-app) payment with Samsung Pay.
startSimplePay(CardInfo, StatusListener) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: API to request payment with Simple Pay.
Using this API, partner app can start the Samsung Pay payment screen for a specific card.
For example, user can login to partner app (example: bank app), view the list of cards, and select a card (which is already registered in Samsung Pay) to make in-store payment.
StatusListener - Interface in com.samsung.android.sdk.samsungpay.v2: The requested operation status is returned via this interface.
Upon on success, status and extra data (if any) will be returned via onSuccess callback.
SUSPENDED - Static variable in class com.samsung.android.sdk.samsungpay.v2.card.Card: Card is registered on Samsung Pay and current state is "suspended".
Suspend can be triggered by issuer, card network, or the user.

T

TRANSACTION_TYPE_MST - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that transaction type is MST.
TRANSACTION_TYPE_NFC - Static variable in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: Indicates that transaction type is NFC.

U

UNKNOWN - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType
UNKNOWN_CARD - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand is unknown.
updateControl(SheetControl) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.CustomSheet: API to update SheetControl.
updateItem(String, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SpinnerControl: API to update item text.
updateSheet(CustomSheet) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: API to update sheet on the custom payment sheet.
updateSheet(CustomSheet, int, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.PaymentManager: API to update sheet on the custom payment sheet and display a custom error message.
updateTitle(String, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to update item title.
updateValue(String, double) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to update price.
currencyCode + price will appear on custom payment sheet.
If price is set, then extraPrice is initialized empty value, because extraPrice appear if extraPrice is not empty.
updateValue(String, double, String) - Method in class com.samsung.android.sdk.samsungpay.v2.payment.sheet.AmountBoxControl: API to update price and extraPrice.

V

valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.ErrorType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.CustomSheetPaymentInfo.AddressInPaymentSheet: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetControl.Controltype: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.payment.sheet.SheetItemType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Returns an array containing the constants of this enum class, in the order they are declared.
VISA - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.Brand: Card brand for VISA.

W

W3C - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using W3C payment service.
WALLET_DM_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent unique device management ID.
WALLET_USER_ID - Static variable in class com.samsung.android.sdk.samsungpay.v2.SpaySdk: Key to represent user's wallet ID.
WatchManager - Class in com.samsung.android.sdk.samsungpay.v2: This class provides APIs for watch management.
WatchManager(Context, PartnerInfo) - Constructor for class com.samsung.android.sdk.samsungpay.v2.WatchManager: API to get the WatchManager instance.
The caller should set valid ServiceId.
WEB_PAYMENT - Enum constant in enum class com.samsung.android.sdk.samsungpay.v2.SpaySdk.ServiceType: Service type for using Web payment service.

All Classes and Interfaces|All Packages|Constant Field Values

Samsung Electronics.
Samsung Pay SDK 2.18.00 - Aug 25 2023

Index

A

B

C

D

E

F

G

I

M

N

O

P

R

S

T

U

V

W