Interface CustomerTransfer

Contains information about a transfer.

interface CustomerTransfer {
    action?: PaymentAction;
    amount: number;
    creationTime: string;
    currencyCode: string;
    deviceInfo?: DeviceInfo;
    expirationTime?: string;
    fees?: SimpleFeePayment[];
    fxAmount?: FxAmount;
    fxQuote?: string;
    id: string;
    merchantRefNum?: string;
    nextStatus?: PaymentStatus[];
    recipient?: CustomerTransferRecipient;
    scaDetails?: ScaAuthenticationEventResponse;
    slipId?: string;
    status: PaymentStatus;
    transferDetails: TransferDetails;
}

Properties

action? amount creationTime currencyCode deviceInfo? expirationTime? fees? fxAmount? fxQuote? id merchantRefNum? nextStatus? recipient? scaDetails? slipId? status transferDetails

Properties

Optional action

action?: PaymentAction

Specifies the action required to complete in order to proceed to the next payment status.

amount

amount: number

The transfer amount in minor currency units.

creationTime

creationTime: string

Time of transfer creation. Format should be ISO 8601 in UTC.

Example

"2024-05-08T14:43:33Z"

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 expirationTime

expirationTime?: string

Time of transfer expiration. Format should be ISO 8601 in UTC.

Example

"2024-05-08T14:43:33Z"

Optional fees

fees?: SimpleFeePayment[]

Fees, applied to the transfer.

Optional fxAmount

fxAmount?: FxAmount

The amount in converted currency during currency conversion.

Optional fxQuote

fxQuote?: string

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

id

id: string

The transfer id, used for further transfer update requests.

Optional merchantRefNum

merchantRefNum?: string

The merchant reference number associated with the transaction.

Optional nextStatus

nextStatus?: PaymentStatus[]

Provides the next possible status update that the client can request, depending on the transfer state.

Optional recipient

recipient?: CustomerTransferRecipient

The transfer recipient.

Optional scaDetails

scaDetails?: ScaAuthenticationEventResponse

SCA authentication details.

Optional slipId

slipId?: string

The internal transaction slip identifier for the transfer.

status

status: PaymentStatus

The current transfer status.

transferDetails

transferDetails: TransferDetails

The transfer details, including the transfer reason.

Settings

Member Visibility

Theme

On This Page

actionamountcreationTimecurrencyCodedeviceInfoexpirationTimefeesfxAmountfxQuoteidmerchantRefNumnextStatusrecipientscaDetailsslipIdstatustransferDetails