HEheylight
api

Send SMS OTP

Headless checkouts only. This is a non-standard endpoint for headless integrations where the merchant drives phone verification server-to-server. In a typical hosted checkout the customer completes phone verification themselves and this endpoint must not be used.

Triggers an SMS one-time password to the customer's phone number on record for the given contract.

post/api/checkout/v1/otp/send/

Request

Request body

external_contract_uuidstring uuid required

The external contract UUID of the application to send the OTP for

Response

successboolean required

Whether the OTP was sent

messagestring required

Status message describing the result

external_contract_uuidstring uuid required

The external contract UUID that was processed

Changes

No recorded changes to this operation across all 2 revisions of this API.