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.

The transaction object

Required attributes

Name
_id
Type
string
Description
The ID of the transaction
Name
sellerId
Type
string
Description
The ID of the seller of the transaction
Name
eventId
Type
string
Description
The ID of the event containing this transaction
Name
realPrice
Type
number
Description
The calculated real price of the transaction
Name
status
Type
enum(NEW, RESERVED-BY-SYSTEM, ABORTED, COMPLETE, CANCELED)
Description
The status of the transaction.
Name
secret
Type
string
Description
The secret token of the transaction

Optional attributes

Name
customerId
Type
string
Description
The ID of the customer of the transaction
Name
company
Type
string
Description
The company name of the user of the transaction
Name
name
Type
string
Description
The name of the user of the transaction
Name
prename
Type
string
Description
The firstname of the user of the transaction
Name
lastname
Type
string
Description
The lastname of the user of the transaction
Name
email
Type
string
Description
The email of the user of the transaction
Name
street
Type
string
Description
The street of the user of the transaction
Name
line2
Type
string
Description
The additional address field of the user of the transaction.
Name
city
Type
string
Description
The city of the user of the transaction
Name
state
Type
string
Description
The state of the user of the transaction
Name
country
Type
string
Description
The country of the user of the transaction
Name
postal
Type
string
Description
The postal of the user of the transaction
Name
deliveryAddress
Type
object
Description
The delivery address of the transaction
Optional nested attributes (8)
Name
fullAddress
Type
string
Description
Optional full address
Name
street
Type
string
Description
The street of the address. Street name including number.
Name
line2
Type
string
Description
The additional field of the address.
Name
postal
Type
string
Description
The postal code of the address.
Name
city
Type
string
Description
The city of the address.
Name
country
Type
string
Description
The country of the address. An ISO 3166 country code.
Name
state
Type
string
Description
The state of the address. If applicable
Name
name
Type
string
Description
The name of the person receiving delivery.
Name
identification
Type
array<object>
Description
An array of identification items
Name
tickets
Type
array<object>
Description
An array of cart ticket items of the transaction
Required nested attributes (3)
Name
amount
Type
integer
Description
The amount of the cart item.
Name
price
Type
number
Description
The single piece price of the cart item.
Name
ticketTypeId
Type
string
Description
The ID of the ticket type of the cart item.
Optional nested attributes (18)
Name
type
Type
enum(ticket)
Description
The type of the cart item.
Name
_id
Type
string
Description
Unique identifier for the cart item. If omitted, the system will automatically generate one.
Name
name
Type
string
Description
The name of the cart item.
Name
netPrice
Type
number
Description
The single piece net price of the cart item.
Name
taxRate
Type
number
Description
The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.
Name
triggeredBy
Type
oneOf
Description
An ID or an array of IDs of other cart items which triggered the buy action of the cart item.
Name
bundleInfo
Type
object
Description
Optional nested attributes (3)
Name
bundleId
Type
string
Description
Name
componentId
Type
string
Description
Name
optionId
Type
string
Description
Name
categoryRef
Type
string
Description
The category reference of the ticket type.
Name
seatingInfo
Type
object
Description
The associated seating object.
Required nested attributes (2)
Name
_type
Type
enum(6, 7)
Description
Indicates the type of seating object. Seat = 6, General Admission = 7.
Name
statusId
Type
string
Description
The ID of a container holding information about the seating status of the seating object.
Optional nested attributes (9)
Name
_id
Type
string
Description
The ID of the seating object.
Name
categoryId
Type
string
Description
The ID of the category containing the seating object.
Name
name
Type
string
Description
If _type == 7. The name of the general admission.
Name
seatType
Type
enum(handicapped, limitedView, foldable)
Description
If _type == 6. The type of the seat. null = normal.
Name
sectionName
Type
string
Description
If _type == 6. The name of the section where the seat is located.
Name
groupName
Type
string
Description
If _type == 6. The name of the row group where the seat is located.
Name
rowName
Type
string
Description
If _type == 6. The name of the row where the seat is located.
Name
seatName
Type
string
Description
If _type == 6. The seat name.
Name
gate
Type
string
Description
The entry gate associated with the seating object.
Name
slotInfo
Type
object
Description
The associated time slot object.
Required nested attributes (2)
Name
slotId
Type
string
Description
The ID of the time slot.
Name
slotStartTime
Type
string
Description
The start time of the time slot.
Name
asHardTicket
Type
boolean
Description
Whether this ticket is a hard ticket.
Name
listingId
Type
string
Description
Listing in secondary market.
Name
listingItemId
Type
string
Description
The ID of the listing item in the secondary market.
Name
triggeredAutomations
Type
boolean
Description
Whether the cart item triggered automations.
Name
meta
Type
object
Description
Meta data which is propagated to the ticket.
Name
addOns
Type
array<object>
Description
A list of Add-Ons of the ticket.
Required nested attributes (3)
Name
productId
Type
string
Description
Name
productVariantId
Type
string
Description
Name
name
Type
string
Description
Name
capabilities
Type
array<oneOf>
Description
The capabilities of the ticket.
Name
taxInfo
Type
object
Description
The tax info details.
Optional nested attributes (5)
Name
serviceTypeId
Type
string
Description
The ID of the service type.
Name
exceptionId
Type
string
Description
The ID of the exception.
Name
proceedsAccountId
Type
string
Description
The ID of the proceeds account.
Name
proceedsAccountCode
Type
string
Description
The code of the proceeds account.
Name
taxItems
Type
array<object>
Description
The array of tax items.
Required nested attributes (3)
Name
rate
Type
number
Description
Name
perUnit
Type
number
Description
Name
total
Type
number
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number
Description
Name
netPerUnit
Type
number
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
products
Type
array<object>
Description
An array of cart product items of the transaction
Required nested attributes (4)
Name
type
Type
enum(product)
Description
The type of the cart item.
Name
amount
Type
integer
Description
The amount of the cart item.
Name
price
Type
number
Description
The single piece price of the cart item.
Name
productVariantId
Type
string
Description
The ID of the product variant.
Optional nested attributes (8)
Name
_id
Type
string
Description
Unique identifier for the cart item. If omitted, the system will automatically generate one.
Name
name
Type
string
Description
The name of the cart item.
Name
netPrice
Type
number
Description
The single piece net price of the cart item.
Name
taxRate
Type
number
Description
The tax rate to be applied to this cart item. If not present the tax rate of the transaction is taken.
Name
triggeredBy
Type
oneOf
Description
An ID or an array of IDs of other cart items which triggered the buy action of the cart item.
Name
bundleInfo
Type
object
Description
Optional nested attributes (3)
Name
bundleId
Type
string
Description
Name
componentId
Type
string
Description
Name
optionId
Type
string
Description
Name
isFulfillable
Type
boolean
Description
Whether the product can be delivered
Name
taxInfo
Type
object
Description
The tax info details.
Optional nested attributes (5)
Name
serviceTypeId
Type
string
Description
The ID of the service type.
Name
exceptionId
Type
string
Description
The ID of the exception.
Name
proceedsAccountId
Type
string
Description
The ID of the proceeds account.
Name
proceedsAccountCode
Type
string
Description
The code of the proceeds account.
Name
taxItems
Type
array<object>
Description
The array of tax items.
Required nested attributes (3)
Name
rate
Type
number
Description
Name
perUnit
Type
number
Description
Name
total
Type
number
Description
Optional nested attributes (6)
Name
name
Type
string
Description
Name
taxTypeId
Type
string
Description
Name
netTotal
Type
number
Description
Name
netPerUnit
Type
number
Description
Name
taxPayableAccountId
Type
string
Description
Name
taxPayableAccountCode
Type
string
Description
Name
additionalItems
Type
array<oneOf>
Description
An array of additional price items of the transaction
Name
currency
Type
enum(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)
Description
An ISO 4217 3-character code of the currency
Name
regularPrice
Type
number
Description
The regular price of the transaction
Name
paymentCharge
Type
number
Description
The payment charge of the transaction
Name
innerCharge
Type
number
Description
The inner charge of the transaction
Name
outerCharge
Type
number
Description
The outer charge of the transaction
Name
innerFeeComponents
Type
object
Description
The inner fee of the transaction including fix and var fee
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee composition.
Optional nested attributes (2)
Name
fix
Type
array<object>
Description
An array of fee components for the fix fee.
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
var
Type
array<object>
Description
An array of fee components for the var fee.
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
outerFeeComponents
Type
object
Description
The outer fee of the transaction including fix and var fee
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee composition.
Optional nested attributes (2)
Name
fix
Type
array<object>
Description
An array of fee components for the fix fee.
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
var
Type
array<object>
Description
An array of fee components for the var fee.
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
cancellationFee
Type
object
Description
The cancellation fee of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
cancellationInfo
Type
object
Description
The cancellation info of the transaction
Optional nested attributes (1)
Name
cancellableItems
Type
array<object>
Description
An array of cancellable items
Required nested attributes (3)
Name
cartItemId
Type
string
Description
The ID of the cart to which the item belongs to
Name
type
Type
enum(ticket, product, fee, discount, fulfillment, insurance)
Description
The type of the item indicated where it originated from
Name
price
Type
number
Description
The price of the item
Optional nested attributes (6)
Name
name
Type
string
Description
The name of the item
Name
taxRate
Type
number
Description
The applied tax rate for that item
Name
origin
Type
oneOf
Description
Object indicating where the item originated from
Name
cancellationFee
Type
object
Description
The cancellation fee of the item. Is set when cancellation fees are charged at cancellation
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the fee component.
Optional nested attributes (8)
Name
amount
Type
number
Description
The fee amount.
Name
value
Type
number
Description
The fee value.
Name
total
Type
number
Description
The fee total. Calculated with amount and value.
Name
type
Type
enum(onTicket, onHardTicket, onCart)
Description
The fee type of the fee component.
Name
name
Type
string
Description
The name of the fee.
Name
publicName
Type
string
Description
The public name of the fee component.
Name
exposed
Type
boolean
Description
Whether this fee will be exposed to the ticket buyer.
Name
scheme
Type
object
Description
The fee scheme of the fee component.
Optional nested attributes (2)
Name
schemeId
Type
string
Description
The ID of the fee scheme.
Name
feeId
Type
string
Description
The ID of the fee scheme fee.
Name
refundId
Type
string
Description
The ID of the refund. Is set when item was refunded
Name
cancelledAt
Type
string
Description
A date indicating when the item has been cancelled
Name
taxRate
Type
number
Description
The tax rate of the transaction
Name
createdAt
Type
string
Description
An ISO timestamp indicating when the transaction was created
Name
updatedAt
Type
string
Description
An ISO Timestamp indicating when the voucher was last updated
Name
psp
Type
string
Description
Name
paymentMethod
Type
enum(paypal, stripe, local, external, vivenu-payments)
Description
The payment method of the transaction.
Name
paymentInfo
Type
object
Description
The payment info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the payment info
Optional nested attributes (11)
Name
psp
Type
string
Description
Name
gateway
Type
enum(managed, external, local)
Description
The payment gateway of the payment.
Name
providerType
Type
enum(stripeConnect, vivenu)
Description
The payment provider of the payment.
Name
providerId
Type
string
Description
The ID of the provider of the payment
Name
method
Type
string
Description
The method of the payment
Name
methodVariant
Type
string
Description
The method variant of the payment
Name
locale
Type
string
Description
The locale of the payment
Name
riskLevel
Type
string
Description
The risk level of the payment
Name
riskScore
Type
number
Description
The risk score of the payment
Name
refundId
Type
string
Description
The ID of the refund of the payment
Name
collectedApplicationFee
Type
number
Description
The application fee of the payment
Name
paymentStatus
Type
enum(AWAITING, PENDING, RECEIVED, REFUND, CANCELED, FAILED, DISPUTE, CHARGEBACK, POS-RECEIVED, POS-CANCELED, LOCAL-PENDING, LOCAL-AWAITING, LOCAL-RECEIVED, EXTERNAL)
Description
The payment status of the transaction.
Name
origin
Type
enum(yourticket, pos, rebooking, upgrade, subscription)
Description
The origin of the transaction.
Name
userId
Type
string
Description
The ID of the user who created the transaction.
Name
posId
Type
string
Description
The ID of pos of the transaction
Name
posInfo
Type
object
Description
The POS info of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the POS info
Optional nested attributes (6)
Name
sessionId
Type
string
Description
The ID of the session of the POS
Name
billingNo
Type
string
Description
The billing no of the POS
Name
taxId
Type
string
Description
The tax ID of the POS
Name
paymentMethod
Type
string
Description
The payment method of the POS.
Name
canceledAt
Type
string
Description
The cancellation Date of the POS
Name
cancellationNo
Type
string
Description
The cancellation no of the POS
Name
history
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string
Description
The date of the history entry
Name
title
Type
string
Description
The title of the history entry
Name
message
Type
string
Description
A message which describes the history entry
Name
type
Type
enum(PAYMENT, YOURTICKET, USER)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
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.
Name
historyEntries
Type
array<object>
Description
An array of history entry items of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the transaction history entry
Optional nested attributes (5)
Name
date
Type
string
Description
The date of the history entry
Name
userId
Type
string
Description
The ID of the user of the history entry
Name
data
Type
object
Description
The data of the history entry
Name
type
Type
enum(created, reserved, completed, completed.manually, aborted, canceled, partial.canceled, pos.created, pos.canceled, pos.payment.method.changed, payment.canceled, payment.authorized, payment.failed, payment.succeeded, payment.chargeback, payment.localReceived, dispute.created, dispute.countered, dispute.won, dispute.lost, refunded, partial.refunded, refund.failed, partial.refunded.voucher, payment.local.added, payment_correction.refund.missing_in_core, price.recalculated, invitation.reserved.mail, transaction.resent.mail, transaction.resent.ticket_mail, transaction.resent.voucher_mail, tickets.booked, transaction.sent.sms, commented)
Description
The type of the history entry.
Name
risk
Type
enum(DANGER, NEUTRAL, GOOD)
Description
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.
Name
ticketMailSend
Type
boolean
Description
Whether the mail with the ticket of the transaction was sent
Name
orderMailSend
Type
boolean
Description
Whether the mail with the order of the transaction was sent
Name
extraFields
Type
object
Description
The extra fields of the transaction
Name
channel
Type
string
Description
The channel of the transaction
Name
underShop
Type
string
Description
The under shop of the transaction
Name
userAgent
Type
object
Description
The User Agent of the transaction
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the User Agent
Optional nested attributes (6)
Name
ua
Type
string
Description
The user agent
Name
browser
Type
object
Description
The browser of the user
Name
device
Type
object
Description
The device of the user
Name
engine
Type
object
Description
The engine of the user
Name
os
Type
object
Description
The OS of the user
Name
cpu
Type
object
Description
The CPU of the user
Name
ipLookup
Type
object
Description
The IP lookup info of the transaction
Optional nested attributes (2)
Name
ip
Type
string
Description
The IP address of the IP lookup info
Name
lookup
Type
object
Description
The IP lookup result
Optional nested attributes (9)
Name
range
Type
array<number>
Description
The Range of the ip adress
Name
country
Type
string
Description
The country of the IP lookup
Name
region
Type
string
Description
The region of the IP lookup
Name
eu
Type
string
Description
Name
timezone
Type
string
Description
The timezone of the IP lookup
Name
city
Type
string
Description
The city city of the IP lookup
Name
ll
Type
array<number>
Description
Name
metro
Type
number
Description
Name
area
Type
number
Description
Name
locationCenter
Type
array<number>
Description
Name
vouchers
Type
array<string>
Description
An array of voucher codes applied to this transaction
Name
redeemedVouchers
Type
object
Description
An array of voucher codes redeemed for this transaction
Required nested attributes (1)
Name
totalRedeemedAmount
Type
number
Description
The sum of all vouchers applied.
Optional nested attributes (1)
Name
vouchers
Type
array<object>
Description
An array of all redeemed vouchers.
Required nested attributes (2)
Name
code
Type
string
Description
The Code of the voucher.
Name
redeemedAmount
Type
number
Description
The applied value of the voucher.
Optional nested attributes (1)
Name
_id
Type
string
Description
The ID of the voucher.
Name
appliedCoupons
Type
array<object>
Description
An array of applied coupons within the transaction
Optional nested attributes (2)
Name
_id
Type
string
Description
The ID of the applied coupon.
Name
code
Type
string
Description
The code of the applied coupon.
Name
appliedDiscountGroups
Type
array<string>
Description
An array of discount groups applied to the transaction
Name
posDiscounts
Type
array<object>
Description
An array of POS discounts
Required nested attributes (3)
Name
_id
Type
string
Description
The ID of the POS discount
Name
name
Type
string
Description
The name of the POS discount
Name
value
Type
number
Description
The value of the POS discount
Optional nested attributes (1)
Name
discountType
Type
enum(TOTAL, PERCENTAGE, fix, var)
Description
The discount type.
Name
preferredLanguage
Type
enum(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)
Description
The preferred language of the transaction. It is determined automatically
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description
The reason of the cancellation of the transaction
Name
appliedDiscountInfo
Type
object
Description
Applied discountInfo for the transaction
Optional nested attributes (2)
Name
items
Type
array<object>
Description
An array of applied discount info items.
Required nested attributes (1)
Name
_id
Type
string
Description
The ID of the applied discount info item.
Optional nested attributes (6)
Name
itemId
Type
string
Description
The ID of the item on which the discount is applied.
Name
amount
Type
number
Description
The amount of applied discounts.
Name
regularPrice
Type
number
Description
The regular price before applying the discount.
Name
price
Type
number
Description
The price after applying the discount.
Name
varDiscounts
Type
array<object>
Description
An array of var discounts of the applied discount info item.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the discount info.
Name
type
Type
enum(fix, var, fixPerItem, waiveFees)
Description
The type of the discount.
Optional nested attributes (5)
Name
discountId
Type
string
Description
The ID of the discount of the discount info.
Name
category
Type
enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
Description
The category of the discount.
Name
name
Type
string
Description
The name of the discount.
Name
value
Type
number
Description
The value of the discount.
Name
allowedItems
Type
array<string>
Description
An array of the IDs of allowed items of the discount.
Name
fixDiscounts
Type
array<object>
Description
An array of fix discounts of the applied discount info item.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the discount info.
Name
type
Type
enum(fix, var, fixPerItem, waiveFees)
Description
The type of the discount.
Optional nested attributes (5)
Name
discountId
Type
string
Description
The ID of the discount of the discount info.
Name
category
Type
enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
Description
The category of the discount.
Name
name
Type
string
Description
The name of the discount.
Name
value
Type
number
Description
The value of the discount.
Name
allowedItems
Type
array<string>
Description
An array of the IDs of allowed items of the discount.
Name
discounts
Type
array<object>
Description
An array of extended discount info items.
Required nested attributes (2)
Name
_id
Type
string
Description
The ID of the discount info.
Name
type
Type
enum(fix, var, fixPerItem, waiveFees)
Description
The type of the discount.
Optional nested attributes (8)
Name
discountId
Type
string
Description
The ID of the discount of the discount info.
Name
category
Type
enum(coupon, groupDiscount, posDiscount, voucher, system, modifier)
Description
The category of the discount.
Name
name
Type
string
Description
The name of the discount.
Name
value
Type
number
Description
The value of the discount.
Name
allowedItems
Type
array<string>
Description
An array of the IDs of allowed items of the discount.
Name
maxItemsInCart
Type
number
Description
The maximum amount of items the discount will be applied towards.
Name
maxAbsoluteValue
Type
number
Description
The maximum absolute value of the discount.
Name
absoluteDiscountValue
Type
number
Description
The absolute value of the discount.
Name
invoiceVersion
Type
string
Description
The invoice version of the transaction.
Name
seatingReservationToken
Type
string
Description
The seating reservation token of the transaction

Example

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

GET/api/transactions/:id

Get a Transaction

Request

GET

/api/transactions/:id

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

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

POST/api/transactions/:id/cancel

Cancel a Transaction

Payload

Optional attributes

Name
refundFunds
Type
boolean
Description
Whether the received funds should be refunded
Name
cancellationReason
Type
enum(REQUESTED_BY_CUSTOMER, CLAIM, COMMUNICATION_ERROR, TRAINING/TEST)
Description

Request

POST

/api/transactions/:id/cancel

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/cancel', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "refundFunds": true,
    "cancellationReason": "REQUESTED_BY_CUSTOMER"
  }),
})

const data = await response.json()

Response (201)

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

GET/api/transactions/:id/cancellations

Get Transaction cancellation info

Request

GET

/api/transactions/:id/cancellations

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/cancellations', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

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

POST/api/transactions/:id/cancellations

Create a Transaction cancellation

Payload

Required attributes

Name
items
Type
anyOf
Description
Name
refundFunds
Type
boolean
Description
Whether the received funds should be refunded
Name
refundTarget
Type
enum(origin, voucher)
Description
The method to use for refunding the transaction.

Request

POST

/api/transactions/:id/cancellations

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/cancellations', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "items": [
      "string"
    ],
    "refundFunds": false,
    "refundTarget": "origin"
  }),
})

const data = await response.json()

Response (200)

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

POST/api/transactions/:id/complete

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.

Request

POST

/api/transactions/:id/complete

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/complete', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

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

POST/api/transactions/:id/ticket-mail

Send transaction tickets per mail

Payload

Optional attributes

Name
email
Type
string
Description
The email address to which the tickets of the transaction should be sent to

Request

POST

/api/transactions/:id/ticket-mail

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/ticket-mail', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "email": "example@vivenu.com"
  }),
})

const data = await response.json()

Response (200)

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

POST/api/transactions/:id/invitationmail

Send a Transaction reserved invitation mail

Request

POST

/api/transactions/:id/invitationmail

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/invitationmail', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

POST/api/transactions/:id/paymentstatus

Update the payment status

Payload

Required attributes

Name
paymentStatus
Type
enum(LOCAL-RECEIVED)
Description
The target payment status

Request

POST

/api/transactions/:id/paymentstatus

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/paymentstatus', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {token}',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(  {
    "paymentStatus": "LOCAL-RECEIVED"
  }),
})

const data = await response.json()

GET/api/transactions

Get All Transactions

Query parameters

Optional query parameters

Name
id
Type
string
Description
Name
name
Type
string
Description
Name
email
Type
string
Description
Name
coupon
Type
string
Description
Name
start
Type
string
Description
Name
end
Type
string
Description
Name
status
Type
string
Description
Name
paymentStatus
Type
string
Description
Name
posPaymentMethods
Type
string
Description
Name
event
Type
string
Description
Name
customer
Type
string
Description
Name
subscriptionId
Type
string
Description
Name
updatedAt
Type
object
Description
Name
psp
Type
string
Description
Name
top
Type
integer
Description
Name
skip
Type
integer
Description

Request

GET

/api/transactions

const response = await fetch('https://vivenu.com/api/transactions?id=507f191e810c19729de860ea&name=Example+Name&email=example%40vivenu.com&coupon=value&start=value&end=value&status=value&paymentStatus=value&posPaymentMethods=value&event=value&customer=value&subscriptionId=507f191e810c19729de860ea&updatedAt=2030-01-23T23%3A00%3A00.123Z&psp=value&top=1&skip=1', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "docs": [],
  "total": 1
}

GETDEPRECATED/api/transactions/rich

Get all Transactions rich

Query parameters

Optional query parameters

Name
name
Type
string
Description
Name
email
Type
string
Description
Name
coupon
Type
string
Description
Name
start
Type
string
Description
Name
end
Type
string
Description
Name
status
Type
string
Description
Name
paymentStatus
Type
string
Description
Name
event
Type
string
Description
Name
seller
Type
string
Description
Name
customer
Type
string
Description
Name
updatedAt
Type
object
Description
Name
psp
Type
string
Description
Name
top
Type
integer
Description
Name
skip
Type
integer
Description

Request

GET

/api/transactions/rich

const response = await fetch('https://vivenu.com/api/transactions/rich?name=Example+Name&email=example%40vivenu.com&coupon=value&start=value&end=value&status=value&paymentStatus=value&event=value&seller=value&customer=value&updatedAt=2030-01-23T23%3A00%3A00.123Z&psp=value&top=1&skip=1', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

{
  "docs": [],
  "total": 1
}

GET/api/transactions/:id/tickets

Get all Transaction Tickets

Request

GET

/api/transactions/:id/tickets

const response = await fetch('https://vivenu.com/api/transactions/507f191e810c19729de860ea/tickets', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer {token}',
  },
})

const data = await response.json()

Response (200)

[]