Package com.sudoplatform.sudovirtualcards.types

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

Types

BillingAddress

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

The legal residence of a cardholder for purposes of billing.

CachePolicy

enum CachePolicy : Enum<CachePolicy>

Enumeration outlining options for how data will be fetched.

Card

data class Card(id: String, owners: List<Owner>, owner: String, version: Int, fundingSourceId: String, state: Card.State, cardHolder: String, alias: String, last4: String, cardNumber: String, securityCode: String, billingAddress: BillingAddress?, expirationMonth: Int, expirationYear: Int, currency: String, activeTo: Date, cancelledAt: Date?, createdAt: Date, updatedAt: Date) : Parcelable

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

CurrencyAmount

data class CurrencyAmount(currency: String, amount: Int) : Parcelable

A currency used in the virtual cards system.

DeclineReason

enum DeclineReason : Enum<DeclineReason>

The reason why a Transaction was declined.

FundingSource

data class FundingSource(id: String, owner: String, version: Int, state: FundingSource.State, currency: String, last4: String, network: FundingSource.CreditCardNetwork) : Parcelable

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

FundingSourceType

data class FundingSourceType(type: String, version: Int, apiKey: String)

Representation of a Stripe FundingSourceType configuration.

ListOutput

data class ListOutput<T>(items: List<T>, nextToken: String?)

Representation of a generic type to wrap around a GraphQL list type.

Markup

data class Markup(percent: Int, flat: Int, minCharge: Int) : Parcelable

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

Owner

data class Owner(id: String, issuer: String) : Parcelable

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

ProvisionalCard

data class ProvisionalCard(id: String, clientRefId: String, owner: String, version: Int, state: ProvisionalCard.State, card: Card?, createdAt: Date, updatedAt: Date)

A card that is in the process of being provisioned.

StripeClientConfiguration

data class StripeClientConfiguration(fundingSourceTypes: List<FundingSourceType>)

Representation of a StripeClientConfiguration used to perform API calls to Stripe.

StripeCommonData

abstract class StripeCommonData

Representation of StripeCommonData which provides common data for all Stripe based data.

StripeCompletionData

data class StripeCompletionData(provider: String, version: Int, paymentMethod: String) : StripeCommonData

Representation of StripeCompletionData received from Stripe used to complete the funding source creation.

StripeData

data class StripeData(provider: String, version: Int, intent: String, clientSecret: String) : StripeCommonData

Representation of StripeData used for the StripeSetup intent.

StripeDefaults

object StripeDefaults

Initializes StripeDefaults.

StripeSetup

data class StripeSetup(id: String, data: StripeData)

Representation of StripeSetup data from the setup intent.

Transaction

data class Transaction(id: String, owner: String, version: Int, cardId: String, sequenceId: String, type: Transaction.Type, billedAmount: CurrencyAmount, transactedAmount: CurrencyAmount, description: String, declineReason: DeclineReason?, details: List<TransactionChargeDetail>, transactedAt: Date, createdAt: Date, updatedAt: Date) : Parcelable

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

TransactionChargeDetail

data class TransactionChargeDetail(virtualCardAmount: CurrencyAmount, markup: Markup, markupAmount: CurrencyAmount, fundingSourceAmount: CurrencyAmount, fundingSourceId: String, description: String) : Parcelable

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