Sign in
api
checkout

Post checkout details

post/api/checkout/{id}/details

Path parameters

idstring required

Request body

secretstring required

The secret token of the checkout

companystring nullable

The company name for this checkout

prenamestring required

The first name for this checkout

lastnamestring required

The last name for this checkout

streetstring nullable
postalstring nullable
citystring nullable
countrystring nullable
statestring nullable
emailstring email required

The email for this checkout

emailRepeatstring email required
phonestring nullable

The phone number for this checkout

passwordstring nullable

If createAccount = true. The password to create the account with

passwordRepeatstring nullable

deprecated, unused

createAccountboolean

Whether to create an account with the provided data. Deprecated, accounts should be created and verified beforehand.

extraFieldsobject
itemConsentsobject

A map of item IDs and their lists of consents

Response

OK

_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.

type'transaction' | 'upgrade' | 'rebooking' | 'purchaseintent' | 'subscription' required

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 2 of the 14 revisions of this API.212

  • 36be0dca14e722See the full diff
    • ▲

      removed subschema #1 subschema #2 from the identification/items/ request property oneOf list

      request-property-one-of-removed

    • ▲

      added subschema #1 subschema #2 to the identification/items/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added subschema #1 subschema #2 to the identification/items/ request property oneOf list

      request-property-one-of-added

    • ○

      removed subschema #1 subschema #2 from the identification/items/ response property oneOf list for the response status 200

      response-property-one-of-removed

  • bafd26ef1fbe1See the full diff
    • ●

      added the new MWK enum value to the currency response property for the response status 200

      response-property-enum-value-added