api
checkouts

Create a checkout

post/api/checkouts

Request

  • Base URL: https://vivenu.com
  • URL: https://vivenu.com/api/checkouts
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Request body

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

The type of the checkout.

eventIdstring required

The ID of the event to create the checkout item for.

couponsstring[]

An array of coupon codes to apply to the checkout item.

vouchersstring[]

An array of voucher codes to be redeemed through the checkout.

shopIdstring

The ID of the secret shop to create the checkout item for.

seatingReservationTokenstring

The reservation token of the selected seats.

channelIdstring

The ID of the channel to create the checkout item for.

salesChannelIdstring required

The ID of the sales channel to create the checkout item for.

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' nullable

The preferred language of the package checkout

metaobject

Custom key-value data. Metadata is useful for storing additional, structured information on an object.

customerIdstring
contractTypeIdstring

The id of the contract type

redirectUrlstring uri

Absolute https URL the hosted checkout redirects the buyer to when the checkout ends (completed, expired or left). The host must be on the seller's redirectUrlHosts allow-list. checkoutId, secret and status are appended as query parameters; always verify the checkout status via the API, the redirect itself is not proof of success.

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' | 'reservation' | '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.

redirectUrlstring

The URL the hosted checkout redirects the buyer to when the checkout ends, if one was set on creation.

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

    • breaking

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

    • info

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

    • info

      added the new optional request property

    • info

      added the media type application/json for the response with the status