Generate device activation code

POST

/Device/challenge/:entry

A code expires 5 minutes after it’s issued. A paypoint can have several codes active at once — for example, when activating a batch of devices — and a code binds to whichever device enters it first.

Authenticate with an OAuth2 Bearer token that has the device_registry scope.

Generates a one-time, 6-digit verification code for activating a semi-integrated card-present device in a paypoint. After calling this endpoint, an operator enters the returned code on the device's terminal, along with a device name, to register the device to the paypoint resolved from `{entry}`. A code expires 5 minutes after it's issued. A paypoint can have several codes active at once — for example, when activating a batch of devices — and a code binds to whichever device enters it first. Authenticate with an OAuth2 Bearer token that has the `device_registry` scope.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entrystringRequired

The paypoint’s entrypoint identifier. Learn more

Response

Success

responseTextstring

Response text for operation: ‘Success’ or ‘Declined’.

responseDataobject

The issued activation code and the time it expires.

responseCodeintegerOptional

Code for the response. Learn more in API Response Codes.

pageIdentifierstringOptional

Auxiliary validation used internally by payment pages and components.

roomIdlongOptional

Field not in use on this endpoint. It always returns 0.

isSuccessbooleanOptional

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Errors

401

Unauthorized Error

500

Internal Server Error

1	{
2	"responseText": "Success",
3	"responseData": {
4	"code": "748801",
5	"expiresAt": "2026-08-13T19:58:27.5860203Z"
6	},
7	"responseCode": 1,
8	"pageIdentifier": "",
9	"roomId": 0,
10	"isSuccess": true
11	}