POST /api/checkout/{id}/confirmation-sms

api

checkout

Send a confirmation SMS for a checkout

post/api/checkout/{id}/confirmation-sms

Path parameters

idstring required

The ID of the checkout.

Request body

phonestring nullable

The target phone number where the SMS should be sent to

Response

_idstring required

The ID of the checkout.

secretstring required

The secret token of the checkout.

status'NEW' | 'ABORTED' | 'COMPLETE' required

The status of the checkout.

The type of the checkout.

companystring

The company name of the checkout's customer.

firstnamestring

The first name of the checkout's customer.

lastnamestring

The last name of the checkout's customer.

namestring

The full name of the checkout's customer.

emailstring email

The email of the checkout's customer.

phonestring

The phone number of the checkout's customer.

customerIdstring

The ID of the customer.

sellerIdstring required

The ID of the seller of the checkout.

realPricenumber float required

The calculated real price of the checkout.

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK'

An ISO 4217 3-character code of the currency.

preferredLanguage'de' | 'de-CH' | 'en' | 'en-GB' | 'en-AU' | 'fr' | 'es' | 'es-MX' | 'is' | 'it' | 'ru' | 'pt' | 'tr' | 'nb' | 'nl' | 'pl' | 'sv' | 'sl' | 'da' | 'cs' | 'lv' | 'he' | 'ar' | 'th' | 'ko' | 'ja' | 'zh-TW'

The prefered language of the checkout.

origin'yourticket' | 'pos' | 'rebooking' | 'upgrade' | 'subscription'

The origin of the checkout.

channel'online' | 'internal' | 'pos'

The channel of the checkout.

salesChannelIdstring

The ID of the sales channel of the checkout.

posIdstring

The ID of the POS which created the checkout.

userIdstring

The ID of the user who created the checkout.

extraFieldsobject

An object containing key-value information.

expiresAtstring date-time

An ISO Timestamp indicating when the checkout will expire.

createdAtstring date-time

An ISO timestamp indicating when the checkout was created.

updatedAtstring date-time

An ISO timestamp indicating when the checkout was last updated.

Example response

{
  "type": "transaction"
}

Changes

Changed in 4 of the 35 revisions of this API.1421

Sep 24, 20262f523efe55e21See the full diff
- ●
  added the new reservation enum value to the response property for the response status
  response-property-enum-value-added
Sep 21, 202654ee7c45865f40See the full diff
- ●
  added the new onFreeCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreePosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreePosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreePosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreePosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onFreeTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onKioskTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosCart enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onPosTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onSeasonTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onSeasonTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onSeasonTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onSeasonTicket enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onTicketCustom enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onTicketCustom enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onTicketCustom enum value to the ///// response property for the response status
  response-property-enum-value-added
- ●
  added the new onTicketCustom enum value to the ///// response property for the response status
  response-property-enum-value-added
Aug 21, 202636be0dca14e711See the full diff
- ▲
  added subschema #1 subschema #2 to the / response property oneOf list for the response status
  response-property-one-of-added
- ○
  removed subschema #1 subschema #2 from the / response property oneOf list for the response status
  response-property-one-of-removed
Aug 11, 2026bafd26ef1fbe1See the full diff
- ●
  added the new MWK enum value to the response property for the response status
  response-property-enum-value-added

Full history