API Documentation

Introduction

RTS Ticketing has created an open interface to accommodate third-party access to our sales engine. In order to allow access, we have created an HTTPS server that accepts XML packets.

Credit card payments are processed either through the POS locations’ credit card processing account or through your own processing account. So a separate shopping cart or credit card processing account is not needed, but you have the option of building your own.

Purchased tickets can be redeemed at the location's POS for actual tickets. These tickets can be redeemed using any of three methods:

The credit card that was used to purchase the tickets

The receipt number assigned to the purchase

The bar code that is provided by the purchase response packet.

Note: Some locations do not have bar code readers or the bar code may be illegible when printed on a low-quality printer. It is strongly suggested that the confirmation number is also printed with the bar code.

Communication

Communications with the locations POS server are done using an HTTPS Post of an XML packet. Basic authentication is performed for each Post.

The URL for posting data is:

https://<Theatre RTN Number>.formovietickets.com:<port>/Data.ASP

Note: The listening port is 2235 (not the default web server port 80)

Test Server Information

It is a good idea to develop your application against a test server, and not against a live theatre server. Below is the information for the RTS Test Servers:

!! NOTE: These are not web pages, they cannot be viewed in a browser !!

WorldPay Non-E2E Server (also known as Mercury Classic Server):

The endpoint URL is: https://5.formovietickets.com:2235/Data.ASP

WorldPay E2E Server (also known as Mercury EMV Server):

The endpoint URL is: https://5.formovietickets.com:2245/Data.ASP

Heartland Secure Server:

The endpoint URL is: https://5.formovietickets.com:2255/Data.ASP

TSYS Secure Server:

The endpoint URL is: https://5.formovietickets.com:2265/Data.ASP

The credentials for these servers are:

Schedule and Selling Username: test

Schedule and Selling Password: test

Test Card Information

!! NOTE: The <ChargeAmount> for the test WorldPay cards cannot exceed $10 !!

The test credit card information for the WorldPay Non-E2E server is:

Number 6011-0009-9091-1111

The test credit card information for the WorldPay E2E server is:

Number 6011-0009-9091-1111

The test credit card information for the Heartland Secure server is:

Number 4012-0020-0006-0016

The test credit card information for the TSYS Secure server is:

Number 4012-0000-9876-5439

To obtain a test gift card number, purchase a new gift card, and then use the returned number as your future test gift card number. See Gift Card / Loyalty Card Information in this Knowledge Base for details on purchasing new gift cards.

Performance Schedule

!! NOTE: GZIP Compression is required when requesting schedule data !!

!! NOTE: Sending in <ShowAvalTickets> and <ShowSales> values that do not match the settings on the locations configured schedule API account will result in a 401 – Unauthorized error !!

Performance Schedule - Sample Request Packet

<Command>ShowTimeXml</Command>

</Request>

Performance Schedule - Sample Response Packet

<LinkPrefix> https://www.readyticket.net/webticket/webticket2.aspWCI=BuyTicket&WCI=

</LinkPrefix>

<Name>Adult</Name>

</Ticket>

<Name>Child</Name>

</Ticket>

</Tickets>

<Films>

<Film>

<Title>+21 STRANGE TITLE</Title>

<TitleShort>+21 STRANGE TITLE</TitleShort>

<WebSite>http://www.rts-solutions.com</WebSite>

<Shows>

<Show>

<TIs>

<TI>

</TI>

<TI>

</TI>

</TIs>

</Show>

</Shows>

</Film>

</Films>

</ShowSchedule>

</Response>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	Char	Yes	ShowTimeXml
ShowAvalTickets	None	Integer	No	Not 1 = Do not return available tickets (default) 1 = Return available tickets
ShowSales	None	Integer	No	Not 1 = Do not return sales (default) 1 = Return sales

Node	Child Node	Type	Required	Description <ShowSchedule>
FileVersion	None	String	Yes	1.1
RtsVersion	None	String	Yes	Version of the POS
LinkPrefix	None	String	Yes	Used to construct a direct ticketing link for a performance
Tickets	Ticket	Sub Node	Maybe	Lists available tickets
Films	Film	Sub Node	Yes	Lists films scheduled

Node	Child Node	Type	Required	Description <Ticket>
Code	None	String	Yes	Ticket code used in purchase transactions
Name	None	String	Yes	Ticket name as it should be displayed on the Internet
Price	None	Decimal	Yes	Total ticket price
Tax	None	Decimal	Maybe	Any tax included in the ticket price

Node	Child Node	Type	Required	Description <Film>
Title	None	String	Yes	Film title name
Length	None	String	Yes	Film length (minutes)
WebSite	None	String	Maybe	URL associated with the film in the POS
FilmCode	None	String	Maybe	RTS Film Code setup in the POS
Shows	Show	Sub Node	Yes	List of available shows for a film

Node	Child Node	Type	Required	Description <Show>
DT	None	String	Yes	Showing time (yyyyMMddhhmm)
Aud	None	String	Yes	Auditorium name
ID	None	String	Yes	Performance ID, used in purchase transactions
Link	None	String	Maybe	URL to purchase tickets page. The <LinkPrefix> is inserted before this tag when creating the complete URL
RE	None	Integer	Maybe	Number of seats remaining in the auditorium
Sold	None	Integer	Maybe	Number of seats sold in the auditorium
SO	None	Integer	Maybe	1 if show is sold out (internet) state
SOGen	None	Integer	Maybe	1 if show is sold out (general) state
LI	None	Integer	Maybe	1 if show is in low seats state
TIs	TI	Sub Node	Maybe	List of tickets available for this show

Selling - Fees and Adjustments

The Open Interface API currently allows for 2 different types of Fees, and an Adjustment.

The <TicketFee> item is a single charge added to the transaction.

The <TransactionFee> item is a single charge added to the transaction.

The <Adjust> item is an adjustment used to modify the charge amount. If you sell 3 tickets with -$1 in this item, it will deduct $1 from your transaction amount. This amount can be positive or negative, depending on how you wish to adjust the transaction.

All three of these items are placed inside the <Fees> tags inside the purchase packet. These items can be used in any purchase packet: tickets, items, gift cards, etc.

Gift Card / Loyalty Card Information

Gift Card / Loyalty Card - Sample Request Packet

<Command>GiftInformation</Command>

<Data>

</GiftCards>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	CollapseDescription <Show>
Version	None	Char	Yes	1
Command	None	String	Yes	GiftInformation
Data	Packet	Sub Node	Yes
Packet	GiftCards	Sub Node	Yes
GiftCards	GiftCard	Sub Node	Yes
GiftCard	None	String	Yes	Gift card number

Gift Card / Loyalty Card - Sample Response Packet – Non-Registered Card

</GiftCard>

</Packet>

</Response>

Gift Card / Loyalty Card (With PIN) - Sample Request Packet

<Command>GiftInformationWithPIN</Command>

<Data>

</GiftCard>

</GiftCards>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	GiftInformation
Data	Packet	Sub Node	Yes
Packet	GiftCards	Sub Node	Yes
GiftCards	GiftCard	Sub Node	Yes
GiftCard	None	String	Yes	One <GiftCard> node for each card in request
CardNumber	None	String	Yes	Gift card number
CardPIN	None	String	Yes	Gift card PIN

Gift Card / Loyalty Card (With PIN) - Sample Response Packet – Non-Registered Card

</GiftCard>

</Packet>

</Response>

Gift Card / Loyalty Card - Sample Response Packet – Registered Card

!! NOTE: RTS mag cards are the only type that will return registration data !!

<City>DOEVILLE</City>

</RegisteredInfo>

</TicketCredit>

<TitleRestriction>WORLD WAR Z</TitleRestriction>

</TicketCredit>

<Item>SM POPCORN</Item>

</ItemCredit>

</CardCredits>

</GiftCard>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
Code	None	Integer	Yes	-1
Packet	GiftCard	Sub Node	Yes
GiftCard	RegisteredInfo	Sub Node	Yes
GiftCard	CardCredits	Sub Node	Yes
GiftNumber	None	String	Yes	Gift card number
DebitRemain	None	Decimal	Yes	Gift card remaining balance
Registered	None	Integer	Yes	0 = not registered, 1 = registered

Node	Child Node	Type	Required	Description <RegisteredInfo>
FirstName	None	String	Yes	Customer first name
LastName	None	String	Yes	Customer last name
Address1	None	String	Yes	Customer street address 1
Address2	None	String	Yes	Customer street address 2
City	None	String	Yes	Customer city
State	None	String	Yes	Customer state
Postal	None	String	Yes	Customer postal code

Node	Child Node	Type	Required	Description <CardCredits>
TicketCredit	None	Sub Node	No
ItemCredit	None	Sub Node	No

Node	Child Node	Type	Required	Description <TicketCredit>
Expiration	None	String	Yes	None = No expiration date, or date of expiration (yyyyMMddhhmmss)
StartDate	None	String	Yes	None = No start date, or date ticket credit becomes valid (yyyyMMddhhmmss)
Amount	None	Integer	Yes	Amount of tickets available
TitleRestriction	None	String	Yes	Empty node = no restriction, or title of movie this credit is good for
TicketRestriction	None	String	Yes	Empty node = no restriction, or name of ticket this credit is good for

Node	Child Node	Type	Required	Description <ItemCredit>
Expiration	None	String	Yes	None = No expiration date, or date of expiration (yyyyMMddhhmmss)
StartDate	None	String	Yes	None = No start date, or date item credit becomes valid (yyyyMMddhhmmss)
Amount	None	Integer	Yes	Amount of item available
Item	None	String	Yes	Name of item credit is good for

Gift Certificate Generation

New Gift Card Generation - Sample Request Packet

<Data>

</PurchaseGift>

</PurchaseGifts>

</Payments>

</Packet>

</Data>

</Request>

Gift Certificate Purchasing

New Gift Card Purchase - Sample Request Packet

<Data>

</PurchaseGift>

</PurchaseGifts>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

Add Money to Existing Gift Card Purchase - Sample Request Packet

<Data>

</PurchaseGift>

</PurchaseGifts>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <PurchaseGifts>
PurchaseGifts	PurchaseGift	Sub Node	No	Contains one or more gift card purchases
Amount	None	Decimal	Yes	Amount to add to the gift card
GiftCard	None	String	No	If specified, amount will be added to the gift card. If not specified, a new number will be generated and the amount added to the new number

Gift Card Purchase - Sample Response Packet

</GiftPurchase>

</GiftPurchases>

</Response>

</Packet>

</Response>

Loyalty Card Information

Registering a Loyalty Card – Sample Request Packet

<Command>GIFTINFORMATION</Command>

<Data>

<Address1>Address Line 1</Address1>

<Address2>Address Line 2</Address2>

<State>The State</State>

<Postal>Postal Code</Postal>

<Email>Support@rts-solutions.com</Email>

</RegisterCard>

</RegisterCards>

</Data>

</Request>

You can register multiple cards by passing in additional <RegisterCard> nodes.

You can have RTS generate a new card number by passing ASSIGNNEW as the card number

Node	Child Node	Type	Required	CollapseDescription <Request>
Version	None	integer	Yes	1
Command	None	String	Yes	GIFTINFORMATION
Data	RegisterCards	Sub Node	Yes
RegisterCards	RegisterCard	Sub Node	Yes
CardNumber	None	String	Yes	Card number to register
FirstName	None	String	Yes	Customer first name
LastName	None	String	Yes	Customer last name
Address1	None	String	Yes	Customer street address 1
Address2	None	String	Yes	Customer street address 2
City	None	String	Yes	Customer city
State	None	String	Yes	Customer state
Postal	None	String	Yes	Customer postal code
RegisteredID	None	String	Yes	????
Email	None	String	Yes	Customer email address
DOB	None	String	Yes	Customer date of birth
DoNotEmail	None	String	Yes	0 = email, 1 = do not email

Ticket Purchasing – Check Sold Out

Checking Performance Sold / Remaining / SoldOut Levels – Sample Request Packet

<Command>CheckSoldOut</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	CollapseDescription <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	CheckSoldOut
PerformanceID	None	String	Yes	The PerformanceID for the show to check

Checking Performance Sold / Remaining / SoldOut Levels – Sample Response Packet

<SoldOut_General>2</SoldOut_General>

<SoldOut_Internet>5</SoldOut_Internet>

</Response>

Node	Child Node	Type	Required	CollapseDescription <Response>
Version	None	Char	Yes	1
Sold	None	Integer	No	Number of tickets sold to this performance
IsReserved	None	Integer	No	0 = General Admission, 1 = Reserved
TotalSeats	None	Integer	No	Total number of seats for the show
SoldOut_General	None	Integer	No	General sold out seats remaining level
SoldOut_Internet	None	Integer	No	Internet sold out seats remaining level

An example of the levels meaning is: 500 seats total, Internet Sold Out happens with 5 seats remaining. Internet Sold Out happens when Sold hits 495.

If the number of tickets in a transaction is greater than the number seats remaining until Internet Sold Out happens, the transaction will fail.

Ticket Purchasing – Check Redeem

This call allows you to see the status of a ticket redemption. If the tickets have not yet been redeemed, the transaction could be refunded or reversed. If the tickets have already been redeemed by the customer, the transaction cannot be altered.

This command will only find tickets whose pickup times is between Now - The Pickup Ticket Block Time and Now + 180 Days. The Pickup Ticket Block Time can be set via Setup -> Tickets -> Options - Block Pickup Tickets After Minutes

Checking Ticket Redemption Status – Sample Request Packet

<Command>CheckRedeem</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	CheckRedeem
PickupNumber	None	String	Yes	The PickupNumber from the sale transaction

Checking Ticket Redemption Status – Sample Response Packet

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
Redeemed	None	Boolean	Yes	0 = Not Redeemed, 1 = Redeemed

Ticket Purchasing – Verify Transaction

This call allows you to see if a transaction was successfully received and processed. If, for example, you passed in a buy request (that uses the <ThirdPartyID> node) and never received a response from the point-of-sale, this call can be used to see if the transaction was received and processed.

Found transactions will return the <PickupNumber> associated with the purchase.

Verify Transaction Status – Sample Request Packet

<Command>VERIFYTRANSACTION</Command>

<Data>

<ThirdPartyID>63a96a1c66d44b568b3115aeeadc6b12</ThirdPartyID>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	VerifyTransaction
ThirdPartyID	None	String	Yes	Your ID for the sale transaction (must have been passed in with the original sale)
TransactionDateTimeUTC	None	String	Yes	The sale transaction date/time in UTC (format:yyyyMMddhhmmss).

Verify Transaction Status – Sample Response Packet

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
TransactionFound	None	Boolean	Yes	0 = Not Found, 1 = Found
PickupNumber	None	String	No	If transaction found, this will be the pickup number for the customer redemption.

Ticket Purchasing – Transaction Details

This call lets you retrieve the details of a previous transaction by the PickupNumber associated with the purchase.

Transaction Details – Sample Request Packet

<Command>TRANSACTIONDETAILS</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	TransactionDetails
PickupNumber	None	String	Yes	The PickupNumber from the sale transaction

Transaction Details – Sample Response Packet

<Title>ALIEN: COVENANT</Title>

<Status>Redeemed - Online</Status>

<Type>senior</Type>

</Ticket>

</Tickets>

</Performance>

</Performances>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
TransactionFound	None	Boolean	Yes	0 = Not Found, 1 = Found
Performances	Performance	Sub Node	No	If transaction found, this will contain the Performance(s) in the transaction.

Node	Child Node	Type	Required	Description <Performances>
Performance	None	Sub Node	No	If transaction found, there will be 1 or more Performance nodes,depending on the transaction contents

Node	Child Node	Type	Required	Description <Performance>
Title	None	String	Yes	The title for this performance
DateTime	None	String	Yes	Performance start time (MMddyyyyhhmm)
Auditorium	None	String	Yes	The auditorium this performance is in
Tickets	Ticket	Sub Node	Yes	The tickets for this performance

Node	Child Node	Type	Required	Description <Tickets>
Ticket	None	Sub Node	No	If transaction found, there will be 1 or more Performance nodes, depending on the transaction contents

Node	Child Node	Type	Required	Description <Ticket>
Status	None	String	Yes	The current status of the ticket pickup: Valid - Ticket is available for redemption Expired - Ticket has expired Refunded - Transaction was refunded via the API Reversed - Transaction was reversed via the API Redeemed - Online - Ticket was picked up via the API Redeemed - Printed - Ticket was picked up in theatre
PickupDateTime	None	String	Yes	Will be present if the ticket is not "Valid" or "Expired" (MMddyyyyhhmm)
PickupLocation	None	String	Yes	Will be present if the ticket was picked up in theatre
PickupUser	None	String	Yes	Will be present if the ticket was picked up in theatre
Type	None	String	Yes	The type of ticket purchased
IsReserved	None	Boolean	Yes	0 = Not reserved, 1 = Reserved
Section	None	String	Yes	Will be present if the ticket is reserved, indicates the section name the reserved seat is in
RowDesc	None	String	Yes	Will be present if the ticket is reserved, indicates the Row description
ColDesc	None	String	Yes	Will be present if the ticket is reserved, indicates the Column (or Seat) description

Ticket Purchasing – Redeem Tickets

This call lets you tell the POS system that you have redeemed tickets via a 3rd party app.

Redeem – Sample Request Packet

<Command>REDEEM</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	TransactionDetails
PickupNumber	None	String	Yes	The PickupNumber from the sale transaction

Redeem – Sample Request Packet

<Type>senior</Type>

</Ticket>

</ValidTickets>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
HasRedemptions	None	Boolean	Yes	Whether or not the transaction has tickets available for pickup - 0 = False, 1 = True
HasExpirations	None	Boolean	Yes	Whether or not the transaction contains tickets to shows at a prior date/time - 0 = False, 1 = True
HasPickedUp	None	Boolean	Yes	Whether or not the transaction has tickets that have been picked up - 0 = False, 1 = True
ValidTickets	Ticket	Sub Node	No	If there are redemptions, this node will indicate the tickets being redeemed
ExpiredTickets	Ticket	Sub Node	No	If there are expirations, this node will indicate the tickets that have expired
PickedUpTickets	Ticket	Sub Node	No	If there are already redeemed tickets, this node will indicate the tickets already redeemed

Node	Child Node	Type	Required	Description <Ticket>
Type	None	String	Yes	The type of ticket purchased
IsReserved	None	Boolean	Yes	0 = Not reserved, 1 = Reserved
Section	None	String	Yes	Will be present if the ticket is reserved, indicates the section name the reserved seat is in
RowDesc	None	String	Yes	Will be present if the ticket is reserved, indicates the Row description
ColDesc	None	String	Yes	Will be present if the ticket is reserved, indicates the Column (or Seat) description

Ticket Purchasing – Refunds

Only use this call if you are processing the credit card transactions outside of the point-of-sale system!

Whole Transaction Refund – Sample Request Packet

<Command>Refund</Command>

<Data>

<Fees>

</Fees>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	CollapseDescription <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	Refund
Fees	None	Sub Node	Yes
TicketFee	None	Decimal	Yes	The ticket fee from the sale transaction
TransactionFee	None	Decimal	Yes	The transaction fee from the sale transaction
Adjust	None	Decimal	Yes	The sale transaction total (positive amount).
PickupNumber	None	String	Yes	The PickupNumber from the sale transaction

Partial Transaction Refund - Sample Request Packet

<Command>Refund</Command>

<Data>

<Fees>

</Fees>

</PartialRefund>

<Seat>

</Seat>

</Ticket>

</Tickets>

</PartialRefund>

</Ticket>

</Tickets>

</PartialRefund>

</PartialRefunds>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	Refund
Fees	None	Sub Node	Yes
TicketFee	None	Decimal	Yes	The ticket fee from the sale transaction
TransactionFee	None	Decimal	Yes	The transaction fee from the sale transaction
Adjust	None	Decimal	Yes	The sale transaction total (positive amount).
PickupNumber	None	String	Yes	The PickupNumber from the sale transaction, from any <TicketDay> in the purchase response
PartialRefunds	PartialRefund	Sub Node	Yes

Node	Child Node	Type	Required	Description <PartialRefunds>
PartialRefund	None	Sub Node	Yes	Include this node for each partial refund action you want to take

Node	Child Node	Type	Required	Description <PartialRefund>
PerformanceID	None	String	Yes	The performance ID for the performance you want to refund against
Tickets	Ticket	Sub Node	No	If not present, will refund all tickets for this performance

Node	Child Node	Type	Required	Description <Ticket>
Amount	None	Integer	Yes	General Admission: The number of tickets to refund. Reserved Seating: Will be 1 and <Seat> is required
TypeCode	None	String	No	The ID of the ticket type being refunded
Seat	None	Sub Node	No	If performance is reserved seating this is where you specify the seat to be refunded

Node	Child Node	Type	Required	Description <Seat>
Section	None	String	Yes	The section ID for the seat being refunded
Row	None	Integer	Yes	The row index for the seat being refunded
Col	None	Integer	Yes	The col index for the seat being refunded

Refund – Sample Response Packet

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
Code	None	Char	Yes	-1
TransactionFound	None	Boolean	Yes	0 = Not Found, 1 = Found
PickupNumber	None	String	No	If transaction found, this will be the pickup number for the customer redemption.

Ticket Purchasing – Reverse Transaction

Only use this call if you are processing the credit card transactions outside of the point-of-sale system!

Allows for reversal of a sale transaction by ThirdPartyID, in the event that you never received a response with a PickupNumber. It will be allowed as long as the tickets from the sale have not already been redeemed, and the show is still scheduled. Should be used in conjunction with “VerifyTransaction” to establish the state of the sale.

Node	Child Node	Type	Required	Description <Request>
Version	None	Char	Yes	1
Command	None	String	Yes	Refund
Fees	None	Sub Node	Yes
TicketFee	None	Decimal	Yes	The ticket fee from the sale transaction
TransactionFee	None	Decimal	Yes	The transaction fee from the sale transaction
Adjust	None	Decimal	Yes	The sale transaction total (positive amount).
ThirdPartyID	None	String	Yes	Your ID for the sale transaction (must have been passed in with the original sale)

ReverseTransaction – Sample Response Packet

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
TransactionFound	None	Boolean	Yes	0 = Not Found, 1 = Found
PickupNumber	None	String	No	If transaction found, this will be the pickup number for the customer redemption.

WorldPay E2E - Credit Card Payment Overview

The introduction of End-to-End Encryption to the credit card processing system has changed the way credit cards are processed by the software. Instead of the software processing the transaction, it is processed directly at the processor via a HostedCheckout system. This means the customer needs to be redirected to a secure credit card entry page that is provided by the credit card processing company.

To summarize the process:

1. A request is sent into the software to create a payment at the processor. This request contains the charge amount to authorize and 2 URLs: a ProcessCompleteUrl, and a ReturnUrl. Be sure to URL Encode your URLs.

2. The software will return a create payment response which indicates if the create was successful, a TransactionId, a RedirectURL to send the customer to for credit card information entry, and the PostData to send into the processor page you redirect the customer to. If the create was unsuccessful there will be an ErrorMsg present to indicate the issue.

3. The customer will then need to be redirected to the RedirectURL in the create payment response, posting in the PostData in the create payment response. If the customer completes the process the processor will redirect back to the ProcessCompleteURL from step 1, which will contain the processor response in the PostData. If the customer cancels the process, the processor will redirect back to the ReturnURL.

4. If the payment was successful, a Buy request is then sent back to the software with the TransactionId, ProcessCompletePostData included in the Payment node. The software will then validate the payment and return either a failure or a success.

It is important to note that you could repeat steps 1 – 3 for multiple credit cards if needed, then simply include multiple Payment nodes in step 4. Be sure to authorize each payment for only the amount needed, not the total transaction amount.

Credit Card Payments (WorldPay E2E)

Create a HostedCheckout Payment – Sample Request

<Command>CreatePayment</Command>

<Data>

http%3A%2F%2Flocal.formovietickets.com%2FT.asp%3FWCI%3DBT%26Page%3DConfirm%26Mode%3DCCPAYRESPONSE

</ProcessCompleteUrl>

http%3A%2F%2Flocal.formovietickets.com%2FT.asp%3FWCI%3DBT%26Page%3DConfirm%26Mode%3DPayments

</ReturnUrl>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
ChargeAmount	None	Decimal	Yes	The amount this payment will authorize for.
ProcessCompleteUrl	None	String	Yes	The URL the customer will be redirected back to after they complete the credit card entry process
ReturnUrl	None	String	Yes	The URL the customer will be redirected back to if they cancel the credit card entry process

Create a HostedCheckout Payment – Sample Response

<RedirectUrl>https%3A%2F%2Fhc.mercurydev.net%2FCheckout.aspx</RedirectUrl>

</CreatePayment>

</Packet>

</Response>

Ticket Purchase (WorldPay E2E) – Sample Request – PerformanceID

Note: See Ticket Purchasing – General Admission and Ticket Purchasing – Reserved Seating for additional information on the Buy packet nodes

<Data>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

PaymentID=cf679a14-dd17-4c0a-b151-be0fdcb27dfd&ReturnCode=0&ReturnMessage=Your+transaction+has+been+approved.

</ProcessCompletePostData>

</Payment>

</Payments>

<EmailAddress>testemail@yahoo.com</EmailAddress>

</CustomerInfo>

</Packet>

</Data>

</Request>

Ticket Purchase (WorldPay E2E) – Sample Response

<Type>Transaction</Type>

</BarCode>

</BarCodes>

</Pickup>

</Pickups>

</Response>

</Packet>

</Response>

Heartland Secure - Credit Card Payment Overview

Heartland Secure utilizes JavaScript to replace <div> elements in your payment form with secure hosted iframe fields, to ensure that no card data passes through your server (or the RTS server).

The customer enters their card data into these iframe fields and submits to Heartland. They will issue a single-use token and some safe card information (masked card number, card type, card last 4) returning it as JSON to the script. This data is then posted to your server via the form action on the page.

When attempting the sale, the single-use token and the safe card data is submitted in the buy request to RTS in the <Payment> node. We will validate the credit account data and either proceed with the sale, or return an error indicating the issue with the card.

A sample payment page can be found here: http://www.readyticket.net/download/heartland_hc_example.html

Be sure to read the comments in the sample payment page for additional information!

The script utilizes a Public Key, which will change for each RTS location. You will need to contact RTS to get this key when needed, you can email the request to: support@rts-solutions.com. Be sure to include the location name and address in the request.

Below is sample of the post data from the form:

billingStreet=6860+Dallas+Pkwy&billingZip=75024&paymentReference=supt_htOWF0W14NdVKt6DAHi1HbM3&maskedCard=464069***4998&cardLast4=4998&cardType=visa

Below is a sample <Payment> node for a Heartland Secure buy request:

<Type>CreditCard</Type>

<SingleUseToken>supt_ycyDB65WX8B2TCWvaSOGIz4j</SingleUseToken>

<BillingStreet>6860 Dallas Pkwy</BillingStreet>

</Payment>

The <SingleUseToken>, <MaskedCardNumber>, <CardType>, <CardLast4>, <BillingStreet>, and <BillingZip> values come from the data returned by the Heartland JavaScript.

Note: In the case that both Address and Zip do not match the account, you will receive a DO NOT HONOR message from Heartland's Gateway

Ticket Purchasing (3rd Party Credit Card Processing / TSYS - E2E)

1. Integrator sends in a CreatePayment request, provides their complete url and cancel URL:

<Command>CreatePayment</Command>

<Data>

<ProcessCompleteUrl>http%3A%2F%2F809261.formovietickets.com%3A2265%2FTSYS.asp%3FreqType%3DCOMPLETE</ProcessCompleteUrl>

<ReturnUrl>http%3A%2F%2F890261.formovietickets.com%3A2265%2FTSYS.asp%3FreqType%3DCANCEL</ReturnUrl>

</Packet>

</Data>

</Request>

2. RTS creates a transactionID, stores the request data.

3. RTS returns transactionID, redirectUrl

<RedirectUrl>https%3a%2f%2f809261.formovietickets.com%3a2265%2fTSYS.ASP%3freqType%3dREDIRECT%26transactionId%3de9fb3f66-4dc8-4745-b354-b74900e32010</RedirectUrl>

</CreatePayment>

</Packet>

</Response>

4. Integrator redirects customer to the redirectUrl, which provides the stand-alone payment page

a. Continue - RTS attempts payment, posting return data to the integrators ProcessCompleteURL

b. Cancel - RTS redirects the customer to the integrators ReturnURL

5. Integrator receives response based on status of credit card processing:

a. if good sale, send back the masked card number, cardlast4, cardtype, transactionid, and paymentid

POST Data:

maskedCardNumber=<appropriate_masked_card_num>&cardLastFour=<appropriate_card_last_four>&cardType=<appropriate_card_type>&transactionId=<appropriate_transactionid>&paymentId=<appropriate_paymentid>

b. if bad cardverification or sale, send back the appropriate response

6. If integrator wants to continue with transaction, posts in the appropriate buy request, with the <payment> node as follows:

<Type>CreditCard</Type>

</Payment>

7. RTS attempts to complete the transaction, and returns the appropriate response

Ticket Purchasing (3rd Party Credit Card Processing / TSYS - Non E2E)

This method of ticketing purchasing is to be used when the RTS software is not handling anything in the credit card processing chain.

Ticket Purchase (3rd Party) – Sample Request – PerformanceID

Note: The key differences between a 3rd party buy and a normal buy is the use of the <Adjust> node inside <Fees> to offset the amount charged by the 3rd party, and the <ChargeAmount> being zero.

<Data>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

</Payment>

</Payments>

<EmailAddress>testemail@yahoo.com</EmailAddress>

</CustomerInfo>

</Packet>

</Data>

</Request>

Ticket Purchasing – General Admission

The performance you wish to purchase can be specified in 3 different ways:

Title, ShowTime, and AuditoriumID
PerformanceID
MtFilmCode, MTPerformanceID, and ShowTime

Ticket Purchase - Sample Request – Title, ShowTime, and AuditoriumID

<Data>

<Title>The Title</Title>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

<Cards>

</Cards>

</Loyalty>

<EmailAddress>testemail@yahoo.com</EmailAddress>

</CustomerInfo>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <PurchaseTitle>
Title	None	String	Yes	Performance Title
ShowTime	None	String	Yes	Performance start time (yyyyMMddhhmm)
Auditorium	None	String	Yes	Performance auditorium number
Tickets	Ticket	Sub Node	Yes	One or more ticket types to purchase

Ticket Purchase - Sample Request – PerformanceID

<Data>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

<Cards>

</Cards>

</Loyalty>

<EmailAddress>testemail@yahoo.com</EmailAddress>

</CustomerInfo>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <PurchaseTitle>
PerformanceID	None	String	Yes	The PerformanceID
Tickets	Ticket	Sub Node	Yes	One or more ticket types to purchase

Ticket Purchase - Sample Request – MtFilmCode, MtPerformanceID, and ShowTime

<Data>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

<Cards>

</Cards>

</Loyalty>

<EmailAddress>testemail@yahoo.com</EmailAddress>

</CustomerInfo>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <PurchaseTitle>
MtFilmCode	None	String	Yes	Movietickets.com film code
MtPerformanceID	None	String	Yes	Movietickets.com PerformanceID
ShowTime	None	String	Yes	Performance start time (yyyyMMddhhmm)
Tickets	Ticket	Sub Node	Yes	One or more ticket types to purchase

To sell multiple tickets in the same transaction, duplicate the <Ticket> node for each type and specify the amount of each ticket.

For example, to sell 3 tickets of 2 different types, your <Tickets> node would look like:

</Ticket>

</Ticket>

</Tickets>

To accept multiple payment types in the same transaction, duplicate the <Payment> node for each type of payment, and specify the appropriate information.

For example, to take credit card and gift card, your <Payment> node would look like:

<Type>CreditCard</Type>

</Payment>

</Payment>

</Payments>

Node	Child Node	Type	Required	Description <Ticket>
Amount	None	Integer	Yes	Number of this type of ticket to purchase
TypeCode	None	String	Yes	Ticket type code (from schedule XML)

Node	Child Node	Type	Required	Description <Fees>
TicketFee	None	Decimal	No	Amount to charge for ticket fees in the transaction. Recorded in the POS as the configured 'Ticket Fee' item.
TransactionFee	None	Decimal	No	Amount to charge for the transaction fees in the transaction. Recorded in the POS as the configured 'Transaction Fee' item.
Adjust	None	Decimal	No	Allows for positive or negative adjustment to the charge amount. Recorded in the POS as the configured 'Adjust' item.

Node	Child Node	Type	Required	Description <Payments>
Payments	Payment	Sub Node	Yes	Contains one or more payment types for a transaction

Node	Child Node	Type	Required	Description <Payment>
Type	None	String	Yes	Specifies the payment type: CreditCard or Gift
Number	None	String	Yes	Credit card number
GiftNumber	None	String	Yes	Gift card number
GiftCardPIN	None	String	Maybe	Certain gift card processors in RTS can be marked as requiring a PIN during purchase. If this is enabled, this node is required.
Expiration	None	String	Yes	Credit card expiration date (MMyy)
AvsStreet	None	String	No	Credit card billing street address
AvsPostal	None	String	No	Credit card billing postal code
CID	None	String	No	Credit card CID (CVV, Security Code) number
NameOnCard	None	String	No	Credit card customer name
ChargeAmount	None	Decimal	Yes	Amount to charge on the credit or gift card

Node	Child Node	Type	Required	Description <ThirdPartyID>
ThirdPartyID	None	Sub Node	No	Allows you to specify a transaction ID to the purchase, this can be used with “VerifyTransaction” to check for completion of the sale if normal response is not received.

Node	Child Node	Type	Required	Description <Loyalty>
Loyalty	Cards	Sub Node	No
Type	None	String	No	Earn
CardNumber	None	String	No	Card number to use for loyalty earn. Multiple cards can be passed in via additional <CardNumber> tags

Node	Child Node	Type	Required	Description <CustomerInfo>
EmailAddress	None	String	No	Customer email address. Can be used to look-up transactions in the POS. NOTE: There is an option on the API selling account to have RTS send a confirmation email on a successful purchase. This email is NOT customizable.

Ticket Purchase - Sample Response

<Type>Transaction</Type>

</BarCode>

</BarCodes>

</Pickup>

</Pickups>

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Integer	Yes	1
Code	None	Integer	Yes	-1
Packet	Response	Sub Node	Yes
ResponseText	None	String	Yes	OK
TransactionID	None	String	Yes	Transaction receipt number
Pickups	Pickup	Sub Node	Yes
TicketDay	None	String	Yes	Date of performance (yyyyMMdd)
PickupNumber	None	String	Yes	Not currently used
BarCodes	BarCode	Sub Node	Yes
Type	None	String	Yes	Transaction
CodeType	None	String	Yes	The bar code type: UPC
BarCodeData	None	String	Yes	The confirmation number to be encoded. BAR CODE IMAGE IS NOT PROVIDED BY THE POS.

Seating Charts

All RTS layouts are built around the grid size provided in the <GridRef> node. Using these values in conjunction with your own known grid values, you can determine the ratio needed to convert each seat xpos, ypos, width, and height, to your own values, for example:

Your grid width divided by our grid width = your X ratio

Your grid height divided by our grid height = your Y ratio

Our Xpos multiplied by X ratio = your Xpos

Our Ypos multiplied by Y ratio = your Ypos

Our Width multiplied by X ratio = your width

Our Height multiplied by Y ration = your height

Get Seat Layouts – Sample Request

<Command>GetSeatLayouts</Command>

</Request>

This call allows you to pull the reserved seating layouts for all of the auditoriums in the point-of-sale system. It also includes a list of seat types configured in the system, so that any custom seat types are available to you.

Get Seat Layouts – Sample Response

</GridRef>

<Type>

<CustomerName>Normal</CustomerName>

</Type>

......

<Type>

<CustomerName>CompanionLeft</CustomerName>

</Type>

</SeatTypes>

<LayoutName>Reserved Auditorium 13</LayoutName>

<SectionName>Section 1</SectionName>

<Seats>

<Seat>

</Seat>

......

<Seat>

</Seat>

</Seats>

</Layout>

</Layouts>

</Response>

Node	Child Node	Type	Required	Description <GridRef>
Width	None	Integer	Yes	The relative grid width
Height	None	Integer	Yes	The relative grid height

Node	Child Node	Type	Required	Description <SeatTypes>
Type	None	Sub Node	Yes
ID	None	Integer	Yes	The ID of the SeatType
CustomerName	None	String	Yes	The customer name for the SeatType

Node	Child Node	Type	Required	Description <Layouts>
Layout	None	Sub Node	Yes	There will be a <Layout> node for each system layout
LayoutName	None	String	Yes	The name of the layout
SectionName	None	String	Yes	The name of the section
SectionID	None	Integer	Yes	The ID of the section
Seats	Seat	Sub Node	Yes

Node	Child Node	Type	Required	Description <Seat>
HideOnInternet	None	Boolean	Yes	0 = Do not hide, 1 = Needs to be hidden
HideRowDesc	None	Boolean	Yes	0 = Do not hide row desc., 1 = hide row desc.
HideSeparator	None	Boolean	Yes	0 = Do not hide row/col separator, 1 = hide separator
RowIndex	None	Integer	Yes	The row index of the seat
ColIndex	None	Integer	Yes	The column index of the seat
RowDesc	None	String	Yes	The row descriptor of the seat
ColDesc	None	String	Yes	The column descriptor of the seat
TypeID	None	Integer	Yes	The SeatType ID for the seat
GroupID	None	Integer	Yes	The group ID for the seat
GroupDesc	None	String	Yes	The group description for the seat
GroupPos	None	Integer	Yes	The seat position in the group
Xpos	None	Integer	Yes	The relative X position of the seat in the layout
Ypos	None	Integer	Yes	The relative Y position of the seat in the layout
Width	None	Integer	Yes	The relative width position of the seat in the layout
Height	None	Integer	Yes	The relative height position of the seat in the layout
Angle	None	Integer	Yes	The angle of the seat in the layout

!! NOTE: This call has been slightly modified to support locations that use custom seat pricing, these are locations that have different prices on specific seats in an auditorium. Due to this pricing not being known until the seat selection has been made, this call will return the pricing group for each seat, and a list of pricing groups and tickets. In order to access this data, this call should be made using the SCHEDULE credentials, not the SELLING credentials. Making this call with the selling credentials will not return any pricing data. !!

Get Seat Plan For Performance – Sample Request

<Command>GETSEATPLANFORPERF</Command>

<Data>

</Packet>

</Data>

</Request>

This call allows you to pull the reserved seating layouts for a specific performance, including the status of each seat. It also returns a list of seat types used in the layout.

Get Seat Plan For Performance – Sample Response (made with SCHEDULE credentials)

</GridRef>

<Name>Student</Name>

</Ticket>

...

<Name>Senior</Name>

</Ticket>

</Tickets>

</Ticket>

...

</Ticket>

</Tickets>

</PriceGroup>

</PriceGroups>

</Pricing>

<CustomerName>Recliner</CustomerName>

</SeatType>

...

<CustomerName>Wheelchair</CustomerName>

</SeatType>

</SeatTypes>

<Seats>

<Seat>

</Seat>

...

<Seat>

</Seat>

</Seats>

</Layout>

</Response>

</Packet>

</Response>

Get Seat Plan For Performance – Sample Response (made with SELLING credentials)

</GridRef>

<CustomerName>Normal</CustomerName>

</SeatType>

</SeatTypes>

<Seats>

<Seat>

</Seat>

......

<Seat>

</Seat>

</Seats>

</Layout>

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <GridRef>
Width	None	Integer	Yes	The relative grid width
Height	None	Integer	Yes	The relative grid height

Node	Child Node	Type	Required	Description <Layouts>
Layout	None	Sub Node	Yes
Pricing	Tickets, PriceGroups	Sub Node	Maybe	If request was made using SCHEDULE credentials: The <Pricing> node will contain a <Tickets> node and a <PriceGroups> node.
Tickets	Ticket	Sub Node	Maybe	If request was made using SCHEDULE credentials: The <Tickets> node will contain a number of <Ticket> nodes that are the tickets in use in this layout.
PriceGroups	PriceGroup	Sub Node	Maybe	If request was made using SCHEDULE credentials: There will be a <PriceGroup> node for each unique price group in the layout
SeatTypes	SeatType	Sub Node	Yes	There will be a <SeatType> node for each type used in this layout
Seats	Seat	Sub Node	Yes

Node	Child Node	Type	Required	Description <Ticket>
Code	None	String	Yes	Ticket code used in purchase transactions
Name	None	String	Yes	Ticket name as it should be displayed on the Internet
Price	None	Decimal	Yes	Total ticket price
Tax	None	Decimal	Maybe	Any tax included in the ticket price
Points	None	Integer	Maybe	Any points that are earned when buying this ticket type

Node	Child Node	Type	Required	Description <PriceGroup>
Code	None	Integer	Yes	The unique ID for this PriceGroup node, this ID is what links the <Seat> to the <PriceGroup>
Tickets	Ticket	Sub Node	Yes	There will be a <Ticket> node for each ticket type that is part of this PriceGroup
Ticket	Code	Sub Node	Yes	Each <Ticket>will contain a `node that links back to the <Tickets><Ticket> nodes under the <Pricing> node.`

Node	Child Node	Type	Required	Description <SeatType>
Type	None	Sub Node	Yes
ID	None	Integer	Yes	The ID of the SeatType
CustomerName	None	String	Yes	The customer name for the SeatType

Node	Child Node	Type	Required	Description <SeatType>
RowNum	None	Integer	Yes	The row index of the seat
ColNum	None	Integer	Yes	The column index of the seat
RowDes	None	String	Yes	The row descriptor of the seat
ColDes	None	String	Yes	The column descriptor of the seat
Section	None	String	Yes	The section ID of the seat
Type	None	Integer	Yes	The SeatType ID for the seat
GroupID	None	String	Yes	The group ID for the seat
Status	None	Integer	Yes	0 = unsold, 1 = sold, 2 = locked, 3 = held, 4 = open tab, 5 = broken, 6 = buffer
Xpos	None	Integer	Yes	The relative X position of the seat in the layout
Ypos	None	Integer	Yes	The relative Y position of the seat in the layout
Width	None	Integer	Yes	The relative width of the seat in the layout
Height	None	Integer	Yes	The relative height of the seat in the layout
Angle	None	Integer	Yes	The angle of the seat in the layout
PriceGroupCode	None	Integer	Maybe	If the request was made using SCHEDULE credentials: This value links back to the appropriate <PriceGroups><PriceGroup>`, which shows what <Tickets><Ticket> are available for this seat.`

Reserved Seating – Check Seat Picks

This call allows for you to verify the point-of-sale system will allow the sale of the seats picked. This is in order to stop customer from leaving too many single seats across the auditorium.

Reserved Seating – Check Seat Picks – Sample Request

<Command>CHECKSEATPICKS</Command>

<Data>

<Seats>

<Seat>

</Seat>

</Seats>

</Packet>

</Data>

</Request>

If there are multiple seats to check, just add the appropriate <Seat></Seat> information.

Node	Child Node	Type	Required	Description <Seats>
Seats	Seat	Sun Node	Yes

Node	Child Node	Type	Required	Description <Seat>
Row	None	Integer	Yes	Row number
Col	None	Integer	Yes	Column number

Reserved Seating – Check Seat Picks – Sample Response

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Char	Yes	1
ValidSelections	None	Integer	Yes	0 = Invalid, 1 = Valid
InvalidReason	None	String	Maybe	If invalid selection, this will be the reason why.

Seating Chart - Sample Request – PerformanceID

<Command>SeatChart</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Integer	Yes	1
Command	None	String	Yes	SeatChart
PerformanceID	None	String	Maybe	Performance ID for show

Seating Chart - Sample Request – MtFilmCode, MtPerformanceID, and ShowTime

<Command>SeatChart</Command>

<Data>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	Description <Request>
Version	None	Integer	Yes	1
Command	None	String	Yes	SeatChart
MtPerformanceID	None	String	Yes	Movietickets.com performance id for show
MtFilmCode	None	String	Yes	Movietickets.com film code for title
ShowTime	None	String	Yes	Performance date/time (yyyyMMddhhmm)

Seating Chart - Sample Response

<Seats>

<Seat>

</Seat>

<Seat>

</Seat>

</Seats>

</Layout>

</Response>

Node	Child Node	Type	Required	Description <Seat>
ColDesc	None	String	Yes	Column description
ColNum	None	Integer	Yes	Column number
RowDesc	None	String	Yes	Row description
RowNum	None	Integer	Yes	Row number
Section	None	String	Yes	Section name
Type	None	Integer	Yes	Type of seat (see seat type list)
GroupID	None	Integer	No	Grouped seats will have the same GroupID
Status	None	Integer	Yes	0 = unsold, 1 = sold, 2 = locked, 3 = held, 4 = open tab, 5 = broken, 6 = buffer

Holding and Releasing Seats

A hold seat request will hold the requested seats in a pending state for 5 minutes. Held seats can, and should, be released if the customer switches to different seats.

Reserved Seating – Hold Seats – Sample Request

<Command>HoldSeats</Command>

<Data>

<PerformanceID>+21 Strange Title</PerformanceID>

<Seats>

<Seat>

</Seat>

</Seats>

</Performance>

</Performances>

</Packet>

</Data>

</Request>

If there are multiple seats to hold, just add the appropriate <Seat></Seat> information. Performances can also be identified using PerformanceID.

Node	Child Node	Type	Required	Description <Seats>
Seats	Seat	Sub Node	Yes

Node	Child Node	Type	Required	Description <Seat>
Row	None	Integer	Yes	Row number
Col	None	Integer	Yes	Column number
Section	None	String	Yes	Section name

Reserved Seating – Hold Seats – Sample Response

</Response>

Node	Child Node	Type	Required	Description <Response>
Code	None	Integer	Yes	0 = success, or an Error Code
ResponseText	None	String	Yes	OK
TransactionID	None	String	Yes	Used to complete transaction or release seats

Reserved Seating – Release Seats – Sample Request

<Command>HoldSeats</Command>

<Data>

<Command>Release</Command>

</Packet>

</Data>

</Request>

Node	Child Node	Type	Required	CollapseDescription <Request>
Command	None	String	Yes	HoldSeats
Data	Packet	Sub Node	Yes
Command	None	String	Yes	Release
TransactionID	None	String	Yes	TransactionID from Hold request

Reserved Seating – Release Seats – Sample Response

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Integer	Yes	1
Code	None	String	Yes	0 = success, or an Error Code
ResponseText	None	String	Yes	OK

Ticket Purchasing – Reserved Seating

Ticket Purchase (Reserved) – Title, ShowTime, and AuditoriumID - Sample Request

<Data>

<Title>Casino Royale</Title>

<Seat>

</Seat>

</Ticket>

<Seat>

</Seat>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

Ticket Purchase (Reserved) – PerformanceID - Sample Request

<Data>

<Seat>

</Seat>

</Ticket>

<Seat>

</Seat>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

Ticket Purchase (Reserved) – MtFilmCode, ShowTime, and PerformanceID - Sample Request

<Data>

<Seat>

</Seat>

</Ticket>

<Seat>

</Seat>

</Ticket>

</Tickets>

</PurchaseTitle>

</PurchaseTitles>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

Ticket Purchase (Reserved) - Sample Response

<Type>Transaction</Type>

</BarCode>

</BarCodes>

</Pickup>

</Pickups>

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	CollapseDescription <Response>
Version	None	Integer	Yes	1
Code	None	Integer	Yes	-1
Packet	Response	Sub Node	Yes
ResponseText	None	String	Yes	OK
TransactionID	None	String	Yes	Transaction receipt number
Pickups	Pickup	String	Yes
TicketDay	None	String	Yes	Date of performance (yyyyMMddhhmm)
PickupNumber	None	String	Yes	Not currently used
BarCodes	BarCode	String	Yes
Type	None	String	Yes	Transaction
CodeType	None	String	Yes	The bar code type: UPC
BarCodeData	None	String	Yes	The confirmation number to be encoded. IMAGE IS NOT PROVIDED BY THE POS.

Concession Prices and Sales

A list of concession items, Per Cap settings, and prices can be downloaded in XML format, from the theatre, using the following URL:

https://<Theatre RTN Number>.formovietickets.com:2235/concessionprices.xml

When selling concession sales it may be necessary to include sales tax in the <ChargeAmount> tag. Insert additional <PurchaseItem> tags if needed.

Concession Sales – SalesTaxCheck – Sample Request

<Data>

<ItemName>Candy Item</ItemName>

</PurchaseItem>

</PurchaseItems>

</Packet>

</Data>

</Request>

Concession Sales – SalesTaxCheck – Sample Response

</Response>

Node	Child Node	Type	Required	Description <Response>
Status	None	Integer	Yes	0 = success, or an Error Code
SalesTax	None	Decimal	Yes	The amount of sales tax on the items in the Request.

Concession Sales – Purchase – Sample Request

<Data>

<ItemName>Candy Item</ItemName>

</PurchaseItem>

</PurchaseItems>

<Fees>

</Fees>

<Type>CreditCard</Type>

</Payment>

</Payments>

</Packet>

</Data>

</Request>

When selling items with a variable price (Amount Entry Items), a <Price> node can be added inside the <PurchaseItem> node after the <Amount>. Example:

<ItemName>Donation</ItemName>

</PurchaseItem>

Concession Sales – Purchase – Sample Response

</Response>

</Packet>

</Response>

Node	Child Node	Type	Required	Description <Response>
Version	None	Integer	Yes	1
Code	None	Integer	Yes	-1
Packet	Response	Sub Node	Yes
Code	None	String	Yes	0 = success, or an Error Code
ResponseText	None	String	Yes	OK
TransactionID	None	String	Yes	Confirmation for purchase

Error Codes

Error Code	Error Description
100	No data packet was decrypted (possible encryption error)
101	No <Payment> nodes specified
102	Gift request received, but user does not have rights to sell gifts cards
103	Films request received, but user does not have rights to sell tickets
104	No films, gifts, or items in request
106	Invalid PerformanceID format
107	Could not find film for PerformanceID
108	No tickets for film in request
110	Auditorium is oversold
111	Charge amount does not match calculated amount by POS
113	Bad username or password
114	No gift card prefixes are configured
115	No gift purchase amount in request
116	POS could not allocate gift certificate number
117	Can't add points to a non registered card
118	Invalid gift card number
119	Unable to create HostedCheckout PaymentId
120	Invalid ProcessCompletePostData Format
121	Invalid HostedCheckout Processor
122	HostedCheckout Transaction Expired
123	MPS Payment Not Valid
124	HostedCheckout Purchase Failed
125	Invalid HostedCheckout PaymentId
126	Multiple Payment Validations Error
127	Charge Amount is Neg
128	Ticket fee item not configured
129	Extra fee item not configured
130	Adjust item not configured
131	Unknown Ticket Class In Request
132	Ticket class in not enabled for internet ticketing
133	Zero Priced Ticket in Request
134	Payments are specified during check sales tax request
135	No PickupNumber specified
136	Refund, Reverse, or Redeem error (see message for specific details)
137	Performance is no longer scheduled (or not a reserved seating show)
138	Non-secure payment on tokenized account
139	Ticket not available for performance
140	Reserved ticket purchase error (see message for specific details)
141	Transaction does not balance error
142	Reserved ticket purchase error (see message for specific details)
143	Malformed gift purchase packet (see message for specific details)
144	Unable to validate GiftCardPIN

201	Unknown Secure Processor Type
202	Invalid Parameters In Payment Node
203	VerifyAccount Failed - ResponseText: <Processor ResponseText>
204	VerifyAccount Failed - Invalid AVS/CVV Result
205	CreditSale Failed - ResponseText: <Processor ResponseText>

500	POS could not allocate cash register control (possibly server too busy)

700	Unknown error during sale
701	Not enough money on gift card
702	Invalid credit card number/expiration, or card declined
703	Invalid performance
704	Ticket type is disabled
705	Ticket serial number file is invalid
706	Concession item not setup – check ticket/concession link items
707	Reserved seat sale failed – check the seating chart

5000	Exception Error (see message for details).

9000	POS Not Licensed
9001	Packet Parse Error (see message for extra details)

Reserved Seating Codes

Seat Code	CollapseSeat Description
0	Normal Seat
1	Handicapped Seat
2	Aisle (the aisle, NOT an aisle seat)
3	House Seat
4	Companion Seat
5	Pillar
6	Table
7	Beanbag
8	Loveseat
9	Rocker
10	Recliner

Film and Show Bit Field Values

Information is encoded in these values as a bit field. Bit fields work by storing multiple true/false values in the same integer, instead of having multiple integers for each value.

To look up a value in a bitfield, you'll want to make use of Bit Masks.

As an example, my performance has an Info1 value of 7, and I want to see if 3D is set. I know that 3D is bit 12 with a decimal value of 4096. I can check to see if bit 12 is set in my Info1 value by AND'ing it and the decimal value of 4096.

7 / 0000 0000 0000 0111 AND 4096 / 0001 0000 0000 0000 ___________________________ 0 / 0000 0000 0000 0000

Another performance has an Info1 value of 6051. To check if 3D is set here, I'll again AND it with the decimal value of the 3D bit, 4096.

6151 / 0001 1000 0000 0111 AND 4096 / 0001 0000 0000 0000 ___________________________ 4096 / 0001 0000 0000 0000

Info1

Bit	Decimal Value	Setting
0	1	RTN Display
1	2	RTN Sell
2	4	Kiosk Display
3	8	No Passes
4	16	Dolby Digital
5	32	THX
6	64	DLP
7	128	Dubbed in English
8	256	Subtitled in English
9	512	DTS
10	1024	No Discounts
11	2048	Stadium Seating
12	4096	3D
13	8192	16MM
14	16384	35MM

Info2

Bit	Decimal Value	Setting
0	1	3rd Party Display
1	2	3rd Party Sell
2	4	Rentrak Transfer
3	8	IMAX
4	16	Flat
5	32	Digital
6	64	Descriptive Video Service
7	128	Subtitled in French
8	256	Dubbed in French
9	512	French Language Film
10	1024	70MM
11	2048	Open Caption
12	4096	Closed Caption
13	8192	Special Advanced Screening
14	16384	Adults Only

Info3

Bit	Decimal Value	Setting
0	1	Sign Display
1	2	RESERVED / UNIMPLEMENTED
2	4	RESERVED / UNIMPLEMENTED
3	8	Director's Hall
4	16	RWC
5	32	Reserved Seating
6	64	Gallery
7	128	Lux Level
8	256	Premier
9	512	Cine Capri
10	1024	Cine Art
11	2048	Showcase Art
12	4096	Surround Sound
13	8192	Scope
14	16384	DBOX
15	32768	PLF
16	65536	Dolby Atmos
17	131072	RealD 3D
18	262144	Sony 4K
19	524228	DTSX
20	1048576	Auro 3D
21	2097152	Fedelio
22	4194304	Captiview
23	8388608	Audio Description
24	16777216	Hearing Impaired Track
25	33554432	Sensory Show
26	67108864	Onyx
27	134217728	Not ADA Accessible
28	268435456	HFR
29	536870912	Spanish Dubbed
30	1073741824	Spanish Subtitled

Info4

Bit	Decimal Value	Setting
0	1	RESERVED / UNIMPLEMENTED

Related Articles
RTS API 2
The latest version of the documentation can be accessed from the following Google Drive: Google Drive Costs As with all RTS API interfaces there are costs involved at the location level. Please contact sales for more information. There is no cost to ...
Example Websites
RTS and Example Websites RTS works on the web in two main ways. RTN websites and/or 3rd Party websites. Additionally, if you have a 3rd party website, your web developer has many options to list your showtimes on the 3rd party site. These include ...
Getting Started with RTS: Everything you need to know
Below is a list of links, articles and information on helping you get started with RTS and setting up your RTS Software If you click the link below you will find everything you need to know about RTS and getting started with us. You will find all of ...
National Cinema Day Ticket Setup Instructions
National Cinema Day Here are step by step instructions for setting up a one-day ticket for National Cinema Day. 1. Create the Price Category and Ticket 1a). Navigate to Setup > Tickets > Price. 1b). From the Setup Ticket Price Category press ADD. ...
"Deposit - Total" Report
To view Deposit Total report: Navigate to: Reports -> Deposit -> Total. Under "Select by", click on "Deposit". Select the date of the deposit on the left. Select either whole deposit or a specific station. Click "View". Breaking Down the Report ...