API Reference

Get the holder/buyer/addon field details

This api returns mapped attributes of buyer/holder and addon which required to fill data during ticket purchase. To call this api, user have to pass event url, order id which was return in order generation api and authentication key to authenticate user.

Here is the description of response attributes, which returns in the form of JSON.

Attribute

Description

customDisclaimer

It will return disclaimer set by the event host.

discountCoupon

It will return true if any discount coupon is available.

processingFeesToPurchaser

It will return true if the processing fees take from purchaser.

purchaserDetail

It will provide the following purchaser details.

addressRequired

If address required than it will return true else false.

admin

If login user is admin than it will return true.

bidderNumber

It will return a bidder number.

countryCode

It will return a login user's country code.

email

It will return a login user's email id.

firstName

It will return a login user's first name.

hasStaffAccess

It will return true if login user have staff access for specified event.

lastName

It will return a login user's last name.

linkedCard

It will return attached card details with the event.

stripeCards.id

It will return a stripe card id.

stripeCards.last4

It will return a last 4 digits of mapped stripe card.

stripeCards.expmonth

It will return a expiry month of mapped stripe card.

stripeCards.expyear

It will return a expiry year of mapped stripe card.

stripeCards.defaultCard

It will return if mapped card is default card for event.

stripeCards.cardType

It will return a card type details.

userId

It will return unique user id, which is mapped with the user.

userProfilePhoto

It will return user's profile photo image id.

phonenumber

It will provide a user's phone number.

marketingOptIn

It will return true if marketing option is enabled for the user.

ticketAttribute

It will provide a list of ticket attribute detials.

addOnsQuestions

It will provide a details of add on custom questions.

attendees

It will provide require attendee attributes.

attributes

This will provide different required attributes.

  • name

It will show required attributes name.

  • type

It will provide it's type. e.g. text, dropdown etc.

  • value

It will provide custom attributes value.

  • defaultValue

It will provide custom attributes default value.

  • mandatory

It will return true if attribute is required to fill.

  • eventTicketTypeId

It will return list of mapped ticket type id with specific attribute.

header

It will provide selected ticket type's header.

tableId

It will return table id.

tickettypeid

It will return selected ticket type id.

questions

It will gives list of question added for attendee details.

buyerInformationFields

It will returns a require buyer attributes added for the specified ticket type.

buyerQuestions

couponCode

It will return a coupon code.

discountAmount

It will return a discount amount.

hasAddOnAttributes

It will return true if add-on attributes are available.

hasHolderAttributes

It will return true if holder attributes are available.

onlyDonationTicket

It will return true if only donation will be available.

orderData

It will return selected ticket type details.

avgTotalFee

It will return a average total fee on ticket type.

id

It will return a ticket type id.

numberofticket

It will return number of selected tickets.

price

It will return ticket price.

priceWithFee

It will return total payable amount price with fees.

ticketTypeDescription

It will return a ticket type description.

ticketTypeName

It will return a ticket type name.

orderId

It will return order id, which generated based on the ticket reservation.

remainingSeconds

It will provide a remaining time to release the reserved tickets it order didn't confirmed.

showCellPhoneField

It will return true/false to show/hide phone number field.

totalPrice

It will return a total amount based on the selected tickets.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error Code

Error Description

4040200

No Event could be found.

4060426

Order is already paid.

4060425

You have not completed checkout in the allotted time. Please click here to restart the checkout process.

4040100

No User could be found

Language
Credentials
Header
Click Try It! to start a request and see the response here!