Reader | SumUp Developer

A physical card reader device that can accept in-person payments.

Fields

idstringrequired
minLength: 30maxLength: 30
Unique identifier of the reader that the payment is initiated on.

Example: "rdr_3MSAFM23CK82VSTT4BN6RWSQ65"
namestringrequired
maxLength: 500
Custom human-readable, user-defined name for easier identification of the reader.

Example: "Frontdesk"
statusstringrequired
Options:"unknown""processing""paired""expired"
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.
Example: "paired"
deviceobjectrequired
Information about the underlying physical device.
Show 2 properties
- identifierstringrequired
  A unique identifier of the physical device (e.g. serial number).
  
  Example: "U1DT3NA00-CN"
- modelstringrequired
  Options:"solo""virtual-solo"
  Identifier of the model of the device.
  
  Example: "solo"
created_atstringrequired
format: date-time
The timestamp of when the reader was created.

Example: "2023-01-18T15:16:17Z"
updated_atstringrequired
format: date-time
The timestamp of when the reader was last updated.

Example: "2023-01-20T15:16:17Z"
metadataobject
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.

Example: {}
service_account_idstring
format: uuid
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.