SUsumup
Readers

Update a Reader

Changed on

Updates a reader's name or metadata and returns the updated reader.

Providing metadata replaces the entire metadata object; include all entries that should be retained. Omitted fields remain unchanged.

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

Request

  • Base URL
    https://api.sumup.com
  • URL
    https://api.sumup.com/v0.1/merchants/{merchant_code}/readers/{reader_id}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.sumup.com/authorize
      Token URL: https://api.sumup.com/token scopes: readers.write, terminals.write

Path parameters

merchant_codestring required
Example:MK10CL2A

Short unique identifier for the merchant.

reader_idstring required

Unique identifier of the reader that the payment is initiated on.

Example:rdr_3MSAFM23CK82VSTT4BN6RWSQ65

The unique identifier of the reader.

Request body

namestring

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

metadataMetadata

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 request

{
  "name": "Frontdesk",
  "metadata": {}
}

Response

Returns the updated Reader object if the update succeeded.

idstring required

Unique identifier of the reader that the payment is initiated on.

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.
metadataMetadata

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.

service_account_idstring 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.

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"
  },
  "metadata": {},
  "created_at": "2023-01-18T15:16:17Z",
  "updated_at": "2023-01-20T15:16:17Z"
}

Changes