capacitor-stripe-terminal
    Preparing search index...

    Interface Reader

    interface Reader {
        availableUpdate?: ReaderSoftwareUpdate | null;
        baseUrl?: string | null;
        batteryLevel: number | null;
        batteryStatus: BatteryStatus;
        bootloaderVersion?: string | null;
        configVersion?: string | null;
        deviceSoftwareVersion: string | null;
        deviceType: DeviceType;
        emvKeyProfileId?: string | null;
        firmwareVersion?: string | null;
        hardwareVersion?: string | null;
        id: string | null;
        ipAddress: string | null;
        isAvailableUpdate?: boolean;
        isCharging: boolean | null;
        label: string | null;
        livemode?: boolean;
        location?: Location | null;
        locationId: string | null;
        locationStatus: LocationStatus;
        macKeyProfileId?: string | null;
        pinKeyProfileId?: string | null;
        pinKeysetId?: string | null;
        serialNumber: string;
        settingsVersion?: string | null;
        simulated: boolean;
        status: ReaderNetworkStatus;
        stripeId: string | null;
        trackKeyProfileId?: string | null;
    }
    Index
    availableUpdate?: ReaderSoftwareUpdate | null

    The available update, if any.

    baseUrl?: string | null

    The base URL the reader communicates with. (Android only.)

    batteryLevel: number | null

    The reader's battery level, represented as a boxed float in the range [0, 1]. If the reader does not have a battery, or the battery level is unknown, this value is null. (Bluetooth readers only.)

    batteryStatus: BatteryStatus

    The reader's battery status. Usable as a general classification for the current battery state.

    bootloaderVersion?: string | null

    The reader's bootloader version. (Android only.)

    configVersion?: string | null

    The reader's current config version. (Android only.)

    deviceSoftwareVersion: string | null

    The reader's current device software version, or null if this information is unavailable.

    deviceType: DeviceType

    The reader's device type.

    emvKeyProfileId?: string | null

    The reader's EMV key profile ID. (Android only.)

    firmwareVersion?: string | null

    The reader's current firmware version. (Android only.)

    hardwareVersion?: string | null

    The reader's hardware version. (Android only.)

    id: string | null

    The Stripe unique identifier for the reader.

    ipAddress: string | null

    The IP address of the reader. (Internet reader only.)

    isAvailableUpdate?: boolean

    True if there is an available update.

    isCharging: boolean | null

    The reader's charging state, represented as a boolean. If the reader does not have a battery, or the battery level is unknown, this value is null. (Bluetooth readers only.)

    label: string | null

    A custom label that may be given to a reader for easier identification. (Verifone P400 only.)

    livemode?: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    location?: Location | null

    The Location this reader is registered to, when the full object is available.

    locationId: string | null

    The ID of the reader’s Location.

    Internet readers remain registered to the location specified when registering the reader to your account. For internet readers, this field represents that location. If you need to change your internet reader's location, re-register the reader and specify the new location id in the location param. See https://stripe.com/docs/api/terminal/readers/create

    Bluetooth readers are designed to be more mobile and must be registered to a location upon each connection. For Bluetooth readers, this field represents the last location that the reader was registered to. If the reader has not been used before, this field will be nil. If you associate the reader to a different location while calling connectBluetoothReader, this field will update to that new location's ID.

    locationStatus: LocationStatus

    Used to tell whether the location field has been set. Note that the Verifone P400 and simulated readers will always have an unknown locationStatus. (Chipper 2X BT and WisePad 3 only.)

    macKeyProfileId?: string | null

    The reader's MAC key profile ID. (Android only.)

    pinKeyProfileId?: string | null

    The reader's PIN key profile ID. (Android only.)

    pinKeysetId?: string | null

    The reader's PIN keyset ID. (Android only.)

    serialNumber: string

    The reader's serial number.

    settingsVersion?: string | null

    The reader's settings version. (Android only.)

    simulated: boolean

    True if this is a simulated reader.

    DiscoveryConfiguration objects with simulated = true produce simulated Readers.

    The networking status of the reader: either offline or online. Note that the Chipper 2X and the WisePad 3's statuses will always be offline. (Verifone P400 only.)

    stripeId: string | null

    The Stripe unique identifier for the reader.

    Use id instead. This will be removed in v6.

    trackKeyProfileId?: string | null

    The reader's track key profile ID. (Android only.)