VillageMerchantOptions

Options unique to using the Merchant API operations.

class VillageMerchantOptions(apiKey: String, baseUrl: String, wallet: Wallet?, merchantId: String?) : VillageOptions

Constructors

VillageMerchantOptions
Link copied to clipboard
fun VillageMerchantOptions(apiKey: String, baseUrl: String, wallet: Wallet?, merchantId: String?)

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open override fun hashCode(): Int
toString
Link copied to clipboard
open override fun toString(): String

Properties

apiKey
Link copied to clipboard

The API key to identify the SDK to the API.

override val apiKey: String
baseUrl
Link copied to clipboard

An initial base URL for the API host to use. Is comprised of the the scheme, host, and any context root for the API paths to use eg: https://myawesomeapp.com/api

override val baseUrl: String
merchantId
Link copied to clipboard

If given, the merchant ID will be added to the headers.

Since the merchant ID identifies the merchant it can be overridden with another value by the API gateway which uses the authentication token to identify the merchant.

val merchantId: String?
wallet
Link copied to clipboard

Which wallet to interact with for everything related to payment instruments, preferences, etc. Applies across the SDK. If a different Wallet is needed, instantiate the SDK again.

If not specified, will default to Wallet.MERCHANT.

override val wallet: Wallet?