Sign in
api

Post POS checkout details

post/api/pos/{id}/checkout/{checkoutId}/details

Path parameters

idstring required
checkoutIdstring required

Request body

secretstring required

The secret token of the checkout

companystring nullable

The company name for this checkout

prenamestring nullable

The first name for this checkout

lastnamestring nullable

The last name for this checkout

emailstring email

The email for this checkout

phonestring nullable

The phone number for this checkout

streetstring nullable

The street address for this checkout

line2string nullable

Additional address line for this checkout

postalstring nullable

The postal code for this checkout

citystring nullable

The city for this checkout

countrystring nullable

The country for this checkout

statestring nullable

The state for this checkout

extraFieldsobject

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 19 revisions of this API.212

  • 36be0dca14e722See the full diff
    • ▲

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

      request-property-one-of-removed

    • ▲

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

      response-property-one-of-added

    • ○

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

      request-property-one-of-added

    • ○

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

      response-property-one-of-removed

  • bafd26ef1fbe1See the full diff
    • ●

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

      response-property-enum-value-added