Interface CustomerTransferRequest

Request for a transfer between customers or a currency exchange.

interface CustomerTransferRequest {
    amount: number;
    currencyCode: string;
    deviceInfo?: DeviceInfo;
    fxQuote?: string;
    merchantRefNum?: string;
    recipient: CustomerTransferRecipient;
    transferDetails: RequestTransferDetails | TransferDetails;
}

Properties

amount currencyCode deviceInfo? fxQuote? merchantRefNum? recipient transferDetails

Properties

amount

amount: number

The amount to be transferred in major units.

currencyCode

currencyCode: string

The transfer currency. Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional deviceInfo

deviceInfo?: DeviceInfo

Information about the device that the end-customer uses to access the service.

Optional fxQuote

fxQuote?: string

The Id of the FxRate quote to be used, if the transfer is an exchange.

Optional merchantRefNum

merchantRefNum?: string

The merchant reference number associated with the transaction.

recipient

recipient: CustomerTransferRecipient

The transfer recipient.

transferDetails

transferDetails: RequestTransferDetails | TransferDetails

The transfer details, including the transfer reason.

The usage of TransferDetails is deprecated for this property. Use RequestTransferDetails instead.

Settings

Member Visibility

Theme

On This Page

amountcurrencyCodedeviceInfofxQuotemerchantRefNumrecipienttransferDetails