sumup-php/src/Types/Reader.php at c567afe9e1bbff201219969038a5670fc52a5202 · sumup/sumup-php · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<?php

declare(strict_types=1);

namespace SumUp\Types;

/**
 * A physical card reader device that can accept in-person payments.
 */
class Reader
{
    /**
     * Unique identifier of the object.
     * Note that this identifies the instance of the physical devices pairing with your SumUp account. If you [delete](https://developer.sumup.com/api/readers/delete-reader) a reader, and pair the device again, the ID will be different. Do not use this ID to refer to a physical device.
     *
     * @var string
     */
    public string $id;

    /**
     * Custom human-readable, user-defined name for easier identification of the reader.
     *
     * @var string
     */
    public string $name;

    /**
     * The status of the reader object gives information about the current state of the reader.
     * Possible values:
     * - `unknown` - The reader status is unknown.
     * - `processing` - The reader is created and waits for the physical device to confirm the pairing.
     * - `paired` - The reader is paired with a merchant account and can be used with SumUp APIs.
     * - `expired` - The pairing is expired and no longer usable with the account. The resource needs to get recreated.
     *
     * @var ReaderStatus
     */
    public ReaderStatus $status;

    /**
     * Information about the underlying physical device.
     *
     * @var ReaderDevice
     */
    public ReaderDevice $device;

    /**
     * Set of user-defined key-value pairs attached to the object. Partial updates are not supported. When updating, always submit whole metadata. Maximum of 64 parameters are allowed in the object.
     *
     * @var array|null
     */
    public ?array $metadata = null;

    /**
     * Identifier of the system-managed service account associated with this reader.
     * Present only for readers that are already paired.
     * This field is currently in beta and may change.
     *
     * @var string|null
     */
    public ?string $serviceAccountId = null;

    /**
     * The timestamp of when the reader was created.
     *
     * @var string
     */
    public string $createdAt;

    /**
     * The timestamp of when the reader was last updated.
     *
     * @var string
     */
    public string $updatedAt;

}