Interface WithdrawalRequest

Represents the request for initiating withdrawal.

interface WithdrawalRequest {
    amount: number;
    currencyCode: string;
    deviceInfo?: DeviceInfo;
    merchantRefNum?: string;
    paymentInstrumentReference?: PaymentInstrumentReference;
    paymentOption: PaymentOptionType;
    paymentProperties?: PaymentProperty[];
}

Properties

amount currencyCode deviceInfo? merchantRefNum? paymentInstrumentReference? paymentOption paymentProperties?

Properties

amount

amount: number

withdrawal amount in currency minor units.

currencyCode

currencyCode: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional deviceInfo

deviceInfo?: DeviceInfo

Device information.

Optional merchantRefNum

merchantRefNum?: string

This is the merchant reference number created by the merchant and submitted as part of the request. It must be unique for each request and allows cross referencing objects from merchant system to embedded wallet objects.

Optional paymentInstrumentReference

paymentInstrumentReference?: PaymentInstrumentReference

The payment instrument reference.

paymentOption

paymentOption: PaymentOptionType

The payment option.

Optional paymentProperties

paymentProperties?: PaymentProperty[]

Payment properties.

Settings

Member Visibility

Theme

On This Page

amountcurrencyCodedeviceInfomerchantRefNumpaymentInstrumentReferencepaymentOptionpaymentProperties