components-core/com.airwallex.android.core.model

Package-level declarations

Types

AbstractPaymentIntentParams

abstract class AbstractPaymentIntentParams(val paymentIntentId: String, val clientSecret: String)

AbstractPaymentMethodParams

abstract class AbstractPaymentMethodParams(val customerId: String, val clientSecret: String)

Address

data class Address : AirwallexModel, AirwallexRequestModel, Parcelable

Address information.

AirwallexError

data class AirwallexError(val code: String? = null, val source: String? = null, val message: String? = null) : AirwallexModel, Parcelable, Serializable

Airwallex uses conventional HTTP response codes to indicate the success or failure of an API request. Typically a status code in the 2xx range indicates success, status codes in the 4xx range indicate an error that has been triggered due to the information provided (for example; a parameter does not meet the validation requirements or was not provided), and status codes in the 5xx range indicate an error with our servers.

AirwallexModel

interface AirwallexModel

AirwallexPaymentRequest

data class AirwallexPaymentRequest(val additionalInfo: Map<String, String>? = null, val flow: AirwallexPaymentRequestFlow? = null, val osType: String? = null) : AirwallexModel, AirwallexRequestModel, Parcelable

Request for Bank

AirwallexPaymentRequestFlow

enum AirwallexPaymentRequestFlow : Enum<AirwallexPaymentRequestFlow> , Parcelable

AirwallexRequestModel

interface AirwallexRequestModel

AvailablePaymentMethodType

data class AvailablePaymentMethodType(val name: String, val displayName: String? = null, val transactionMode: TransactionMode? = null, val flows: List<AirwallexPaymentRequestFlow>? = null, val transactionCurrencies: List<String>? = null, val countryCodes: List<String>? = null, val active: Boolean? = null, val resources: AvailablePaymentMethodTypeResource? = null, val cardSchemes: List<CardScheme>? = null) : AirwallexModel, Parcelable

AvailablePaymentMethodTypeResource

data class AvailablePaymentMethodTypeResource(val hasSchema: Boolean? = null, val logos: LogoResources? = null) : AirwallexModel, Parcelable

Bank

data class Bank(val name: String, val displayName: String, val resources: BankResources?) : AirwallexModel, Parcelable

Bank information.

BankResources

data class BankResources : AirwallexModel, Parcelable

Resources of bank

BankResponse

data class BankResponse : AirwallexModel, Parcelable

Response for retrieve available payment method types

Billing

data class Billing : AirwallexModel, AirwallexRequestModel, Parcelable

Billing information.

CardScheme

data class CardScheme(val name: String) : Parcelable

ClientSecret

data class ClientSecret(val value: String, val expiredTime: Date) : AirwallexModel, Parcelable

ConfirmPaymentIntentParams

data class ConfirmPaymentIntentParams : AbstractPaymentIntentParams

The params that used for confirm PaymentIntent

ContinuePaymentIntentParams

data class ContinuePaymentIntentParams(val paymentIntentId: String, val clientSecret: String, val type: PaymentIntentContinueType, val threeDSecure: ThreeDSecure? = null, val device: Device? = null, val useDcc: Boolean? = null) : AbstractPaymentIntentParams

The params that used for continue PaymentIntent

CreatePaymentConsentParams

data class CreatePaymentConsentParams(val clientSecret: String, val customerId: String, val paymentMethodId: String? = null, val googlePay: PaymentMethod.GooglePay? = null, val paymentMethodType: String, val nextTriggeredBy: PaymentConsent.NextTriggeredBy, val merchantTriggerReason: PaymentConsent.MerchantTriggerReason? = PaymentConsent.MerchantTriggerReason.UNSCHEDULED, val requiresCvc: Boolean? = null)

The params that used for create PaymentConsent

CreatePaymentMethodParams

data class CreatePaymentMethodParams(val clientSecret: String, val customerId: String, val card: PaymentMethod.Card, val billing: Billing?) : AbstractPaymentMethodParams

The params that used for create PaymentMethod

Dependency

enum Dependency : Enum<Dependency>

Device

data class Device : AirwallexModel, AirwallexRequestModel, Parcelable

Device info.

DisablePaymentConsentParams

data class DisablePaymentConsentParams(val paymentConsentId: String, val clientSecret: String)

The params that used for disable PaymentConsent

DynamicSchema

data class DynamicSchema(val transactionMode: TransactionMode? = null, val fields: List<DynamicSchemaField>? = null) : AirwallexModel, Parcelable

DynamicSchemaField

data class DynamicSchemaField(val name: String, val displayName: String, val uiType: DynamicSchemaFieldUIType?, val type: DynamicSchemaFieldType?, val hidden: Boolean, val candidates: List<DynamicSchemaFieldCandidate>?, val validations: DynamicSchemaFieldValidation?) : AirwallexModel, Parcelable

DynamicSchemaFieldCandidate

data class DynamicSchemaFieldCandidate : Parcelable

DynamicSchemaFieldType

enum DynamicSchemaFieldType : Enum<DynamicSchemaFieldType> , Parcelable

DynamicSchemaFieldUIType

enum DynamicSchemaFieldUIType : Enum<DynamicSchemaFieldUIType> , Parcelable

DynamicSchemaFieldValidation

data class DynamicSchemaFieldValidation : Parcelable

IntegrationData

data class IntegrationData(val type: String, val version: String) : AirwallexModel, AirwallexRequestModel, Parcelable

sdk information

NextAction

data class NextAction(val stage: NextAction.NextActionStage? = null, val type: NextAction.NextActionType?, val data: Map<String, Any?>?, val dcc: NextAction.DccData?, val url: String?, val fallbackUrl: String?, val method: String?, val packageName: String?) : AirwallexModel, Parcelable

ObjectBuilder

interface ObjectBuilder<ObjectType>

Options

sealed class Options : Parcelable

Page

interface Page<T> : AirwallexModel

PaymentConsent

data class PaymentConsent(val id: String? = null, val requestId: String? = null, val customerId: String? = null, var paymentMethod: PaymentMethod? = null, val initialPaymentIntentId: String? = null, val nextTriggeredBy: PaymentConsent.NextTriggeredBy? = null, val merchantTriggerReason: PaymentConsent.MerchantTriggerReason? = null, val requiresCvc: Boolean = false, val metadata: Map<String, Any?>? = null, val status: PaymentConsent.PaymentConsentStatus? = null, val createdAt: Date? = null, val updatedAt: Date? = null, val nextAction: NextAction? = null, val clientSecret: String? = null) : AirwallexModel, Parcelable

PaymentConsentCreateRequest

data class PaymentConsentCreateRequest : AirwallexRequestModel, Parcelable

Params for create a PaymentConsent

PaymentConsentDisableRequest

data class PaymentConsentDisableRequest : AirwallexRequestModel, Parcelable

Params for disable a payment consent

PaymentConsentReference

data class PaymentConsentReference : AirwallexModel, AirwallexRequestModel, Parcelable

Reference to an existing PaymentConsent

PaymentConsentVerifyRequest

data class PaymentConsentVerifyRequest : AirwallexRequestModel, Parcelable

Params for create a PaymentConsent

PaymentIntent

data class PaymentIntent(val id: String, val requestId: String? = null, val amount: BigDecimal, val currency: String, val merchantOrderId: String? = null, val order: PurchaseOrder? = null, val customerId: String? = null, val descriptor: String? = null, val metadata: Map<String, Any?>? = null, val status: PaymentIntentStatus? = null, val capturedAmount: BigDecimal? = null, val latestPaymentAttempt: PaymentIntent.PaymentAttempt? = null, val availablePaymentMethodTypes: List<PaymentMethodType>? = null, val customerPaymentMethods: List<PaymentMethod>? = null, val customerPaymentConsents: List<PaymentConsent>? = null, val clientSecret: String? = null, val nextAction: NextAction? = null, val createdAt: Date? = null, val updatedAt: Date? = null, val cancelledAt: Date? = null, val cancellationReason: String? = null) : AirwallexModel, Parcelable

A PaymentIntent guides you through the process of collecting a payment from your customer. It tracks a payment when your customer first checks out, through to when payment is successfully paid by your customer. A PaymentIntent transitions through a number of states throughout the customer's payment journey.

PaymentIntentConfirmRequest

data class PaymentIntentConfirmRequest : AirwallexRequestModel, Parcelable

The request params to confirm PaymentIntent

PaymentIntentContinueRequest

data class PaymentIntentContinueRequest(val requestId: String? = null, val type: PaymentIntentContinueType? = null, val threeDSecure: ThreeDSecure? = null, val device: Device? = null, val useDcc: Boolean? = null) : AirwallexRequestModel, Parcelable

The request params to confirm PaymentIntent

PaymentIntentContinueType

enum PaymentIntentContinueType : Enum<PaymentIntentContinueType> , Parcelable

PaymentIntentStatus

enum PaymentIntentStatus : Enum<PaymentIntentStatus> , Parcelable

The status of a PaymentIntent

PaymentMethod

data class PaymentMethod : AirwallexModel, Parcelable

A PaymentMethod represents the funding source that is used by your customer when making a payment. You may create and add multiple payment methods to a customer as saved payment methods to help streamline your customers' checkout experience.

PaymentMethodCreateRequest

data class PaymentMethodCreateRequest : AirwallexRequestModel, Parcelable

Params for create a payment method

PaymentMethodOptions

data class PaymentMethodOptions : AirwallexModel, AirwallexRequestModel, Parcelable

Options for payment method

PaymentMethodReference

data class PaymentMethodReference(val id: String, val cvc: String) : AirwallexModel, AirwallexRequestModel, Parcelable

Reference for payment method

PaymentMethodRequest

class PaymentMethodRequest(val id: String? = null, val type: String, val paymentRequest: AirwallexPaymentRequest? = null, val card: PaymentMethod.Card? = null, val googlePay: PaymentMethod.GooglePay? = null, val billing: Billing? = null) : AirwallexRequestModel, Parcelable

PaymentMethodType

enum PaymentMethodType : Enum<PaymentMethodType> , Parcelable

The type of PaymentMethod

PaymentMethodTypeInfo

data class PaymentMethodTypeInfo : AirwallexModel, Parcelable

PhysicalProduct

data class PhysicalProduct : AirwallexModel, AirwallexRequestModel, Parcelable

Product information

PurchaseOrder

data class PurchaseOrder(val products: List<PhysicalProduct>? = null, val shipping: Shipping? = null, val type: String? = null) : AirwallexModel, AirwallexRequestModel, Parcelable

Purchase order information

RetrieveAvailablePaymentConsentsParams

data class RetrieveAvailablePaymentConsentsParams

RetrieveAvailablePaymentMethodParams

data class RetrieveAvailablePaymentMethodParams

The params that used for retrieve PaymentMethod

RetrieveBankParams

data class RetrieveBankParams

The params that used for retrieve PaymentMethodTypeInfo

RetrievePaymentIntentParams

data class RetrievePaymentIntentParams(val paymentIntentId: String, val clientSecret: String) : AbstractPaymentIntentParams

The params that used for retrieve PaymentIntent

RetrievePaymentMethodTypeInfoParams

data class RetrievePaymentMethodTypeInfoParams

The params that used for retrieve PaymentMethodTypeInfo

Shipping

data class Shipping : AirwallexModel, AirwallexRequestModel, Parcelable

Shipping information

ThreeDSecure

data class ThreeDSecure : AirwallexModel, AirwallexRequestModel, Parcelable

ThreeDSecureLookup

data class ThreeDSecureLookup(val transactionId: String?, val payload: String?, val acsUrl: String?, val version: String) : Parcelable

ThreeDSecureParams

data class ThreeDSecureParams : AirwallexModel, Parcelable

TrackerRequest

data class TrackerRequest : AirwallexRequestModel, Parcelable

TransactionMode

enum TransactionMode : Enum<TransactionMode>

VerifyPaymentConsentParams

data class VerifyPaymentConsentParams(val clientSecret: String, val paymentConsentId: String, val amount: BigDecimal? = null, val currency: String? = null, val cvc: String? = null, val paymentMethodType: String, val returnUrl: String? = null)

The params that used for verify PaymentConsent

WeChat

data class WeChat(val appId: String?, val partnerId: String?, val prepayId: String?, val package: String?, val nonceStr: String?, val timestamp: String?, val sign: String?) : AirwallexModel, Parcelable

WeChat Pay Payments

Functions

getUrl

fun Options.getUrl(): String

toAirwallexHttpRequest

fun Options.toAirwallexHttpRequest(): AirwallexHttpRequest