Package com.sudoplatform.sudovirtualcards.types

Types used by the methods of the Sudo Platform Virtual Cards SDK.

Types

Link copied to clipboard
data class BillingAddress(addressLine1: String, addressLine2: String?, city: String, state: String, postalCode: String, country: String) : Parcelable

The representation of the legal residence of a cardholder for purposes of billing in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
enum CachePolicy : Enum<CachePolicy>

Representation of an enumeration outlining options for how data will be fetched in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
enum CardState : Enum<CardState>

Representation of an enumeration depicting the state that the VirtualCard is in, in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class CreateKeysIfAbsentResult(symmetricKey: KeyResult, keyPair: KeyResult)

The result of the create keys if absent API.

Link copied to clipboard
data class CurrencyAmount(currency: String, amount: Int) : Parcelable

The representation of the currency and amount used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class DateRange(startDate: Date, endDate: Date)

Representation of a date range used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
enum DeclineReason : Enum<DeclineReason>

Representation of an enumeration depicting why a Transaction was declined in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class Expiry(mm: String, yyyy: String) : Parcelable

The representation of expiry information for a virtual card in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class FundingSource(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, state: FundingSource.State, currency: String, last4: String, network: FundingSource.CreditCardNetwork) : Parcelable

Representation of a funding source used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class FundingSourceClientConfiguration(type: String, version: Int, apiKey: String) : Parcelable

A representation of the funding source client configuration in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class FundingSourceTypes(fundingSourceTypes: List<FundingSourceClientConfiguration>) : Parcelable

Representation of a FundingSourceType configuration.

Link copied to clipboard
sealed class JsonValue<out T>

A representation of a JsonValue type used to represent data that can pertain to multiple primitive types.

Link copied to clipboard
data class KeyResult(created: Boolean, keyId: String)

The result containing information about whether the key was created and its identifier.

Link copied to clipboard
sealed class ListAPIResult<out T, out P>

Result type of an API that returns a list. Supports partial results.

Link copied to clipboard
data class ListOutput<T>(items: List<T>, nextToken: String?)

Representation of a generic type to wrap around a GraphQL list type. This is useful for exposing a list of items and nextToken to allow for pagination by calling for the next set of paginated results.

Link copied to clipboard
data class Markup(percent: Int, flat: Int, minCharge: Int?) : Parcelable

The rates of markup applied to a Transaction when calculating the fees.

Link copied to clipboard
data class Owner(id: String, issuer: String) : Parcelable

This represents the relationship of a unique identifier id with the issuer to a VirtualCard.

Link copied to clipboard
data class PartialResult<P>(partial: P, cause: Exception)

Represents a single partial result.

Link copied to clipboard
data class PartialTransaction(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, cardId: String, sequenceId: String, type: TransactionType) : Parcelable

Representation of a Virtual Card Transaction without its unsealed attributes used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class PartialVirtualCard(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, owners: List<Owner>, fundingSourceId: String, currency: String, state: CardState, activeTo: Date, cancelledAt: Date?, last4: String) : Parcelable

Representation of a Virtual Card without its unsealed attributes used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
abstract class ProviderCommonData

Representation of ProviderCommonData which provides common data for all funding source provider based data.

Link copied to clipboard
data class ProviderCompletionData(provider: String, version: Int, paymentMethod: String) : ProviderCommonData

Representation of ProviderCompletionData received from the provider used to complete the funding source creation.

Link copied to clipboard
object ProviderDefaults

Initializes ProviderDefaults.

Link copied to clipboard
data class ProvisionalFundingSource(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, state: ProvisionalFundingSource.ProvisioningState, provisioningData: ProvisioningData) : Parcelable

A representation of a funding source that is in the process of being created in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class ProvisionalVirtualCard(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, clientRefId: String, provisioningState: ProvisionalVirtualCard.ProvisioningState, card: VirtualCard?) : Parcelable

A representation of a virtual card that is in the process of being provisioned in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class ProvisioningData(provider: String, version: Int, intent: String, clientSecret: String) : ProviderCommonData, Parcelable

Representation of ProvisioningData used to provision a funding source.

Link copied to clipboard
sealed class SingleAPIResult<out T, out P>

Result type of a singular return type from an API that can return a partial result.

Link copied to clipboard
enum SortOrder : Enum<SortOrder>

An enumeration depicting sort order in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard

Representation of an enumeration depicting a list of supported key encryption algorithms.

Link copied to clipboard
data class Transaction(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, transactedAt: Date, settledAt: Date?, cardId: String, sequenceId: String, type: TransactionType, billedAmount: CurrencyAmount, transactedAmount: CurrencyAmount, description: String, declineReason: DeclineReason?, details: List<TransactionDetailCharge>) : Parcelable

Representation of a Virtual Card Transaction used in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class TransactionDetailCharge(virtualCardAmount: CurrencyAmount, markup: Markup, markupAmount: CurrencyAmount, fundingSourceAmount: CurrencyAmount, fundingSourceId: String, description: String) : Parcelable

The details of how a Transaction is charged against a VirtualCard and FundingSource as well as the amount of markup that was applied to the Transaction.

Link copied to clipboard
enum TransactionType : Enum<TransactionType>

Representation of an enumeration depicting the type of Transaction in the Sudo Platform Virtual Cards SDK.

Link copied to clipboard
data class VirtualCard(id: String, owner: String, version: Int, createdAt: Date, updatedAt: Date, owners: List<Owner>, fundingSourceId: String, currency: String, state: CardState, activeTo: Date, cancelledAt: Date?, cardHolder: String, last4: String, cardNumber: String, securityCode: String, alias: String?, metadata: JsonValue<Any>?, billingAddress: BillingAddress?, expiry: Expiry, lastTransaction: Transaction?) : Parcelable

Representation of a Virtual Card used in the Sudo Platform Virtual Cards SDK.