Interface CustomerDepositRequest

Represents the request for initiating customer facing deposit.

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

Properties

amount currencyCode deviceInfo? merchantRefNum? paymentInstrumentReference? paymentOption paymentProperties? returnUrls?

Properties

amount

amount: number

Deposit 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

Payment instrument reference.

paymentOption

paymentOption: PaymentOptionType

Payment option type.

Optional paymentProperties

paymentProperties?: PaymentProperty[]

List of payment option specific properties.

Optional returnUrls

returnUrls?: ReturnLink[]

Links to redirect customer back during transaction flow.

Settings

Member Visibility

Theme

On This Page

amountcurrencyCodedeviceInfomerchantRefNumpaymentInstrumentReferencepaymentOptionpaymentPropertiesreturnUrls