Sign in
Readers

Update a Reader

Update a Reader.

patch/v0.1/merchants/{merchant_code}/readers/{id}

Path parameters

merchant_codestring required
Example:MC0X0ABC

Unique identifier of the merchant account.

idstring required

Unique identifier of the object. Note that this identifies the instance of the physical devices pairing with your SumUp account. If you DELETE a reader, and pair the device again, the ID will be different. Do not use this ID to refer to a physical device.

Example:rdr_3MSAFM23CK82VSTT4BN6RWSQ65

The unique identifier of the reader.

Request body

namestring

Custom human-readable, user-defined name for easier identification of the reader.

metaMeta

Set of user-defined key-value pairs attached to the object.

Example request

{
  "name": "Frontdesk",
  "meta": {}
}

Response

Returns the updated Reader object if the update succeeded.

idstring required

Unique identifier of the object. Note that this identifies the instance of the physical devices pairing with your SumUp account. If you DELETE a reader, and pair the device again, the ID will be different. Do not use this ID to refer to a physical device.

namestring required

Custom human-readable, user-defined name for easier identification of the reader.

status'unknown' | 'processing' | 'paired' | 'expired' required

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
metaMeta

Set of user-defined key-value pairs attached to the object.

created_atstring date-time required

The timestamp of when the reader was created.

updated_atstring date-time required

The timestamp of when the reader was last updated.

Example response

{
  "id": "rdr_3MSAFM23CK82VSTT4BN6RWSQ65",
  "name": "Frontdesk",
  "status": "paired",
  "device": {
    "identifier": "U1DT3NA00-CN",
    "model": "solo"
  },
  "meta": {},
  "created_at": "2023-01-18T15:16:17Z",
  "updated_at": "2023-01-20T15:16:17Z"
}

Changes