Skip to content

Devices

Devices are the mobile phones and tablets merchants register to accept Tap to Pay payments.

Each device record tracks a device name, its last login time, and the API key used to activate it. A device also carries a Tap to Pay status, which controls it can process contactless card payments. That status moves through five states: Inactive, Requested, Approved, Active, and Denied.

The Devices endpoints support listing devices, registering them, and activating Tap to Pay on each one. A merchant can list all registered devices or retrieve a single device by its identifier. Registering a device requires only a device ID and a device name. A separate endpoint activates Tap to Pay, and another generates the token a device needs to process a transaction.

  • GET /pay-api/v1/devices. Lists every device currently registered to the merchant account.
  • GET /pay-api/v1/devices/{deviceId}. Retrieves a single device by its identifier.
  • POST /pay-api/v1/devices. Creates a new device, or updates an existing one, by device ID.
  • POST /pay-api/v1/devices/{deviceId}/tap-to-pay/activate. Activates the Tap to Pay feature on that specific device.
  • POST /pay-api/v1/devices/tap-to-pay/jwt. Generates the token a device needs to process a Tap to Pay transaction.
Operations

Retrieves devices

Request

GET {{baseURL}}/pay-api/v1/devices

This endpoint retrieves the list of registered devices.

See Also:
To create or update a device, see POST /pay-api/v1/devices.
To generate a tap-to-pay token for a device, see POST /pay-api/v1/devices/tap-to-pay/jwt.
To retrieve a device by ID, see GET /pay-api/v1/devices/{deviceId}.
To activate tap-to-pay for a device, see POST /pay-api/v1/devices/{deviceId}/tap-to-pay/activate.

Security
Bearer
curl -i -X GET \
  https://developer.flute.com/_mock/api-reference/pay-api/v1/devices \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
devicesArray of objects or null

Indicates a list of devices associated with the current merchant.

Response
{
  "devices": [
    {
      "deviceId": "7aafd09f-b3e6-43fb-b815-5db3bf7f1451",
      "deviceName": "iPhone12,1",
      "lastLoginAt": "2026-01-19T14:27:02.767105Z",
      "apiKeyName": "Peppared's Cafe Key",
      "tapToPayStatus": "Active",
      "tapToPayStatusId": 2,
      "tapToPayEnabled": true,
      "userProfiles": [
        {
          "id": "04103b7f-c2fc-444b-b1ab-93eee3aec815",
          "firstName": "Alexandro",
          "lastName": "Peppared",
          "email": "peppared@example.com"
        }
      ]
    }
  ]
}