Method Details

• getVersion

  public String getVersion()

  API to return the version name of the Samsung Pay package.

  Returns:

  SDK version name.

  Since:

  API Level 1.3

• getMerchantId

  public String getMerchantId()

  API to return the merchant reference ID.

  Returns:

  Merchant reference ID which can be used for merchant's own purpose.
  For example, if merchant uses a Payment Gateway which requires Payment Gateway User ID, then merchantId field can be set with a Payment Gateway User ID.
  

  Since:

  API Level 1.3

• getMerchantName

  public String getMerchantName()

  API to return the merchant name.

  Returns:

  Merchant name.

  Since:

  API Level 1.3

• getOrderNumber

  public String getOrderNumber()

  API to return the order number for transaction.

  Returns:

  Order number which is sent by merchant for records.

  Since:

  API Level 1.3

• getAddressInPaymentSheet

  public CustomSheetPaymentInfo.AddressInPaymentSheet getAddressInPaymentSheet()

  API to return the address display option on the payment sheet.

  Returns:

  One of the following values to indicate if the address needs to be displayed on the payment sheet or not.
  CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_BILLING_AND_SHIPPING
CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_BILLING_SEND_SHIPPING
CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_BILLING_SPAY
CustomSheetPaymentInfo.AddressInPaymentSheet.NEED_SHIPPING_SPAY
CustomSheetPaymentInfo.AddressInPaymentSheet.SEND_SHIPPING
CustomSheetPaymentInfo.AddressInPaymentSheet.DO_NOT_SHOW
  

  Since:

  API Level 1.3

• getAllowedCardBrands

  public List<SpaySdk.Brand> getAllowedCardBrands()

  API to return the brand of cards supported by merchant.

  Returns:

  List of card brands supported.
  

  Since:

  API Level 1.3

• getCardInfo

  public CardInfo getCardInfo()

  API to return the selected card information in Samsung Pay.

  Returns:

  CardInfo object.

  Since:

  API Level 1.3

• getIsCardHolderNameRequired

  public boolean getIsCardHolderNameRequired()

  API to return whether card holder's name should be displayed on the card list on the payment sheet.

  Returns:

  True, if card holder's name is to be displayed on the payment sheet. Else, returns false.

  Since:

  API Level 1.3

• getIsRecurring

  public boolean getIsRecurring()

  API to return whether the payment is recurring or not.

  Returns:

  True, if payment is recurring. Else, returns false.

  Since:

  API Level 1.3

• getMerchantCountryCode

  public String getMerchantCountryCode()

  API to return the country code, where merchant is operating.

  Returns:

  Country code for region where merchant is operating.

  Since:

  API Level 1.3

• getExtraPaymentInfo

  public android.os.Bundle getExtraPaymentInfo()

  API to return the configured extra PaymentInfo.

  Returns:

  Extra PaymentInfo configured by merchant app.

  Since:

  API Level 1.3

• getCustomSheet

  public CustomSheet getCustomSheet()

  API to return customSheet.

  Returns:

  CustomSheet configured by merchant app.

  Since:

  API Level 1.3

• getPaymentCardLast4DPAN

  public String getPaymentCardLast4DPAN()

  API to return the last 4 digits of DPAN which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  The last 4 digits of DPAN which was used in the current transaction.

  Since:

  API Level 1.7

• getPaymentCardLast4FPAN

  public String getPaymentCardLast4FPAN()

  API to return the last 4 digits of FPAN which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  The last 4 digits of FPAN which was used in the current transaction.

  Since:

  API Level 1.7

• getPaymentCardBrand

  public SpaySdk.Brand getPaymentCardBrand()

  API to return the card brand which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  Card brand which was used in the current transaction.

  Since:

  API Level 1.7

  See Also:

  • SpaySdk.Brand

• getPaymentCurrencyCode

  public String getPaymentCurrencyCode()

  API to return the ISO currency code which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  Currency code which was used in the current transaction.

  Since:

  API Level 1.7

• getPaymentShippingAddress

  public CustomSheetPaymentInfo.Address getPaymentShippingAddress()

  API to return the shipping/delivery address which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  Shipping address which was used in the current transaction.

  Since:

  API Level 1.7

  See Also:

  • CustomSheetPaymentInfo.Address

• getPaymentShippingMethod

  public String getPaymentShippingMethod()

  API to return the shipping method which was used in the current transaction.
  Partner can get this information if needed. They can use this for their own purpose.
  This API method can be used in PaymentManager.CustomSheetTransactionInfoListener.onSuccess(CustomSheetPaymentInfo, String, Bundle) callback only.
  This api is available only with US Samsung Pay app.
  

  Returns:

  Shipping method which was used in the current transaction.

  Since:

  API Level 1.7