TapToPay

Generate Tap to Pay activation code

Issues a short-lived activation code for a Tap to Pay device in the Pending state. This endpoint is for Tap to Pay devices only. Deliver the code to the device to complete activation.

A code is valid for 30 minutes after it's issued. Calling this endpoint again for the same device before the code expires returns the same code, with alreadyIssued set to true, instead of generating a new one. A new code is only generated when no valid code exists.

Authenticate with an OAuth2 bearer token that has the pos_create permission. See Accept Tap to Pay payments for the full integration guide.

post/v2/device/taptopay/activate/challenge

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/v2/device/taptopay/activate/challenge
  • Auth: HTTP bearer

Request body

entrystring required

The entity's entrypoint identifier. Learn more.

deviceIdstring required

The device identifier (poiId) returned when the device was registered.

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.