YOyoco
Card machines

Fetch a card machine

Fetch a card machine

Required scope: business/devices:read

get/v1/card_machines/{card_machine_id}

Request

  • Base URL
    https://api.yoco.com
  • Auth
    HTTP bearer

Path parameters

card_machine_idstring required

The unique identifier of the card machine.

Response

Successful Response

idstring required

The unique identifier of the card machine.

nicknamestring nullable required

A human-friendly name given to the card machine, if one has been set.

serial_numberstring required

The serial number of the card machine.

stocked_atstring date-time nullable required

The date and time the card machine entered stock in ISO 8601 format. null when the stock date is not known.

created_atstring date-time required

The card machine creation date and time in ISO 8601 format.

updated_atstring date-time required

The date and time the card machine was last modified in ISO 8601 format.

Example response

{
  "allocation": {
    "allocated_at": "2024-03-15T09:12:44+02:00",
    "condition": "refurbished"
  },
  "created_at": "2024-11-19T15:27:02+00:00",
  "id": "1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4",
  "nickname": "Front counter",
  "serial_number": "S1F2102000123",
  "stocked_at": "2024-02-01T00:00:00+02:00",
  "updated_at": "2024-11-19T16:27:23+00:00"
}

Changes