Skip to content

Events High Booking API

Akshay Tiwari edited this page Jan 15, 2018 · 10 revisions

1.3 Booking an Event

Intent

booking_event

Request Params Description

KEYWORD DESCRIPTION
EVENT_ID EventsHigh Id of the Event
TICKETS Object specifies the type, quantity and price of tickets purchased in a key-value format
TICKETS Actual Name of the ticket. Must match with the exactly as given in the event JSON.
TICKETS.PRICE Final price of the ticket as visible to the user. If the ticket price is discounted, it should be equal to the discounted price as the given in the event JSON. Otherwise, this should be exactly same as ticket ORIGINAL_PRICE
TICKETS.ORIGINAL_PRICE The actual, non discounted price of the ticket as given in the event JSON.
TICKETS.OCCURRENCE_START_DATE The occurrence start date of the ticket
ATTENDEES Object specifies the information the attendee for the purchased tickets in the form of the array
ATTENDEES.NAME Attendee's full name
ATTENDEES.EMAIL Attendee's email ID. This email is used to send ticket confirmation to the user
ATTENDEES.MOBILE Attendee's mobile number. This mobile number is used to send ticket confirmation to the user
PARAMS Object specifies some extra information about overall transaction
PARAMS.CLIENT_PAYMENT_ID A unique confirmation Id from the client side that can be mapped to the payment transaction done by the user.
PARAMS.SRC Optional. Short version of the client name
PARAMS.REFERER Your website

Payload

{
    "eventID" : $EVENT_ID,
	    "tickets": [{
                "ticket_type" : "$TICKET_TYPE",
	        "price": $PRICE,
	        "originalPrice": $ORIGINAL_PRICE,
	        "quantity": $QUANTITY,
	        "occurence_startDate" : "$OCCURRENCE_START_DATE"
	    }...,
        ]
    "attendees": [{
                "Name": "$NAME",
                "Email": "$EMAIL",
                "Mobile": "$MOBILE"
        }....,
    ],
    "params": {
    	"clientPaymentId": "$CLIENT_PAYMENT_ID",
    	"src": "$SRC",
  	"referrer": "$REFERRER"
    }
}

Response Params Description

KEY DESCRIPTION
NEED_APPROVAL If true, the organizer approval s required before the booking request an be accepted. Please DO NOT accept payment from the user in this case as the ticket is not guaranteed
CONVENIECE_FEE If non-zero, convenience fee is also included in the final amount calculated as payable by the user
CONVENIECE_FEE_USD Convenience fee in US Dollars
COST_FOR_USER The final amount to be charged to the user, including all fees, surcharges, special fees, etc.
COST_FOR_USER_USD The final amount to be charged to the user in US Dollars.
TRID A unique 5-character Events High Transaction ID generated to track this transaction. You should maintain this transaction ID in your records for reconciliation and tracking payments.
EID Events High Id for the event
PAYMENT_URL Contains the URL where the user can be redirected for making the final payment.
TICKET_URL Contains the URL where the Events High Ticket Confirmation can be found.
SPECIAL_FEES If present, a special fee is also charged to the user with the given name.
SPECIAL_FEES_ Special Fee in US Dollars
SPECIAL_FEES_AMOUNT The amount charged to the user as part of the corresponding special fee.

Response Body

{
    "needApproval": $NEED_APPROVAL,
    "convenienceFee": $CONVENIECE_FEE,
    "convenienceFeeUSD": $CONVENIECE_FEE_USD,
    "costForUser": $COST_FOR_USER,
    "costForUserUSD": $COST_FOR_USER_USD,
    "trId": "$TRID",
    "eid": "$EID",
    "paymentURL": "$PAYMENT_URL",
    "ticketURL": "$TICKET_URL",
    "specialFees": $SPECIAL_FEES,
    "specialFeesUSD": $SPECIAL_FEES_USD
}

Error messages

Some error messages, you might get an invalid search request. The HTTP response code, in this case, will be 400.

Status Error message Description
500 Internal Server Error
401 Please specify the eventID eventId is missing
402 Please specify the tickets tickets are missing
403 Please specify the tickets info One or more parameters in tickets are missing
404 Please specify the attendees attendees are missing
405 Please specify the attendees info One or more parameters in attendees are missing
406 Please specify the params info One or more parameters in params are missing
407 Booking Failed Ticket(s) for the selected event and occurrence could not be booked
Clone this wiki locally