POST /api/pos/:id/cancel/:transactionId — vivenu-api

latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api

transactions

Cancel POS Transaction

post/api/pos/{id}/cancel/{transactionId}

Path parameters

idstring required

transactionIdstring required

Request body

reasonstring

refundFundsboolean

Whether the refunds of the transaction get refunded

Response

_idstring required

The ID of the transaction

sellerIdstring required

The ID of the seller of the transaction

customerIdstring

The ID of the customer of the transaction

eventIdstring required

The ID of the event containing this transaction

companystring

The company name of the user of the transaction

namestring

The name of the user of the transaction

prenamestring

The firstname of the user of the transaction

lastnamestring

The lastname of the user of the transaction

emailstring email

The email of the user of the transaction

streetstring

The street of the user of the transaction

line2string

The additional address field of the user of the transaction.

citystring

The city of the user of the transaction

statestring

The state of the user of the transaction

countrystring

The country of the user of the transaction

postalstring

The postal of the user of the transaction

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

regularPricenumber float

The regular price of the transaction

realPricenumber float required

The calculated real price of the transaction

paymentChargenumber float

The payment charge of the transaction

innerChargenumber float

The inner charge of the transaction

outerChargenumber float

The outer charge of the transaction

taxRatenumber float

The tax rate of the transaction

createdAtstring date-time

An ISO timestamp indicating when the transaction was created

updatedAtstring date-time

An ISO Timestamp indicating when the voucher was last updated

status'NEW' | 'RESERVED-BY-SYSTEM' | 'ABORTED' | 'COMPLETE' | 'CANCELED' required

The status of the transaction.

pspstring

paymentMethod'paypal' | 'stripe' | 'local' | 'external' | 'vivenu-payments'

The payment method of the transaction.

The payment status of the transaction.

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

The origin of the transaction.

subscriptionIdstring

The ID of the subscription of the transaction

userIdstring

The ID of the user who created the transaction.

posIdstring

The ID of pos of the transaction

ticketMailSendboolean

Whether the mail with the ticket of the transaction was sent

orderMailSendboolean

Whether the mail with the order of the transaction was sent

extraFieldsobject

The extra fields of the transaction

channelstring

The channel of the transaction

underShopstring

The under shop of the transaction

locationCenternumber[]

secretstring required

The secret token of the transaction

vouchersstring[]

An array of voucher codes applied to this transaction

appliedDiscountGroupsstring[]

An array of discount groups applied to the transaction

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 preferred language of the transaction. It is determined automatically

cancellationReason'REQUESTED_BY_CUSTOMER' | 'CLAIM' | 'COMMUNICATION_ERROR' | 'TRAINING/TEST'

The reason of the cancellation of the transaction

invoiceVersionstring

The invoice version of the transaction.

seatingReservationTokenstring

The seating reservation token of the transaction