@paysafe/paysafe-wallet-saas-web
    Preparing search index...

    Interface Withdrawal

    Customer withdrawal information.

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

    Properties

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

    Properties

    accountId: string

    Account id.

    action?: PaymentAction

    Payment action.

    amount: number

    Withdrawal amount in currency minor units.

    creationTime: string

    Creation time.

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

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

    Currency alphabetic code as specified by ISO 4217.

    "EUR"
    customerId: string

    Customer id.

    deviceInfo?: DeviceInfo

    Device information.

    expirationTime?: string

    Expiration time.

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

    "2024-05-08T14:43:33Z"
    fees?: SimpleFeePayment[]

    Customer fees attached to the transaction.

    fundingTransactionId?: string

    Withdrawal funding transaction id.

    id: string

    Withdrawal id generated during creation.

    instrumentValidationRules?: InstrumentValidationRule[]

    Instrument validation rules.

    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.

    paymentInstrumentReference?: PaymentInstrumentReference

    Payment instrument reference.

    paymentOption: PaymentOptionType

    Payment option type.

    paymentProperties?: PaymentProperty[]

    List of payment option specific properties.

    scaDetails?: ScaAuthenticationEventResponse

    SCA details.

    slipId?: string

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

    status: PaymentStatus

    Payment status.

    statusReason?: string

    Status reason for FAILED transaction.

    Settings

    Member Visibility

    On This Page

    Properties