core/com.paysafe.wallet.android.core.withdrawals.model/Withdrawal

Withdrawal

data class Withdrawal(val amount: Long, val currencyCode: String, val paymentOption: PaymentOptionType, val paymentInstrumentReference: PaymentInstrumentReference?, val merchantRefNum: String?, val paymentProperties: List<PaymentProperty>, val id: String, val accountId: String, val customerId: String, val creationTime: Calendar, val expirationTime: Calendar?, val foundingTransactionId: String?, val slipId: String?, val status: PaymentStatus, val statusReason: String?, val fees: List<SimpleFeePayment>, val nextStatus: List<PaymentStatus>, val action: PaymentCompletionAction?, val scaDetails: ScaAuthenticationEventResponse?, val type: PaymentType?, val description: String?, val recipientReference: String?)

Data class representing a Withdrawal object.

Constructors

Withdrawal

constructor(amount: Long, currencyCode: String, paymentOption: PaymentOptionType, paymentInstrumentReference: PaymentInstrumentReference?, merchantRefNum: String?, paymentProperties: List<PaymentProperty>, id: String, accountId: String, customerId: String, creationTime: Calendar, expirationTime: Calendar?, foundingTransactionId: String?, slipId: String?, status: PaymentStatus, statusReason: String?, fees: List<SimpleFeePayment>, nextStatus: List<PaymentStatus>, action: PaymentCompletionAction?, scaDetails: ScaAuthenticationEventResponse?, type: PaymentType?, description: String?, recipientReference: String?)

Properties

accountId

val accountId: String

Account id.

action

val action: PaymentCompletionAction?

The action required to complete to be able to continue to the next payment status.

amount

val amount: Long

Amount of the withdrawal.

creationTime

val creationTime: Calendar

The time the withdrawal was created in the form of Calendar.

currencyCode

val currencyCode: String

Currency alphabetic code as specified by ISO 4217.

customerId

val customerId: String

Customer id.

description

val description: String?

Description of the payment.

expirationTime

val expirationTime: Calendar?

The time the withdrawal expires in the form of Calendar.

fees

val fees: List<SimpleFeePayment>

Customer fees attached to the transaction.

foundingTransactionId

val foundingTransactionId: String?

Founding transaction id.

val id: String

The Digital Wallet preview id.

merchantRefNum

val merchantRefNum: String?

Merchant Reference Id. Identifier of transaction at merchant side.

nextStatus

val nextStatus: List<PaymentStatus>

The next possible status update the client can request, depending on the chosen payment type and option.

paymentInstrumentReference

val paymentInstrumentReference: PaymentInstrumentReference?

Payment instrument reference of the withdrawal.

paymentOption

val paymentOption: PaymentOptionType

Enumeration of supported Payment Option Types

paymentProperties

val paymentProperties: List<PaymentProperty>

Additional payment configuration properties.

recipientReference

val recipientReference: String?

Withdrawal recipient id of ACTIVE withdrawal recipient for THIRD_PARTY withdrawals. If not specified during THIRD_PARTY Withdrawal creation, the withdrawal recipient must be specified during the first withdrawal step.

scaDetails

val scaDetails: ScaAuthenticationEventResponse?

SCA authentication details, including information about the authentication process.

slipId

val slipId: String?

Slip identifier. Slip contains list of transactions associated with the withdrawal operations.

status

val status: PaymentStatus

Payment status.

statusReason

val statusReason: String?

Status reason for FAILED transaction.

type

val type: PaymentType?

Type of the payment.