Generate Tap to Pay activation code

POST

/v2/device/taptopay/activate/challenge

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.

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](/guides/pay-in-developer-tap-to-pay) for the full integration guide.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

entrystringRequired

The entity’s entrypoint identifier. Learn more.

deviceIdstringRequired

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

Response

Success

responseTextstring

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

responseDataobject

The issued activation code, its expiration, and whether it was reused.

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

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error