Devices

Get devices for the current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/pay-api/v1/devices
Request samples
Response samples
application/json
{
  • "devices": [
    ]
}

Create or update device by id for the current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
Request Body schema: application/json
deviceId
string or null

Device Id

deviceName
string or null

Device name

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/pay-api/v1/devices
Request samples
application/json
{
  • "deviceId": "string",
  • "deviceName": "string"
}
Response samples
application/json
{
  • "deviceId": "string"
}

Get device by Id for the current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
deviceId
required
string <uuid>
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

get/pay-api/v1/devices/{deviceId}
Request samples
Response samples
application/json
{
  • "deviceId": "string",
  • "deviceName": "string",
  • "lastLoginAt": "2019-08-24T14:15:22Z",
  • "tapToPayStatus": "string",
  • "tapToPayStatusId": 0,
  • "tapToPayEnabled": true,
  • "userProfiles": [
    ]
}

Generate Tap To Pay Jwt token by device id for the current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
Request Body schema: application/json
deviceId
string or null

Device Id

Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/pay-api/v1/devices/tap-to-pay/jwt
Request samples
application/json
{
  • "deviceId": "string"
}
Response samples
application/json
{
  • "jwtToken": "string",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Activates Tap To Pay functionality for the specified device for the current merchant.

SecurityBearer or Bearer or Bearer or Bearer
Request
path Parameters
deviceId
required
string <uuid>
Responses
200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

post/pay-api/v1/devices/{deviceId}/tap-to-pay/activate
Request samples
Response samples
application/json
{
  • "errors": {
    },
  • "details": "Validation failed: \n -- Email: 'Email' is not a valid email address. Severity: Error",
  • "statusCode": 400,
  • "source": "<Service>",
  • "exceptionType": "FluentValidation.ValidationException",
  • "correlationId": "aa6cfcd0-0295-4a4c-b074-8c901f114fee",
  • "entityId": null,
  • "errorCode": null
}