Transactions

Transaction objects are created when customers' purchase previously defined tickets or products. They represent money flowing into your organization. Transactions are identified by a unique, random ID.

Endpoints

The transaction object

Attributes

_id

Required

string

The ID of the transaction

sellerId

Required

string

The ID of the seller of the transaction

eventId

Required

string

The ID of the event containing this transaction

realPrice

Required

number float

The calculated real price of the transaction

status

Required

string

The status of the transaction.

NEWRESERVED-BY-SYSTEMABORTEDCOMPLETECANCELED

secret

Required

string

The secret token of the transaction

Optional Attributes

Collapse all

customerId

Optional

string

The ID of the customer of the transaction

company

Optional

string

The company name of the user of the transaction

name

Optional

string

The name of the user of the transaction

prename

Optional

string

The firstname of the user of the transaction

lastname

Optional

string

The lastname of the user of the transaction

Optional

string email

The email of the user of the transaction

street

Optional

string

The street of the user of the transaction

line2

Optional

string

The additional address field of the user of the transaction.

city

Optional

string

The city of the user of the transaction

state

Optional

string

The state of the user of the transaction

country

Optional

string

The country of the user of the transaction

postal

Optional

string

The postal of the user of the transaction

deliveryAddress

Optional

object

The delivery address of the transaction

Optional Attributes

Collapse all

deliveryAddress.street

Optional

string

The street of the address. Street name including number.

deliveryAddress.line2

Optional

string

The additional field of the address.

deliveryAddress.postal

Optional

string

The postal code of the address.

deliveryAddress.city

Optional

string

The city of the address.

deliveryAddress.country

Optional

string

The country of the address. An ISO 3166 country code.

deliveryAddress.state

Optional

string

The state of the address. If applicable

deliveryAddress.name

Optional

string

The name of the person receiving delivery.

tickets

Optional

array

An array of cart ticket items of the transaction

tickets[].amount

Required

integer

The amount of the cart item.

tickets[].price

Required

number float

The single piece price of the cart item.

tickets[].ticketTypeId

Required

string

The ID of the ticket type of the cart item.

Optional Attributes

Collapse all

tickets[].type

Optional

string

The type of the cart item.

ticket

tickets[]._id

Optional

string

The ID of the cart item.

tickets[].name

Optional

string

The name of the cart item.

tickets[].netPrice

Optional

number float

The single piece net price of the cart item.

tickets[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

tickets[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

tickets[].bundleInfo

Optional

object

Optional Attributes

Collapse all

tickets[].bundleInfo.bundleId

Optional

string

tickets[].bundleInfo.componentId

Optional

string

tickets[].bundleInfo.optionId

Optional

string

tickets[].categoryRef

Optional

string

The category reference of the ticket type.

tickets[].seatingInfo

Optional

object

The associated seating object.

tickets[].seatingInfo._type

Required

number float

Indicates the type of seating object. Seat = 6, General Admission = 7.

67

tickets[].seatingInfo.statusId

Required

string

The ID of a container holding information about the seating status of the seating object.

Optional Attributes

Collapse all

tickets[].seatingInfo._id

Optional

string

The ID of the seating object.

tickets[].seatingInfo.categoryId

Optional

string

The ID of the category containing the seating object.

tickets[].seatingInfo.name

Optional

string

If _type == 7. The name of the general admission.

tickets[].seatingInfo.seatType

Optional

string

If _type == 6. The type of the seat. null = normal.

handicapped

tickets[].seatingInfo.sectionName

Optional

string

If _type == 6. The name of the section where the seat is located.

tickets[].seatingInfo.groupName

Optional

string

If _type == 6. The name of the row group where the seat is located.

tickets[].seatingInfo.rowName

Optional

string

If _type == 6. The name of the row where the seat is located.

tickets[].seatingInfo.seatName

Optional

string

If _type == 6. The seat name.

tickets[].seatingInfo.gate

Optional

string

The entry gate associated with the seating object.

tickets[].asHardTicket

Optional

boolean

Whether this ticket is a hard ticket.

tickets[].triggeredAutomations

Optional

boolean

Whether the cart item triggered automations.

tickets[].meta

Optional

object

Meta data which is propagated to the ticket.

products

Optional

array

An array of cart product items of the transaction

products[].type

Required

string

The type of the cart item.

product

products[].amount

Required

integer

The amount of the cart item.

products[].price

Required

number float

The single piece price of the cart item.

products[].productVariantId

Required

string

The ID of the product variant.

Optional Attributes

Collapse all

products[]._id

Optional

string

The ID of the cart item.

products[].name

Optional

string

The name of the cart item.

products[].netPrice

Optional

number float

The single piece net price of the cart item.

products[].taxRate

Optional

number float

The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.

products[].triggeredBy

Optional

An ID or an array of IDs of other cart items which triggered the buy action of the cart item.

One of

Only one of the following types

products[].bundleInfo

Optional

object

Optional Attributes

Collapse all

products[].bundleInfo.bundleId

Optional

string

products[].bundleInfo.componentId

Optional

string

products[].bundleInfo.optionId

Optional

string

products[].isFulfillable

Optional

boolean

Whether the product can be delivered

additionalItems

Optional

array

An array of additional price items of the transaction

One of

Only one of the following types

additionalItems[].itemId

Required

string

The ID of the item.

additionalItems[].type

Required

string

The type of the additional item.

bundle

additionalItems[].netPrice

Required

number float

The single piece net price of the additional item.

additionalItems[].price

Required

number float

The single piece price of the additional item.

additionalItems[].taxRate

Required

number float

The tax rate to be applied to this additional item.

Optional Attributes

Collapse all

additionalItems[].taxInfo

Optional

object

The tax info details.

Optional Attributes

Collapse all

additionalItems[].taxInfo.serviceTypeId

Optional

string

The ID of the service type.

additionalItems[].taxInfo.exceptionId

Optional

string

The ID of the exception.

additionalItems[].taxInfo.proceedsAccountId

Optional

string

The ID of the proceeds account.

additionalItems[].taxInfo.proceedsAccountCode

Optional

string

The code of the proceeds account.

additionalItems[].taxInfo.taxItems

Optional

array

The array of tax items.

additionalItems[].taxInfo.taxItems[].taxTypeId

Required

string

additionalItems[].taxInfo.taxItems[].rate

Required

number float

additionalItems[].taxInfo.taxItems[].perUnit

Required

number float

additionalItems[].taxInfo.taxItems[].total

Required

number float

Optional Attributes

Collapse all

additionalItems[].taxInfo.taxItems[].name

Optional

string

additionalItems[].taxInfo.taxItems[].taxPayableAccountId

Optional

string

additionalItems[].taxInfo.taxItems[].taxPayableAccountCode

Optional

string

additionalItems[].data

Optional

object

additionalItems[].data.bundleId

Required

string

The ID of the bundle.

currency

Optional

string

An ISO 4217 3-character code of the currency

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWD

regularPrice

Optional

number float

The regular price of the transaction

paymentCharge

Optional

number float

The payment charge of the transaction

innerCharge

Optional

number float

The inner charge of the transaction

outerCharge

Optional

number float

The outer charge of the transaction

innerFeeComponents

Optional

object

The inner fee of the transaction including fix and var fee

innerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

innerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

innerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

innerFeeComponents.fix[].amount

Optional

number float

The fee amount.

innerFeeComponents.fix[].value

Optional

number float

The fee value.

innerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

innerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

innerFeeComponents.fix[].name

Optional

string

The name of the fee.

innerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

innerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

innerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

innerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

innerFeeComponents.var

Optional

array

An array of fee components for the var fee.

innerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

innerFeeComponents.var[].amount

Optional

number float

The fee amount.

innerFeeComponents.var[].value

Optional

number float

The fee value.

innerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

innerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

innerFeeComponents.var[].name

Optional

string

The name of the fee.

innerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

innerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

innerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

innerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

outerFeeComponents

Optional

object

The outer fee of the transaction including fix and var fee

outerFeeComponents._id

Required

string

The ID of the fee composition.

Optional Attributes

Collapse all

outerFeeComponents.fix

Optional

array

An array of fee components for the fix fee.

outerFeeComponents.fix[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

outerFeeComponents.fix[].amount

Optional

number float

The fee amount.

outerFeeComponents.fix[].value

Optional

number float

The fee value.

outerFeeComponents.fix[].total

Optional

number float

The fee total. Calculated with amount and value.

outerFeeComponents.fix[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

outerFeeComponents.fix[].name

Optional

string

The name of the fee.

outerFeeComponents.fix[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

outerFeeComponents.fix[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

outerFeeComponents.fix[].scheme.schemeId

Optional

string

The ID of the fee scheme.

outerFeeComponents.fix[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

outerFeeComponents.var

Optional

array

An array of fee components for the var fee.

outerFeeComponents.var[]._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

outerFeeComponents.var[].amount

Optional

number float

The fee amount.

outerFeeComponents.var[].value

Optional

number float

The fee value.

outerFeeComponents.var[].total

Optional

number float

The fee total. Calculated with amount and value.

outerFeeComponents.var[].type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

outerFeeComponents.var[].name

Optional

string

The name of the fee.

outerFeeComponents.var[].exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

outerFeeComponents.var[].scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

outerFeeComponents.var[].scheme.schemeId

Optional

string

The ID of the fee scheme.

outerFeeComponents.var[].scheme.feeId

Optional

string

The ID of the fee scheme fee.

cancellationFee

Optional

object

The cancellation fee of the transaction

cancellationFee._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

cancellationFee.amount

Optional

number float

The fee amount.

cancellationFee.value

Optional

number float

The fee value.

cancellationFee.total

Optional

number float

The fee total. Calculated with amount and value.

cancellationFee.type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

cancellationFee.name

Optional

string

The name of the fee.

cancellationFee.exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

cancellationFee.scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

cancellationFee.scheme.schemeId

Optional

string

The ID of the fee scheme.

cancellationFee.scheme.feeId

Optional

string

The ID of the fee scheme fee.

cancellationInfo

Optional

object

The cancellation info of the transaction

Optional Attributes

Collapse all

cancellationInfo.cancellableItems

Optional

array

An array of cancellable items

cancellationInfo.cancellableItems[].cartItemId

Required

string

The ID of the cart to which the item belongs to

cancellationInfo.cancellableItems[].type

Required

string

The type of the item indicated where it originated from

ticketproductfeediscountfulfillment

cancellationInfo.cancellableItems[].price

Required

number float

The price of the item

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].name

Optional

string

The name of the item

cancellationInfo.cancellableItems[].taxRate

Optional

number float

The applied tax rate for that item

cancellationInfo.cancellableItems[].origin

Optional

Object indicating where the item originated from

One of

Only one of the following types

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].origin.fee

Optional

object

The cancellation fee of the item

cancellationInfo.cancellableItems[].origin.fee._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].origin.fee.amount

Optional

number float

The fee amount.

cancellationInfo.cancellableItems[].origin.fee.value

Optional

number float

The fee value.

cancellationInfo.cancellableItems[].origin.fee.total

Optional

number float

The fee total. Calculated with amount and value.

cancellationInfo.cancellableItems[].origin.fee.type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

cancellationInfo.cancellableItems[].origin.fee.name

Optional

string

The name of the fee.

cancellationInfo.cancellableItems[].origin.fee.exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

cancellationInfo.cancellableItems[].origin.fee.scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].origin.fee.scheme.schemeId

Optional

string

The ID of the fee scheme.

cancellationInfo.cancellableItems[].origin.fee.scheme.feeId

Optional

string

The ID of the fee scheme fee.

cancellationInfo.cancellableItems[].cancellationFee

Optional

object

The cancellation fee of the item. Is set when cancellation fees are charged at cancellation

cancellationInfo.cancellableItems[].cancellationFee._id

Required

string

The ID of the fee component.

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].cancellationFee.amount

Optional

number float

The fee amount.

cancellationInfo.cancellableItems[].cancellationFee.value

Optional

number float

The fee value.

cancellationInfo.cancellableItems[].cancellationFee.total

Optional

number float

The fee total. Calculated with amount and value.

cancellationInfo.cancellableItems[].cancellationFee.type

Optional

string

The fee type of the fee component.

onTicketonHardTicketonCart

cancellationInfo.cancellableItems[].cancellationFee.name

Optional

string

The name of the fee.

cancellationInfo.cancellableItems[].cancellationFee.exposed

Optional

boolean

Whether this fee will be exposed to the ticket buyer.

cancellationInfo.cancellableItems[].cancellationFee.scheme

Optional

object

The fee scheme of the fee component.

Optional Attributes

Collapse all

cancellationInfo.cancellableItems[].cancellationFee.scheme.schemeId

Optional

string

The ID of the fee scheme.

cancellationInfo.cancellableItems[].cancellationFee.scheme.feeId

Optional

string

The ID of the fee scheme fee.

cancellationInfo.cancellableItems[].refundId

Optional

string

The ID of the refund. Is set when item was refunded

cancellationInfo.cancellableItems[].cancelledAt

Optional

string date-time

A date indicating when the item has been cancelled

taxRate

Optional

number float

The tax rate of the transaction

createdAt

Optional

string date-time

An ISO timestamp indicating when the transaction was created

updatedAt

Optional

string date-time

An ISO Timestamp indicating when the voucher was last updated

psp

Optional

string

paymentMethod

Optional

string

The payment method of the transaction.

adyenpaypalstripelocalexternalvivenu-payments

paymentInfo

Optional

object

The payment info of the transaction

paymentInfo._id

Required

string

The ID of the payment info

Optional Attributes

Collapse all

paymentInfo.psp

Optional

string

paymentInfo.gateway

Optional

string

The payment gateway of the payment.

managedexternallocal

paymentInfo.providerType

Optional

string

The payment provider of the payment.

stripeConnectvivenu

paymentInfo.providerId

Optional

string

The ID of the provider of the payment

paymentInfo.method

Optional

string

The method of the payment

paymentInfo.methodVariant

Optional

string

The method variant of the payment

paymentInfo.locale

Optional

string

The locale of the payment

paymentInfo.riskLevel

Optional

string

The risk level of the payment

paymentInfo.riskScore

Optional

number float

The risk score of the payment

paymentInfo.refundId

Optional

string

The ID of the refund of the payment

paymentInfo.collectedApplicationFee

Optional

number float

The application fee of the payment

paymentStatus

Optional

string

The payment status of the transaction.

AWAITINGPENDINGRECEIVEDREFUNDCANCELEDFAILEDDISPUTECHARGEBACKPOS-RECEIVEDPOS-CANCELEDLOCAL-PENDINGLOCAL-AWAITINGLOCAL-RECEIVEDEXTERNAL

origin

Optional

string

The origin of the transaction.

yourticketposrebookingupgrade

userId

Optional

string

The ID of the user who created the transaction.

posId

Optional

string

The ID of pos of the transaction

posInfo

Optional

object

The POS info of the transaction

posInfo._id

Required

string

The ID of the POS info

Optional Attributes

Collapse all

posInfo.sessionId

Optional

string

The ID of the session of the POS

posInfo.billingNo

Optional

string

The billing no of the POS

posInfo.taxId

Optional

string

The tax ID of the POS

posInfo.paymentMethod

Optional

string

The payment method of the POS.

casheccreditcard

posInfo.canceledAt

Optional

string date-time

The cancellation Date of the POS

posInfo.cancellationNo

Optional

string date-time

The cancellation no of the POS

history

Optional

Deprecated

array

An array of history entry items of the transaction

history[]._id

Required

string

The ID of the transaction history entry

Optional Attributes

Collapse all

history[].date

Optional

string date-time

The date of the history entry

history[].title

Optional

string

The title of the history entry

history[].message

Optional

string

A message which describes the history entry

history[].type

Optional

string

The type of the history entry.

PAYMENTYOURTICKETUSER

history[].risk

Optional

string

The risk of the transaction history entry. NEUTRAL = is a neutral risk of the transaction. GOOD = is a good risk factor of the transaction, which means less risk. DANGER = is a danger risk factor of the transaction, which means high risk.

DANGERNEUTRALGOOD

historyEntries

Optional

array

An array of history entry items of the transaction

historyEntries[]._id

Required

string

The ID of the transaction history entry

Optional Attributes

Collapse all

historyEntries[].date

Optional

string date-time

The date of the history entry

historyEntries[].userId

Optional

string

The ID of the user of the history entry

historyEntries[].data

Optional

object

The data of the history entry

historyEntries[].type

Optional

string

The type of the history entry.

createdreservedcompletedcompleted.manuallyabortedcanceledpartial.canceledpos.createdpos.canceledpos.payment.method.changedpayment.canceledpayment.authorizedpayment.failedpayment.succeededpayment.chargebackpayment.localReceiveddispute.createddispute.wondispute.lostrefundedpartial.refundedpartial.refunded.voucherpayment.local.addedprice.recalculatedinvitation.reserved.mailtransaction.resent.mailtransaction.resent.ticket_mailtransaction.resent.voucher_mailtickets.bookedtransaction.sent.smscommented

historyEntries[].risk

Optional

string

DANGERNEUTRALGOOD

ticketMailSend

Optional

boolean

Whether the mail with the ticket of the transaction was sent

orderMailSend

Optional

boolean

Whether the mail with the order of the transaction was sent

extraFields

Optional

object

The extra fields of the transaction

channel

Optional

string

The channel of the transaction

underShop

Optional

string

The under shop of the transaction

userAgent

Optional

object

The User Agent of the transaction

userAgent._id

Required

string

The ID of the User Agent

Optional Attributes

Collapse all

userAgent.ua

Optional

string

The user agent

userAgent.browser

Optional

object

The browser of the user

userAgent.device

Optional

object

The device of the user

userAgent.engine

Optional

object

The engine of the user

userAgent.os

Optional

object

The OS of the user

userAgent.cpu

Optional

object

The CPU of the user

ipLookup

Optional

object

The IP lookup info of the transaction

Optional Attributes

Collapse all

ipLookup.ip

Optional

string

The IP address of the IP lookup info

ipLookup.lookup

Optional

object

The IP lookup result

Optional Attributes

Collapse all

ipLookup.lookup.range

Optional

array<number>

The Range of the ip adress

ipLookup.lookup.country

Optional

string

The country of the IP lookup

ipLookup.lookup.region

Optional

string

The region of the IP lookup

ipLookup.lookup.eu

Optional

string

ipLookup.lookup.timezone

Optional

string

The timezone of the IP lookup

ipLookup.lookup.city

Optional

string

The city city of the IP lookup

ipLookup.lookup.ll

Optional

array<number>

ipLookup.lookup.metro

Optional

number float

ipLookup.lookup.area

Optional

number float

locationCenter

Optional

array<number>

vouchers

Optional

array<string>

An array of voucher codes applied to this transaction

redeemedVouchers

Optional

object

An array of voucher codes redeemed for this transaction

redeemedVouchers.totalRedeemedAmount

Required

number float

The sum of all vouchers applied.

Optional Attributes

Collapse all

redeemedVouchers.vouchers

Optional

array

An array of all redeemed vouchers.

redeemedVouchers.vouchers[]._id

Required

string

The ID of the voucher.

redeemedVouchers.vouchers[].code

Required

string

The Code of the voucher.

redeemedVouchers.vouchers[].redeemedAmount

Required

number float

The applied value of the voucher.

appliedCoupons

Optional

array

An array of applied coupons within the transaction

Optional Attributes

Collapse all

appliedCoupons[]._id

Optional

string

The ID of the applied coupon.

appliedCoupons[].code

Optional

string

The code of the applied coupon.

appliedDiscountGroups

Optional

array<string>

An array of discount groups applied to the transaction

posDiscounts

Optional

array

An array of POS discounts

posDiscounts[]._id

Required

string

The ID of the POS discount

posDiscounts[].name

Required

string

The name of the POS discount

posDiscounts[].value

Required

number float

The value of the POS discount

Optional Attributes

Collapse all

posDiscounts[].discountType

Optional

string

The discount type.

TOTALPERCENTAGEfixvar

preferredLanguage

Optional

string

The preferred language of the transaction. It is determined automatically

deenen-GBen-AUfreses-MXnllvhearthrutritpldakojazh-TW

cancellationReason

Optional

string

The reason of the cancellation of the transaction

REQUESTED_BY_CUSTOMERCLAIMCOMMUNICATION_ERRORTRAINING/TEST

appliedDiscountInfo

Optional

object

Applied discountInfo for the transaction

Optional Attributes

Collapse all

appliedDiscountInfo.items

Optional

array

An array of applied discount info items.

appliedDiscountInfo.items[]._id

Required

string

The ID of the applied discount info item.

Optional Attributes

Collapse all

appliedDiscountInfo.items[].itemId

Optional

string

The ID of the item on which the discount is applied.

appliedDiscountInfo.items[].amount

Optional

number float

The amount of applied discounts.

appliedDiscountInfo.items[].regularPrice

Optional

number float

The regular price before applying the discount.

appliedDiscountInfo.items[].price

Optional

number float

The price after applying the discount.

appliedDiscountInfo.items[].varDiscounts

Optional

array

An array of var discounts of the applied discount info item.

appliedDiscountInfo.items[].varDiscounts[]._id

Required

string

The ID of the discount info.

appliedDiscountInfo.items[].varDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

appliedDiscountInfo.items[].varDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

appliedDiscountInfo.items[].varDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

appliedDiscountInfo.items[].varDiscounts[].name

Optional

string

The name of the discount.

appliedDiscountInfo.items[].varDiscounts[].value

Optional

number float

The value of the discount.

appliedDiscountInfo.items[].varDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

appliedDiscountInfo.items[].fixDiscounts

Optional

array

An array of fix discounts of the applied discount info item.

appliedDiscountInfo.items[].fixDiscounts[]._id

Required

string

The ID of the discount info.

appliedDiscountInfo.items[].fixDiscounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

appliedDiscountInfo.items[].fixDiscounts[].discountId

Optional

string

The ID of the discount of the discount info.

appliedDiscountInfo.items[].fixDiscounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

appliedDiscountInfo.items[].fixDiscounts[].name

Optional

string

The name of the discount.

appliedDiscountInfo.items[].fixDiscounts[].value

Optional

number float

The value of the discount.

appliedDiscountInfo.items[].fixDiscounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

appliedDiscountInfo.discounts

Optional

array

An array of extended discount info items.

appliedDiscountInfo.discounts[]._id

Required

string

The ID of the discount info.

appliedDiscountInfo.discounts[].type

Required

string

The type of the discount.

fixvarfixPerItem

Optional Attributes

Collapse all

appliedDiscountInfo.discounts[].discountId

Optional

string

The ID of the discount of the discount info.

appliedDiscountInfo.discounts[].category

Optional

string

The category of the discount.

coupongroupDiscountposDiscountvoucher

appliedDiscountInfo.discounts[].name

Optional

string

The name of the discount.

appliedDiscountInfo.discounts[].value

Optional

number float

The value of the discount.

appliedDiscountInfo.discounts[].allowedItems

Optional

array<string>

An array of the IDs of allowed items of the discount.

appliedDiscountInfo.discounts[].maxItemsInCart

Optional

number float

The maximum amount of items the discount will be applied towards.

appliedDiscountInfo.discounts[].maxAbsoluteValue

Optional

number float

The maximum absolute value of the discount.

appliedDiscountInfo.discounts[].absoluteDiscountValue

Optional

number float

The absolute value of the discount.

invoiceVersion

Optional

string

The invoice version of the transaction.

seatingReservationToken

Optional

string

The seating reservation token of the transaction

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "customerId": "string",
  "eventId": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "email": "[email protected]",
  "street": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "postal": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "tickets": [],
  "products": [],
  "additionalItems": [],
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "paymentCharge": 10.5,
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "innerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "outerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "cancellationFee": {
    "_id": "string",
    "amount": 10.5,
    "value": 10.5,
    "total": 10.5,
    "type": "onTicket",
    "name": "string",
    "exposed": true,
    "scheme": {
      "schemeId": "string",
      "feeId": "string"
    }
  },
  "cancellationInfo": {
    "cancellableItems": [
      {
        "cartItemId": "string",
        "type": "ticket",
        "name": "string",
        "price": 10.5,
        "taxRate": 10.5,
        "origin": {
          "fee": {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        },
        "cancellationFee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        },
        "refundId": "string",
        "cancelledAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  },
  "taxRate": 0.19,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "NEW",
  "psp": "string",
  "paymentMethod": "adyen",
  "paymentInfo": {
    "_id": "string",
    "psp": "string",
    "gateway": "managed",
    "providerType": "vivenu",
    "providerId": "string",
    "method": "string",
    "methodVariant": "string",
    "locale": "string",
    "riskLevel": "string",
    "riskScore": 10.5,
    "refundId": "string",
    "collectedApplicationFee": 10.5
  },
  "paymentStatus": "AWAITING",
  "origin": "yourticket",
  "userId": "string",
  "posId": "string",
  "posInfo": {
    "_id": "string",
    "sessionId": "string",
    "billingNo": "string",
    "taxId": "string",
    "paymentMethod": "cash",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "cancellationNo": "2030-01-23T23:00:00.123Z"
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "title": "string",
      "message": "string",
      "type": "YOURTICKET",
      "risk": "NEUTRAL"
    }
  ],
  "historyEntries": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "data": {},
      "type": "created",
      "risk": "NEUTRAL"
    }
  ],
  "ticketMailSend": true,
  "orderMailSend": true,
  "extraFields": {},
  "channel": "string",
  "underShop": "string",
  "userAgent": {
    "_id": "string",
    "ua": "string",
    "browser": {},
    "device": {},
    "engine": {},
    "os": {},
    "cpu": {}
  },
  "ipLookup": {
    "ip": "string",
    "lookup": {
      "range": [
        10.5
      ],
      "country": "string",
      "region": "string",
      "eu": "string",
      "timezone": "string",
      "city": "string",
      "ll": [
        10.5
      ],
      "metro": 10.5,
      "area": 10.5
    }
  },
  "locationCenter": [
    10.5
  ],
  "secret": "string",
  "vouchers": [
    "string"
  ],
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "appliedCoupons": [
    {
      "_id": "string",
      "code": "string"
    }
  ],
  "appliedDiscountGroups": [
    "string"
  ],
  "posDiscounts": [
    {
      "_id": "string",
      "name": "string",
      "discountType": "fix",
      "value": 10.5
    }
  ],
  "preferredLanguage": "de",
  "cancellationReason": "REQUESTED_BY_CUSTOMER",
  "appliedDiscountInfo": {
    "items": [
      {
        "_id": "string",
        "itemId": "string",
        "amount": 10.5,
        "regularPrice": 10.5,
        "price": 10.5,
        "varDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ],
        "fixDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ]
      }
    ],
    "discounts": [
      {
        "_id": "string",
        "discountId": "string",
        "category": "coupon",
        "name": "string",
        "type": "fix",
        "value": 10.5,
        "allowedItems": [
          "string"
        ],
        "maxItemsInCart": 10.5,
        "maxAbsoluteValue": 10.5,
        "absoluteDiscountValue": 10.5
      }
    ]
  },
  "invoiceVersion": "v2",
  "seatingReservationToken": "string"
}

Get a Transaction

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "customerId": "string",
  "eventId": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "email": "[email protected]",
  "street": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "postal": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "tickets": [],
  "products": [],
  "additionalItems": [],
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "paymentCharge": 10.5,
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "innerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "outerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "cancellationFee": {
    "_id": "string",
    "amount": 10.5,
    "value": 10.5,
    "total": 10.5,
    "type": "onTicket",
    "name": "string",
    "exposed": true,
    "scheme": {
      "schemeId": "string",
      "feeId": "string"
    }
  },
  "cancellationInfo": {
    "cancellableItems": [
      {
        "cartItemId": "string",
        "type": "ticket",
        "name": "string",
        "price": 10.5,
        "taxRate": 10.5,
        "origin": {
          "fee": {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        },
        "cancellationFee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        },
        "refundId": "string",
        "cancelledAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  },
  "taxRate": 0.19,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "NEW",
  "psp": "string",
  "paymentMethod": "adyen",
  "paymentInfo": {
    "_id": "string",
    "psp": "string",
    "gateway": "managed",
    "providerType": "vivenu",
    "providerId": "string",
    "method": "string",
    "methodVariant": "string",
    "locale": "string",
    "riskLevel": "string",
    "riskScore": 10.5,
    "refundId": "string",
    "collectedApplicationFee": 10.5
  },
  "paymentStatus": "AWAITING",
  "origin": "yourticket",
  "userId": "string",
  "posId": "string",
  "posInfo": {
    "_id": "string",
    "sessionId": "string",
    "billingNo": "string",
    "taxId": "string",
    "paymentMethod": "cash",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "cancellationNo": "2030-01-23T23:00:00.123Z"
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "title": "string",
      "message": "string",
      "type": "YOURTICKET",
      "risk": "NEUTRAL"
    }
  ],
  "historyEntries": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "data": {},
      "type": "created",
      "risk": "NEUTRAL"
    }
  ],
  "ticketMailSend": true,
  "orderMailSend": true,
  "extraFields": {},
  "channel": "string",
  "underShop": "string",
  "userAgent": {
    "_id": "string",
    "ua": "string",
    "browser": {},
    "device": {},
    "engine": {},
    "os": {},
    "cpu": {}
  },
  "ipLookup": {
    "ip": "string",
    "lookup": {
      "range": [
        10.5
      ],
      "country": "string",
      "region": "string",
      "eu": "string",
      "timezone": "string",
      "city": "string",
      "ll": [
        10.5
      ],
      "metro": 10.5,
      "area": 10.5
    }
  },
  "locationCenter": [
    10.5
  ],
  "secret": "string",
  "vouchers": [
    "string"
  ],
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "appliedCoupons": [
    {
      "_id": "string",
      "code": "string"
    }
  ],
  "appliedDiscountGroups": [
    "string"
  ],
  "posDiscounts": [
    {
      "_id": "string",
      "name": "string",
      "discountType": "fix",
      "value": 10.5
    }
  ],
  "preferredLanguage": "de",
  "cancellationReason": "REQUESTED_BY_CUSTOMER",
  "appliedDiscountInfo": {
    "items": [
      {
        "_id": "string",
        "itemId": "string",
        "amount": 10.5,
        "regularPrice": 10.5,
        "price": 10.5,
        "varDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ],
        "fixDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ]
      }
    ],
    "discounts": [
      {
        "_id": "string",
        "discountId": "string",
        "category": "coupon",
        "name": "string",
        "type": "fix",
        "value": 10.5,
        "allowedItems": [
          "string"
        ],
        "maxItemsInCart": 10.5,
        "maxAbsoluteValue": 10.5,
        "absoluteDiscountValue": 10.5
      }
    ]
  },
  "invoiceVersion": "v2",
  "seatingReservationToken": "string"
}

Cancel a Transaction

Payload

Optional Attributes

Collapse all

refundFunds

Optional

boolean

Whether the received funds should be refunded

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "refundFunds": true
}

{
  "_id": "string",
  "sellerId": "string",
  "customerId": "string",
  "eventId": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "email": "[email protected]",
  "street": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "postal": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "tickets": [],
  "products": [],
  "additionalItems": [],
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "paymentCharge": 10.5,
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "innerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "outerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "cancellationFee": {
    "_id": "string",
    "amount": 10.5,
    "value": 10.5,
    "total": 10.5,
    "type": "onTicket",
    "name": "string",
    "exposed": true,
    "scheme": {
      "schemeId": "string",
      "feeId": "string"
    }
  },
  "cancellationInfo": {
    "cancellableItems": [
      {
        "cartItemId": "string",
        "type": "ticket",
        "name": "string",
        "price": 10.5,
        "taxRate": 10.5,
        "origin": {
          "fee": {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        },
        "cancellationFee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        },
        "refundId": "string",
        "cancelledAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  },
  "taxRate": 0.19,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "NEW",
  "psp": "string",
  "paymentMethod": "adyen",
  "paymentInfo": {
    "_id": "string",
    "psp": "string",
    "gateway": "managed",
    "providerType": "vivenu",
    "providerId": "string",
    "method": "string",
    "methodVariant": "string",
    "locale": "string",
    "riskLevel": "string",
    "riskScore": 10.5,
    "refundId": "string",
    "collectedApplicationFee": 10.5
  },
  "paymentStatus": "AWAITING",
  "origin": "yourticket",
  "userId": "string",
  "posId": "string",
  "posInfo": {
    "_id": "string",
    "sessionId": "string",
    "billingNo": "string",
    "taxId": "string",
    "paymentMethod": "cash",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "cancellationNo": "2030-01-23T23:00:00.123Z"
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "title": "string",
      "message": "string",
      "type": "YOURTICKET",
      "risk": "NEUTRAL"
    }
  ],
  "historyEntries": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "data": {},
      "type": "created",
      "risk": "NEUTRAL"
    }
  ],
  "ticketMailSend": true,
  "orderMailSend": true,
  "extraFields": {},
  "channel": "string",
  "underShop": "string",
  "userAgent": {
    "_id": "string",
    "ua": "string",
    "browser": {},
    "device": {},
    "engine": {},
    "os": {},
    "cpu": {}
  },
  "ipLookup": {
    "ip": "string",
    "lookup": {
      "range": [
        10.5
      ],
      "country": "string",
      "region": "string",
      "eu": "string",
      "timezone": "string",
      "city": "string",
      "ll": [
        10.5
      ],
      "metro": 10.5,
      "area": 10.5
    }
  },
  "locationCenter": [
    10.5
  ],
  "secret": "string",
  "vouchers": [
    "string"
  ],
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "appliedCoupons": [
    {
      "_id": "string",
      "code": "string"
    }
  ],
  "appliedDiscountGroups": [
    "string"
  ],
  "posDiscounts": [
    {
      "_id": "string",
      "name": "string",
      "discountType": "fix",
      "value": 10.5
    }
  ],
  "preferredLanguage": "de",
  "cancellationReason": "REQUESTED_BY_CUSTOMER",
  "appliedDiscountInfo": {
    "items": [
      {
        "_id": "string",
        "itemId": "string",
        "amount": 10.5,
        "regularPrice": 10.5,
        "price": 10.5,
        "varDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ],
        "fixDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ]
      }
    ],
    "discounts": [
      {
        "_id": "string",
        "discountId": "string",
        "category": "coupon",
        "name": "string",
        "type": "fix",
        "value": 10.5,
        "allowedItems": [
          "string"
        ],
        "maxItemsInCart": 10.5,
        "maxAbsoluteValue": 10.5,
        "absoluteDiscountValue": 10.5
      }
    ]
  },
  "invoiceVersion": "v2",
  "seatingReservationToken": "string"
}

Get Transaction cancellation info

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "cancellableItems": [
    {
      "cartItemId": "string",
      "type": "ticket",
      "name": "string",
      "price": 10.5,
      "taxRate": 10.5,
      "origin": {
        "fee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        }
      },
      "cancellationFee": {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      },
      "refundId": "string",
      "cancelledAt": "2030-01-23T23:00:00.123Z"
    }
  ]
}

Create a Transaction cancellation

Payload

items

Required

array<string>

An array of cancellable-Ids of items to be cancelled

Optional Attributes

Collapse all

refundFunds

Optional

boolean

Whether the received funds should be refunded

refundTarget

Optional

string

The method to use for refunding the transaction.

originvoucher

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "items": [
    "string"
  ],
  "refundFunds": true,
  "refundTarget": "origin"
}

{
  "transactionId": "string",
  "sellerId": "string",
  "cancelledItems": [
    {
      "cartItemId": "string",
      "type": "ticket",
      "name": "string",
      "price": 10.5,
      "taxRate": 10.5,
      "origin": {
        "fee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        }
      },
      "cancellationFee": {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      },
      "refundId": "string",
      "cancelledAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "refundId": "string",
  "refundTarget": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Complete a Transaction

You can only complete a transaction if the status equals NEW.

Caution: A successful call will send the ticket and order emails if not otherwise configured. If the transaction contains tickets with seats, an attempt is made to book the seat reservation.

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

{
  "_id": "string",
  "sellerId": "string",
  "customerId": "string",
  "eventId": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "email": "[email protected]",
  "street": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "postal": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "tickets": [],
  "products": [],
  "additionalItems": [],
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "paymentCharge": 10.5,
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "innerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "outerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "cancellationFee": {
    "_id": "string",
    "amount": 10.5,
    "value": 10.5,
    "total": 10.5,
    "type": "onTicket",
    "name": "string",
    "exposed": true,
    "scheme": {
      "schemeId": "string",
      "feeId": "string"
    }
  },
  "cancellationInfo": {
    "cancellableItems": [
      {
        "cartItemId": "string",
        "type": "ticket",
        "name": "string",
        "price": 10.5,
        "taxRate": 10.5,
        "origin": {
          "fee": {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        },
        "cancellationFee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        },
        "refundId": "string",
        "cancelledAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  },
  "taxRate": 0.19,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "NEW",
  "psp": "string",
  "paymentMethod": "adyen",
  "paymentInfo": {
    "_id": "string",
    "psp": "string",
    "gateway": "managed",
    "providerType": "vivenu",
    "providerId": "string",
    "method": "string",
    "methodVariant": "string",
    "locale": "string",
    "riskLevel": "string",
    "riskScore": 10.5,
    "refundId": "string",
    "collectedApplicationFee": 10.5
  },
  "paymentStatus": "AWAITING",
  "origin": "yourticket",
  "userId": "string",
  "posId": "string",
  "posInfo": {
    "_id": "string",
    "sessionId": "string",
    "billingNo": "string",
    "taxId": "string",
    "paymentMethod": "cash",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "cancellationNo": "2030-01-23T23:00:00.123Z"
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "title": "string",
      "message": "string",
      "type": "YOURTICKET",
      "risk": "NEUTRAL"
    }
  ],
  "historyEntries": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "data": {},
      "type": "created",
      "risk": "NEUTRAL"
    }
  ],
  "ticketMailSend": true,
  "orderMailSend": true,
  "extraFields": {},
  "channel": "string",
  "underShop": "string",
  "userAgent": {
    "_id": "string",
    "ua": "string",
    "browser": {},
    "device": {},
    "engine": {},
    "os": {},
    "cpu": {}
  },
  "ipLookup": {
    "ip": "string",
    "lookup": {
      "range": [
        10.5
      ],
      "country": "string",
      "region": "string",
      "eu": "string",
      "timezone": "string",
      "city": "string",
      "ll": [
        10.5
      ],
      "metro": 10.5,
      "area": 10.5
    }
  },
  "locationCenter": [
    10.5
  ],
  "secret": "string",
  "vouchers": [
    "string"
  ],
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "appliedCoupons": [
    {
      "_id": "string",
      "code": "string"
    }
  ],
  "appliedDiscountGroups": [
    "string"
  ],
  "posDiscounts": [
    {
      "_id": "string",
      "name": "string",
      "discountType": "fix",
      "value": 10.5
    }
  ],
  "preferredLanguage": "de",
  "cancellationReason": "REQUESTED_BY_CUSTOMER",
  "appliedDiscountInfo": {
    "items": [
      {
        "_id": "string",
        "itemId": "string",
        "amount": 10.5,
        "regularPrice": 10.5,
        "price": 10.5,
        "varDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ],
        "fixDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ]
      }
    ],
    "discounts": [
      {
        "_id": "string",
        "discountId": "string",
        "category": "coupon",
        "name": "string",
        "type": "fix",
        "value": 10.5,
        "allowedItems": [
          "string"
        ],
        "maxItemsInCart": 10.5,
        "maxAbsoluteValue": 10.5,
        "absoluteDiscountValue": 10.5
      }
    ]
  },
  "invoiceVersion": "v2",
  "seatingReservationToken": "string"
}

Send transaction tickets per mail

Payload

Optional Attributes

Collapse all

Optional

string email

The email address to which the tickets of the transaction should be sent to

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "email": "[email protected]"
}

{
  "_id": "string",
  "sellerId": "string",
  "customerId": "string",
  "eventId": "string",
  "company": "string",
  "name": "string",
  "prename": "string",
  "lastname": "string",
  "email": "[email protected]",
  "street": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "country": "string",
  "postal": "string",
  "deliveryAddress": {
    "street": "string",
    "line2": "string",
    "postal": "string",
    "city": "string",
    "country": "string",
    "state": "string",
    "name": "string"
  },
  "tickets": [],
  "products": [],
  "additionalItems": [],
  "currency": "EUR",
  "regularPrice": 10.5,
  "realPrice": 10.5,
  "paymentCharge": 10.5,
  "innerCharge": 10.5,
  "outerCharge": 10.5,
  "innerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "outerFeeComponents": {
    "_id": "string",
    "fix": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ],
    "var": [
      {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      }
    ]
  },
  "cancellationFee": {
    "_id": "string",
    "amount": 10.5,
    "value": 10.5,
    "total": 10.5,
    "type": "onTicket",
    "name": "string",
    "exposed": true,
    "scheme": {
      "schemeId": "string",
      "feeId": "string"
    }
  },
  "cancellationInfo": {
    "cancellableItems": [
      {
        "cartItemId": "string",
        "type": "ticket",
        "name": "string",
        "price": 10.5,
        "taxRate": 10.5,
        "origin": {
          "fee": {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        },
        "cancellationFee": {
          "_id": "string",
          "amount": 10.5,
          "value": 10.5,
          "total": 10.5,
          "type": "onTicket",
          "name": "string",
          "exposed": true,
          "scheme": {
            "schemeId": "string",
            "feeId": "string"
          }
        },
        "refundId": "string",
        "cancelledAt": "2030-01-23T23:00:00.123Z"
      }
    ]
  },
  "taxRate": 0.19,
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z",
  "status": "NEW",
  "psp": "string",
  "paymentMethod": "adyen",
  "paymentInfo": {
    "_id": "string",
    "psp": "string",
    "gateway": "managed",
    "providerType": "vivenu",
    "providerId": "string",
    "method": "string",
    "methodVariant": "string",
    "locale": "string",
    "riskLevel": "string",
    "riskScore": 10.5,
    "refundId": "string",
    "collectedApplicationFee": 10.5
  },
  "paymentStatus": "AWAITING",
  "origin": "yourticket",
  "userId": "string",
  "posId": "string",
  "posInfo": {
    "_id": "string",
    "sessionId": "string",
    "billingNo": "string",
    "taxId": "string",
    "paymentMethod": "cash",
    "canceledAt": "2030-01-23T23:00:00.123Z",
    "cancellationNo": "2030-01-23T23:00:00.123Z"
  },
  "history": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "title": "string",
      "message": "string",
      "type": "YOURTICKET",
      "risk": "NEUTRAL"
    }
  ],
  "historyEntries": [
    {
      "_id": "string",
      "date": "2030-01-23T23:00:00.123Z",
      "userId": "string",
      "data": {},
      "type": "created",
      "risk": "NEUTRAL"
    }
  ],
  "ticketMailSend": true,
  "orderMailSend": true,
  "extraFields": {},
  "channel": "string",
  "underShop": "string",
  "userAgent": {
    "_id": "string",
    "ua": "string",
    "browser": {},
    "device": {},
    "engine": {},
    "os": {},
    "cpu": {}
  },
  "ipLookup": {
    "ip": "string",
    "lookup": {
      "range": [
        10.5
      ],
      "country": "string",
      "region": "string",
      "eu": "string",
      "timezone": "string",
      "city": "string",
      "ll": [
        10.5
      ],
      "metro": 10.5,
      "area": 10.5
    }
  },
  "locationCenter": [
    10.5
  ],
  "secret": "string",
  "vouchers": [
    "string"
  ],
  "redeemedVouchers": {
    "totalRedeemedAmount": 10.5,
    "vouchers": [
      {
        "_id": "string",
        "code": "string",
        "redeemedAmount": 10.5
      }
    ]
  },
  "appliedCoupons": [
    {
      "_id": "string",
      "code": "string"
    }
  ],
  "appliedDiscountGroups": [
    "string"
  ],
  "posDiscounts": [
    {
      "_id": "string",
      "name": "string",
      "discountType": "fix",
      "value": 10.5
    }
  ],
  "preferredLanguage": "de",
  "cancellationReason": "REQUESTED_BY_CUSTOMER",
  "appliedDiscountInfo": {
    "items": [
      {
        "_id": "string",
        "itemId": "string",
        "amount": 10.5,
        "regularPrice": 10.5,
        "price": 10.5,
        "varDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ],
        "fixDiscounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ]
          }
        ]
      }
    ],
    "discounts": [
      {
        "_id": "string",
        "discountId": "string",
        "category": "coupon",
        "name": "string",
        "type": "fix",
        "value": 10.5,
        "allowedItems": [
          "string"
        ],
        "maxItemsInCart": 10.5,
        "maxAbsoluteValue": 10.5,
        "absoluteDiscountValue": 10.5
      }
    ]
  },
  "invoiceVersion": "v2",
  "seatingReservationToken": "string"
}

Send a Transaction reserved invitation mail

Query

No supported query parameters

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

Update the payment status

Payload

paymentStatus

Required

string

The target payment status

LOCAL-RECEIVED

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "paymentStatus": "LOCAL-RECEIVED"
}

Get All Transactions

Query

name

Optional

string

Optional

string

coupon

Optional

string

start

Optional

string date-time

end

Optional

string date-time

status

Optional

string

paymentStatus

Optional

string

event

Optional

string

Filter by a comma(,) separated list of event IDs

seller

Optional

string

customer

Optional

string

subscriptionId

Optional

string

updatedAt

Optional

object

Range of dates indicating when the transaction was last updated in ISO format.

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

psp

Optional

string

The reference of the payment service provider to filter for

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "sellerId": "string",
      "customerId": "string",
      "eventId": "string",
      "company": "string",
      "name": "string",
      "prename": "string",
      "lastname": "string",
      "email": "[email protected]",
      "street": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "deliveryAddress": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string",
        "name": "string"
      },
      "tickets": [],
      "products": [],
      "additionalItems": [],
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "paymentCharge": 10.5,
      "innerCharge": 10.5,
      "outerCharge": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "cancellationFee": {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      },
      "cancellationInfo": {
        "cancellableItems": [
          {
            "cartItemId": "string",
            "type": "ticket",
            "name": "string",
            "price": 10.5,
            "taxRate": 10.5,
            "origin": {
              "fee": {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            },
            "cancellationFee": {
              "_id": "string",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "string",
                "feeId": "string"
              }
            },
            "refundId": "string",
            "cancelledAt": "2030-01-23T23:00:00.123Z"
          }
        ]
      },
      "taxRate": 0.19,
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "status": "NEW",
      "psp": "string",
      "paymentMethod": "adyen",
      "paymentInfo": {
        "_id": "string",
        "psp": "string",
        "gateway": "managed",
        "providerType": "vivenu",
        "providerId": "string",
        "method": "string",
        "methodVariant": "string",
        "locale": "string",
        "riskLevel": "string",
        "riskScore": 10.5,
        "refundId": "string",
        "collectedApplicationFee": 10.5
      },
      "paymentStatus": "AWAITING",
      "origin": "yourticket",
      "userId": "string",
      "posId": "string",
      "posInfo": {
        "_id": "string",
        "sessionId": "string",
        "billingNo": "string",
        "taxId": "string",
        "paymentMethod": "cash",
        "canceledAt": "2030-01-23T23:00:00.123Z",
        "cancellationNo": "2030-01-23T23:00:00.123Z"
      },
      "history": [
        {
          "_id": "string",
          "date": "2030-01-23T23:00:00.123Z",
          "title": "string",
          "message": "string",
          "type": "YOURTICKET",
          "risk": "NEUTRAL"
        }
      ],
      "historyEntries": [
        {
          "_id": "string",
          "date": "2030-01-23T23:00:00.123Z",
          "userId": "string",
          "data": {},
          "type": "created",
          "risk": "NEUTRAL"
        }
      ],
      "ticketMailSend": true,
      "orderMailSend": true,
      "extraFields": {},
      "channel": "string",
      "underShop": "string",
      "userAgent": {
        "_id": "string",
        "ua": "string",
        "browser": {},
        "device": {},
        "engine": {},
        "os": {},
        "cpu": {}
      },
      "ipLookup": {
        "ip": "string",
        "lookup": {
          "range": [
            10.5
          ],
          "country": "string",
          "region": "string",
          "eu": "string",
          "timezone": "string",
          "city": "string",
          "ll": [
            10.5
          ],
          "metro": 10.5,
          "area": 10.5
        }
      },
      "locationCenter": [
        10.5
      ],
      "secret": "string",
      "vouchers": [
        "string"
      ],
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountGroups": [
        "string"
      ],
      "posDiscounts": [
        {
          "_id": "string",
          "name": "string",
          "discountType": "fix",
          "value": 10.5
        }
      ],
      "preferredLanguage": "de",
      "cancellationReason": "REQUESTED_BY_CUSTOMER",
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "invoiceVersion": "v2",
      "seatingReservationToken": "string"
    }
  ],
  "total": 1
}

DEPRECATED

Get all Transactions rich

Query

name

Optional

string

Optional

string

coupon

Optional

string

start

Optional

string date-time

end

Optional

string date-time

status

Optional

string

paymentStatus

Optional

string

event

Optional

string

Filter by a comma(,) separated list of event IDs

seller

Optional

string

customer

Optional

string

updatedAt

Optional

object

Range of dates indicating when the transaction was last updated in ISO format.

Optional Attributes

Collapse all

updatedAt.$gt

Optional

string date-time

value is greater than

updatedAt.$gte

Optional

string date-time

value is greater than or equal

updatedAt.$lt

Optional

string date-time

value is less than

updatedAt.$lte

Optional

string date-time

value is less than or equal

updatedAt.$eq

Optional

string date-time

value is equal

updatedAt.$ne

Optional

string date-time

value is not equal

psp

Optional

string

The reference of the payment service provider to filter for

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "sellerId": "string",
      "customerId": "string",
      "eventId": "string",
      "company": "string",
      "name": "string",
      "prename": "string",
      "lastname": "string",
      "email": "[email protected]",
      "street": "string",
      "line2": "string",
      "city": "string",
      "state": "string",
      "country": "string",
      "postal": "string",
      "deliveryAddress": {
        "street": "string",
        "line2": "string",
        "postal": "string",
        "city": "string",
        "country": "string",
        "state": "string",
        "name": "string"
      },
      "tickets": [],
      "products": [],
      "additionalItems": [],
      "currency": "EUR",
      "regularPrice": 10.5,
      "realPrice": 10.5,
      "paymentCharge": 10.5,
      "innerCharge": 10.5,
      "outerCharge": 10.5,
      "innerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "outerFeeComponents": {
        "_id": "string",
        "fix": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ],
        "var": [
          {
            "_id": "string",
            "amount": 10.5,
            "value": 10.5,
            "total": 10.5,
            "type": "onTicket",
            "name": "string",
            "exposed": true,
            "scheme": {
              "schemeId": "string",
              "feeId": "string"
            }
          }
        ]
      },
      "cancellationFee": {
        "_id": "string",
        "amount": 10.5,
        "value": 10.5,
        "total": 10.5,
        "type": "onTicket",
        "name": "string",
        "exposed": true,
        "scheme": {
          "schemeId": "string",
          "feeId": "string"
        }
      },
      "cancellationInfo": {
        "cancellableItems": [
          {
            "cartItemId": "string",
            "type": "ticket",
            "name": "string",
            "price": 10.5,
            "taxRate": 10.5,
            "origin": {
              "fee": {
                "_id": "string",
                "amount": 10.5,
                "value": 10.5,
                "total": 10.5,
                "type": "onTicket",
                "name": "string",
                "exposed": true,
                "scheme": {
                  "schemeId": "string",
                  "feeId": "string"
                }
              }
            },
            "cancellationFee": {
              "_id": "string",
              "amount": 10.5,
              "value": 10.5,
              "total": 10.5,
              "type": "onTicket",
              "name": "string",
              "exposed": true,
              "scheme": {
                "schemeId": "string",
                "feeId": "string"
              }
            },
            "refundId": "string",
            "cancelledAt": "2030-01-23T23:00:00.123Z"
          }
        ]
      },
      "taxRate": 0.19,
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z",
      "status": "NEW",
      "psp": "string",
      "paymentMethod": "adyen",
      "paymentInfo": {
        "_id": "string",
        "psp": "string",
        "gateway": "managed",
        "providerType": "vivenu",
        "providerId": "string",
        "method": "string",
        "methodVariant": "string",
        "locale": "string",
        "riskLevel": "string",
        "riskScore": 10.5,
        "refundId": "string",
        "collectedApplicationFee": 10.5
      },
      "paymentStatus": "AWAITING",
      "origin": "yourticket",
      "userId": "string",
      "posId": "string",
      "posInfo": {
        "_id": "string",
        "sessionId": "string",
        "billingNo": "string",
        "taxId": "string",
        "paymentMethod": "cash",
        "canceledAt": "2030-01-23T23:00:00.123Z",
        "cancellationNo": "2030-01-23T23:00:00.123Z"
      },
      "history": [
        {
          "_id": "string",
          "date": "2030-01-23T23:00:00.123Z",
          "title": "string",
          "message": "string",
          "type": "YOURTICKET",
          "risk": "NEUTRAL"
        }
      ],
      "historyEntries": [
        {
          "_id": "string",
          "date": "2030-01-23T23:00:00.123Z",
          "userId": "string",
          "data": {},
          "type": "created",
          "risk": "NEUTRAL"
        }
      ],
      "ticketMailSend": true,
      "orderMailSend": true,
      "extraFields": {},
      "channel": "string",
      "underShop": "string",
      "userAgent": {
        "_id": "string",
        "ua": "string",
        "browser": {},
        "device": {},
        "engine": {},
        "os": {},
        "cpu": {}
      },
      "ipLookup": {
        "ip": "string",
        "lookup": {
          "range": [
            10.5
          ],
          "country": "string",
          "region": "string",
          "eu": "string",
          "timezone": "string",
          "city": "string",
          "ll": [
            10.5
          ],
          "metro": 10.5,
          "area": 10.5
        }
      },
      "locationCenter": [
        10.5
      ],
      "secret": "string",
      "vouchers": [
        "string"
      ],
      "redeemedVouchers": {
        "totalRedeemedAmount": 10.5,
        "vouchers": [
          {
            "_id": "string",
            "code": "string",
            "redeemedAmount": 10.5
          }
        ]
      },
      "appliedCoupons": [
        {
          "_id": "string",
          "code": "string"
        }
      ],
      "appliedDiscountGroups": [
        "string"
      ],
      "posDiscounts": [
        {
          "_id": "string",
          "name": "string",
          "discountType": "fix",
          "value": 10.5
        }
      ],
      "preferredLanguage": "de",
      "cancellationReason": "REQUESTED_BY_CUSTOMER",
      "appliedDiscountInfo": {
        "items": [
          {
            "_id": "string",
            "itemId": "string",
            "amount": 10.5,
            "regularPrice": 10.5,
            "price": 10.5,
            "varDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ],
            "fixDiscounts": [
              {
                "_id": "string",
                "discountId": "string",
                "category": "coupon",
                "name": "string",
                "type": "fix",
                "value": 10.5,
                "allowedItems": [
                  "string"
                ]
              }
            ]
          }
        ],
        "discounts": [
          {
            "_id": "string",
            "discountId": "string",
            "category": "coupon",
            "name": "string",
            "type": "fix",
            "value": 10.5,
            "allowedItems": [
              "string"
            ],
            "maxItemsInCart": 10.5,
            "maxAbsoluteValue": 10.5,
            "absoluteDiscountValue": 10.5
          }
        ]
      },
      "invoiceVersion": "v2",
      "seatingReservationToken": "string"
    }
  ],
  "total": 1
}

Get all Transaction Tickets

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

404

Not Found

Was this section helpful?

Yes No

[
  {
    "_id": "string",
    "sellerId": "string",
    "company": "string",
    "email": "string",
    "name": "string",
    "firstname": "string",
    "lastname": "string",
    "street": "string",
    "line2": "string",
    "city": "string",
    "postal": "string",
    "state": "string",
    "country": "string",
    "eventId": "string",
    "rootEventId": "string",
    "transactionId": "string",
    "posId": "string",
    "underShopId": "string",
    "categoryRef": "string",
    "categoryName": "string",
    "ticketTypeId": "string",
    "slotId": "string",
    "cartItemId": "string",
    "triggeredBy": [
      "string"
    ],
    "ticketName": "string",
    "currency": "EUR",
    "regularPrice": 10.5,
    "realPrice": 10.5,
    "completed": true,
    "createdAt": "2030-01-23T23:00:00.123Z",
    "updatedAt": "2030-01-23T23:00:00.123Z",
    "expiresAt": "2030-01-23T23:00:00.123Z",
    "status": "VALID",
    "secret": "string",
    "barcode": "string",
    "seat": "string",
    "seatingInfo": {
      "_id": "string",
      "_type": 6,
      "categoryId": "string",
      "statusId": "string",
      "name": "string",
      "seatType": "handicapped",
      "sectionName": "string",
      "groupName": "string",
      "rowName": "string",
      "seatName": "string",
      "gate": "string"
    },
    "type": "SINGLE",
    "origin": "yourticket",
    "extraFields": {},
    "batch": "string",
    "batchCounter": 10.5,
    "deliveryType": "HARD",
    "readyForDelivery": true,
    "customMessage": "string",
    "priceCategoryId": "string",
    "entryPermissions": [
      []
    ],
    "customerId": "string",
    "history": [
      []
    ],
    "personalized": true,
    "excludedEventIds": [
      "string"
    ],
    "originTicketId": "string",
    "fulfillmentTypeId": "string",
    "__v": 1
  }
]