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

    Interface CustomerDeposit

    Customer deposit information.

    interface CustomerDeposit {
        accountId: string;
        action?: PaymentAction;
        amount: number;
        creationTime: string;
        currencyCode: string;
        customerId: string;
        deviceInfo?: DeviceInfo;
        expirationTime?: string;
        fees?: SimpleFeePayment[];
        fundingTransactionId?: string;
        id: string;
        merchantRefNum?: string;
        nextStatus?: PaymentStatus[];
        paymentInstrumentReference?: PaymentInstrumentReference;
        paymentOption: PaymentOptionType;
        paymentProperties?: PaymentProperty[];
        redirectUrl?: RedirectLink;
        returnUrls?: ReturnLink[];
        slipId?: string;
        status: PaymentStatus;
        statusReason?: string;
    }
    Index

    Properties

    accountId action? amount creationTime currencyCode customerId deviceInfo? expirationTime? fees? fundingTransactionId? id merchantRefNum? nextStatus? paymentInstrumentReference? paymentOption paymentProperties? redirectUrl? returnUrls? slipId? status statusReason?

    Properties

    accountId: string

    The account where the money gets deposited in. It deduced based on the currency.

    action?: PaymentAction

    Specifies action required to complete to be able to continue to the next payment status.

    amount: number

    Deposit 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

    Deposit Funding transaction id. Stored by Single API and used for Recon.

    id: string

    Deposit id generated during creation.

    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.

    nextStatus?: PaymentStatus[]

    Next possible status.

    paymentInstrumentReference?: PaymentInstrumentReference

    Payment instrument reference.

    paymentOption: PaymentOptionType

    Payment option type.

    paymentProperties?: PaymentProperty[]

    List of payment option specific properties.

    redirectUrl?: RedirectLink

    Link used to redirect the payment flow to hosted payment page.

    returnUrls?: ReturnLink[]

    Links to redirect customer back during transaction flow.

    slipId?: string

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

    status: PaymentStatus

    Payment status.

    statusReason?: string

    Status reason for FAILED transaction.

    Settings

    Member Visibility

    On This Page

    Properties