Device

Generate device activation code

Generates a one-time, 6-digit verification code for activating a semi-integrated card-present device in a paypoint. This endpoint is for AXIUM devices only. 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.

post/Device/challenge/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/Device/challenge/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The paypoint's entrypoint identifier. Learn more

Response

Success

responseCodeinteger

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

roomIdinteger

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

isSuccessboolean

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

responseTextstring required

Response text for operation: 'Success' or 'Declined'.

Changes

No recorded changes to this operation across all 1 revision of this API.