Interface Withdrawal

Customer withdrawal information.

interface Withdrawal {
    accountId: string;
    action?: PaymentAction;
    amount: number;
    creationTime: string;
    currencyCode: string;
    customerId: string;
    deviceInfo?: DeviceInfo;
    expirationTime?: string;
    fee?: number;
    fees?: SimpleFeePayment[];
    fundingTransactionId?: string;
    id: string;
    merchantRefNum?: string;
    paymentInstrumentReference?: PaymentInstrumentReference;
    paymentOption: PaymentOptionType;
    paymentProperties?: PaymentProperty[];
    scaDetails?: ScaAuthenticationEventResponse;
    slipId?: string;
    status: PaymentStatus;
    statusReason?: string;
}

Properties

accountId action? amount creationTime currencyCode customerId deviceInfo? expirationTime? fee? fees? fundingTransactionId? id merchantRefNum? paymentInstrumentReference? paymentOption paymentProperties? scaDetails? slipId? status statusReason?

Properties

accountId

accountId: string

Account id.

Optional action

action?: PaymentAction

Payment action.

amount

amount: number

Withdrawal amount in currency minor units.

creationTime

creationTime: string

Creation time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

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

currencyCode

currencyCode: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

customerId

customerId: string

Customer id.

Optional deviceInfo

deviceInfo?: DeviceInfo

Device information.

Optional expirationTime

expirationTime?: string

Expiration time.

Format should be ISO 8601 in UTC. Represents RFC 3339, section 5.6 date-time.

Example

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

Optional fee

fee?: number

Deprecated

Use fees instead.

Merchant fee to apply to deposit in minor currency units.

Optional fees

fees?: SimpleFeePayment[]

Customer fees attached to the transaction.

Optional fundingTransactionId

fundingTransactionId?: string

Withdrawal funding transaction id.

id

id: string

Withdrawal id generated during creation.

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 scaDetails

scaDetails?: ScaAuthenticationEventResponse

SCA details.

Optional slipId

slipId?: string

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

status

status: PaymentStatus

Payment status.

Optional statusReason

statusReason?: string

Status reason for FAILED transaction.

Settings

Member Visibility

Theme

On This Page

accountIdactionamountcreationTimecurrencyCodecustomerIddeviceInfoexpirationTimefeefeesfundingTransactionIdidmerchantRefNumpaymentInstrumentReferencepaymentOptionpaymentPropertiesscaDetailsslipIdstatusstatusReason