...
| Variable Name | Variable Type | Value length | Variable usage/description | ||||
| GenderactivationParameters.groupId | string | 1 char | M (male), F (female), U (unknown), X (other) | ||||
| First Name | string | 50 char | Spectator's first name | ||||
| Last Name | string | 100 char | Spectator's last name | ||||
| string | 256 char | Spectator's email address | |||||
| Main Applicant | string | Boolean | Indicates if the spectator is the main applicant (SecuTix) for this ticket (default false). | ||||
| Ticket ID | string | 256 char | Ticket ID in the TIXNGO system (a-z|A-Z / numbers / spaces / some special characters: *.-_+/()) | ||||
| Barcode | string | 512 char | Plain text ticket barcode | ||||
| Sorting Key | string | 256 char | Key used to order the tickets for the spectator following the alphabetical order. | ||||
| Price | number | float | Price of the ticket | ||||
| Currency | string | 20 char | Currency of the ticket's price | ||||
| Category | string | 512 char | Purchase category (e.g. ADULT, CHILD, VIP, etc...) | ||||
| Tax. Number | string | 256 char | Purchase taxation number | ||||
| Ticket Image URL | string | 256 char | Display image as per URL on following ticket views: Ticket View, Ticket Detailed View | ||||
| File ID | string | 256 char | SecuTix File ID (or any file ID that would list groups of ticket, e.g. injection file) | ||||
| Event ID | string | 256 char | Event ID in the TIXNGO system | ||||
| Event Name | string | 128 char | Name of the match | ||||
| Site | string | 200 char | Site name displayed at the Ticket View and Ticket Detailed View under Address title | ||||
| City | city | 200 char | City where the event takes place | ||||
| Country Code | string | 200 char | country code for the address | ||||
| Zip | string | 200 char | zip code for the address | ||||
| Event Image URL | string | 256 char | Display image as per URL on following ticket views: My Tickets - "Group Image" | ||||
| Start Time | string | must follow RFC 3339 date format | Displays Match date and kick-off time at the Ticket View and Ticket Detailed View | ||||
| Ribbon Display Time | string | must follow RFC 3339 date format | Time at which a ribbon is displayed on the mobile app to notify spectator turn on Bluetooth | ||||
| Transfer Group Id | string | 256 char | Transfer rules can technically be different for every ticket. Organizer might want to chose to have different transfer rules for different types of ticket (ex: Adult, child, VIP, etc…). This GroupID is the Transfer rules group ID representing a group of transfer rules applied to certain tickets. If Organizers want to apply the same rules to every tickets, by default this groupID is set to the EventID and every ticket will be in this group. | ||||
| Max number of Ticket per receiver's Phone | integer | integer | Maximum amount of tickets per phone for this Transfer rules group id | ||||
| Max Resell Price increase (in %) | integer | smallint | Maximum profit (price increase in %) of the original ticket price for a resell between spectator. | ||||
| Max number transfer per Phone | integer | integer | Total amount of transfers per Phone (-1 feature is disabled). Counter is increased for every new transfer, but decrease on a Return. | ||||
| Max number transfer per Ticket | integer | integer | Total amount of transfers per Ticket (-1 feature is disabled). Counter is increased for every new transfer, but decrease on a Return. | ||||
| Assign Limit | integer | integer | Upper bound amount of transfer before the Assign function is disable (-1 means unlimited) | ||||
| Allow Transfer | Boolean | Boolean | Enables or Disables transfer functionality for given match (Send menu item in the ticket view hidden or displayed) | ||||
| Allow Transfer after Activation | Boolean | Boolean | Enables or Disables transfer functionality for given match for Activated Tickets (Send menu item in the ticket view hidden or displayed) | ||||
| Allow Transfer after Control | Boolean | Boolean | Enables or Disables transfer functionality for given match for Controlled Tickets (Send menu item in the ticket view hidden or displayed) | ||||
| Allow Return To Organizer | Boolean | Boolean | Enables or Disable allow everyone to release ticket to resale. | ||||
| Allow Return To Organizer For Initial Spectator | Boolean | Boolean | Enables or Disable only Initial Spectator can release ticket to resale. | ||||
| Resale Group Id | string | 256 char | Resale rules can technically be different for every ticket. Organizer might want to chose to have different resale rules for different types of ticket (ex: Adult, child, VIP, etc…). This GroupID is the Resale rules group ID representing a group of resale rules applied to certain tickets. If Organizers want to apply the same rules to every tickets, by default this groupID is set to the EventID and every ticket will be in this group. It is editable or used only if organizer resale setting is enabled | ||||
| Allow Resell | Boolean | Boolean | Enables or Disables resale functionality for given match for all Tickets (Send menu item in the ticket view hidden or displayed) It is editable or used only if organizer resale setting is enabled | ||||
| Allow Resell after Activation | Boolean | Boolean | Enables or Disables resale functionality for given match for ActivatedTickets (Send menu item in the ticket view hidden or displayed) It is editable or used only if organizer resale setting is enabled | ||||
| Keep one Ticket Overall | Boolean | Boolean | Force ALL ticket wallet holders to keep at least 1 ticket per given Match | ||||
| Keep one Ticket at Injection | Boolean | Boolean | Force ticket wallet holder to whom tickets were originally injected to keep at least 1 ticket per given Match. E.g. all his transfer guests will be able to forward all the tickets they received | ||||
| string | 100 char | Support organizer define the resale price with three options A, B and C per Transfer Group Id:
It is editable or used only if organizer resale setting is enabled | |||||
| Min resale price decrease | number | float | Enable when Resale option A is selected. Min resale price decrease (in % of the initial price) of the ticket to be resold It is editable or used only if organizer resale setting is enabled | ||||
| Min resale price amount | number | float | Enable when Resale option A is selected. Min resale price amount of the ticket to be resold It is editable or used only if organizer resale setting is enabled | ||||
| Max resale price increase | number | float | Enable when Resale option A is selected. Max resale price Increase (in % of the initial price) of the ticket to be resold It is editable or used only if organizer resale setting is enabled | ||||
| Max resale price amount | number | float | Enable when Resale option A is selected. Max resale price amount of the ticket to be resold | ||||
| Specific resale price decrease/increase | number | float | Enable when Resale option B is selected. Specific resale price decrease/increase (in % of the initial price) of the ticket to be resold
It is editable or used only if organizer resale setting is enabled | ||||
| Specific resale price amount | number | float | Enable when Resale option B is selected. Specific resale price amount of the ticket to be resold
It is editable or used only if organizer resale setting is enabled | ||||
| The Resale & Purchase Agreement URL | string | 512 char | The Resale & Purchase Agreement URL in P2P resale It is editable or used only if organizer resale setting is enabled | ||||
| Ticket Terms & Conditions URL | string | 512 char | Ticket Terms & Conditions URL in P2P resale It is editable or used only if organizer resale setting is enabled | ||||
| Activation Id | string | 50 char | Activation group ID. Different tickets could have different activation method, this group ID make the distinction between them. | ||||
| Activation Time | string | Date Time RFC3339 standard | Activation time at which the system will activate the ticket (display barcode) | ||||
| Activation Method | string | "online"/"offline" | The method using to activate the ticket. online : when activationTime is reached (backend clock), the backend activates the tickets and sends push notifications to trigger a GET /spectator/tickets on the app. offline: the mobile application activates the tickets when time is reaches (mobile clock). Online requires the user to be online, Offline does not. More on Ticket activation: 5-Understanding TIXNGO Activation flow | ||||
| Purchase Date | string | Date Time RFC3339 standard | Date & time at which the ticket was bought | ||||
| Main Ticket Details | string | key (32 char) - value (4096 char) | Ticket details shown on the ticket's front (usually used to set entrance & seat details) | ||||
| Extra Ticket Details | string | key (32 char) - value (4096 char) | Ticket extra details shown on the back of the ticket (usually used to set extra information about the ticket or the event) | ||||
| Hidden Ticket Details | string | key (32 char) - value (4096 char) | Ticket hidden details (not displayed), used for different technical or business purposes, i.e. reserved key such as Seat Map, Sponsors details, etc... | ||||
| Hold (only CSV injection for now) | Boolean | Boolean | Activate ticket holder (ticket is hold for someone else) | ||||
| Holder email (only CSV injection for now) | string | 256 char | Ticket holder email | ||||
| Holder date of birth (only CSV injection for now) | string | rfc3339 standard | Ticket holder date of birth | ||||
| Holder first name (only CSV injection for now) | string | 50 char | Ticket holder first name | ||||
| Holder last name (only CSV injection for now) | string | 100 char | Ticket holder last name | ||||
| Holder gender (only CSV injection for now) | string | 1 char | Ticket holder gender (M, F or U) | ||||
| Holder card number | string | 200 char | Ticket holder ID card number | ||||
| Holder nationality | string | 2 char | Ticket holder nationality | ||||
| Holder passport number | string | 200 char | Ticket holder passport number | ||||
| 50 char | The activation group to which the ticket belongs to. Tickets sharing the same activation id will have the same activation method & decryption code. | ||||||
| activationParameters.method | string | "online"/"offline" | The method using to activate the ticket. online : when activationTime is reached (backend clock), the backend activates the tickets and sends push notifications to trigger a GET /spectator/tickets on the app. offline: the mobile application activates the tickets when time is reaches (mobile clock). Online requires the user to be online, Offline does not. More on Ticket activation: 5-Understanding TIXnGO Activation flow | ||||
| activationParameters.time | string | Date follows RFC 3339 standard | If online is chosen, define the time at which the tickets are activated (decrypted). | ||||
| activationParameters.instanceId | string | 128 char | If offline is chosen, define the bluetooth instance id that the mobile app should listen to to get the decryption key. | ||||
| image | string | 256 char | The uri to the image that will be displayed to the user with its ticket. It must have a width:length ratio of X:Y (to be defined). (displayed on the "Ticket" view). | ||||
| event.id | string | 256 char | ID representing the event (unique). | ||||
| event.address.site | string | 200 char | Name of the site the Event will take place. | ||||
| event.address.line1 | string | 200 char | Address line 1 | ||||
| event.address.line2 | string | 200 char | Address line 2 | ||||
| event.address.line3 | string | 200 char | Address line 3 | ||||
| event.address.city | string | 200 char | City where the event takes place | ||||
| event.address.countryCode | string | 200 char | Country code for the Address | ||||
| event.address.region | string | 200 char | Region where the Event takes place | ||||
| event.address.zip | string | 50 char | Zip code where the Event takes place | ||||
| event.address.longitude | double | double | Longitude where the Event takes place | ||||
| event.address.latitude | double | double | Latitude where the Event takes place | ||||
| event.name | string | 128 char | Name of the Event | ||||
| event.startTime | string | Date follows RFC 3339 standard | Time at which the event starts. Used for app logic such as reminders etc... Date Format: 2022-12-12T16:11:00Z | ||||
| event.expirationDate | string | Date follows RFC 3339 standard | Time at which the event expire. Expired event cannot be used anymore. | ||||
| event.bluetoothPreparationRibbonDisplayTime | string | Date follows RFC 3339 standard | Time at which a ribbon displays on the mobile app to notify spectator turn on Bluetooth on the phone | ||||
| event.bluetoothPreparationRibbonEndTime | string | Date follows RFC 3339 standard | Time at which a ribbon disappear on the mobile app | ||||
| event.metadata | list | list of key-value metadata | Specific "key-value" fields provided to Organizer for special information about the event. Reserved Keys :
| ||||
| event.group.id | string | 256 char | Id of the Group. Every Event with this Group ID will be part of that Group. | ||||
| event.group.name | string | 128 char | Name of the Group. | ||||
| event.group.image | string | 256 char | The Image of the Group (displayed on the "My Events" view). | ||||
| purchaseDetails.price | double | double | The Ticket's price. (Example 30, 55.50, 120.55,..._) | ||||
| purchaseDetails.currency | string | 20 char | The currency used in the transaction using ISO-4217 standard (example: CHF, VND, USD). | ||||
| purchaseDetails.date | string | Date follows RFC 3339 standard | The date at which the Ticket was initially bought. | ||||
| purchaseDetails.priceCategory | string | 512 char | Examples of price category are adult, child, student, senior, VIP, etc. | ||||
| purchaseDetails.taxationNumber | string | 512 char | (UUID) taxation number of the Ticket. | ||||
| ticketDetails.main | list | list of key-value metadata | Free "key-value" fields usually used to define spectator seating information such as: gate:A, row:2, seat:7 (Displayed on the "front" of the Ticket). | ||||
| ticketDetails.extra | list | list of key-value metadata | Free "key-value" fields usually used to define extra information (Displayed on the "back" of the Ticket). Reserved Keys : file_id : optional field set by the Organizer at injection. | ||||
| ticketDetails.hidden | list | list of key-value metadata | Free "key-value" fields usually used to add hidden information, ex: used between Organizer and TIXnGO (Not displayed on the Ticket). Reserved Keys : transfer_extra : optional field set by the sender during a ticket transfer in transferOrder.extra background_color : optional field set by the Organizer at injection. Define the background color of the ticket. hosp_room: optional field set by the Organizer at injection. Define the hospitality room of the ticket. show_price: optional field set by the Organizer at injection. Define to show or not show the price on ticket extra at_icon: optional field set by the Organizer at injection. Define to show extra icon on the top-left of ticket layout ticketDetailMainNotInBoxes: optional field set by the Organizer at injection. Define how many fields (of ticketDetails.main) that will not stay in boxes (count from the last one) specialColor: optional field set by the Organizer at injection. Define the horizontal stripe color on QRcode part ticket layout Furthermore, you can override the all the event.metadata keys on a per ticket level. | ||||
| security.barcode | string | 512 char | Barcode of the Ticket. | ||||
| security.clearanceLevel | integer | integer | Clearance level of the ticket. If 1 is chosen: the organizer require the spectator to provide its name,surname,gender. If 2 is chosen, then all field of SpectatorIdentity are required except for the passport and idcard number, only one of them is required. | ||||
| spectatorDetails.residenceCountry | string | ISO Alpha-2 format | Initial spectator's residence country. | ||||
| spectatorDetails.phoneNumber | string | 50 char | Initial spectator's phone number. | ||||
| spectatorDetails.email | string | 256 char | Initial spectator's email. | ||||
| spectatorDetails.firstName | string | 50 char | Initial spectator's first name. | ||||
| spectatorDetails.lastName | string | 100 char | Initial spectator's last name. | ||||
| spectatorDetails.gender | string | 1 char (m/f/u/x) | Initial spectator's gender. m, f, u or x (For Male, Female, Other, Unknown) | ||||
| spectatorDetails.dateOfBirth | string | Date follows RFC 3339 standard | Initial spectator's birth date. | ||||
| spectatorDetails.nationality | string | ISO Alpha-2 format | Initial spectator's nationality. | ||||
| spectatorDetails.passportNumber | string | 200 char | Initial spectator's passport number. | ||||
| spectatorDetails.idCardNumber | string | 200 char | Initial spectator's ID card number. | ||||
| spectatorDetails.spectatorStatus | string | "Activated" / "Not activatied" | If the initial spectator is registered in the TIXnGO system. | ||||
| spectatorDetails.ticketHolder.identity.firstName | string | 50 char | Ticket Holder's first name. | ||||
| spectatorDetails.ticketHolder.identity.lastName | string | 100 char | Ticket Holder's last name. | ||||
| spectatorDetails.ticketHolder.identity.gender | string | 1 char (m/f/u/x) | Ticket Holder's gender m, f, u or x(For Male, Female, Other, Unknown) | ||||
| spectatorDetails.ticketHolder.identity.dateOfBirth | string | Date follows RFC 3339 standard | Ticket Holder's birth date. | ||||
| spectatorDetails.ticketHolder.identity.nationality | string | ISO Alpha-2 format | Ticket Holder's nationality. | ||||
| spectatorDetails.ticketHolder.identity.passportNumber | string | 200 char | Ticket Holder's passport number. | ||||
| spectatorDetails.ticketHolder.identity.idCardNumber | string | 200 char | Ticket Holder's ID card number. | ||||
| spectatorDetails.ticketHolder.identity.email | string | 256 char | Ticket Holder's email. | ||||
| spectatorDetails.ticketHolder.identity.phoneNumber | string | 50 char | Ticket Holder's phone number. | ||||
| spectatorDetails.ticketHolder.identity.birthCity | string | 50 char | Ticket Holder's birth city. | ||||
| spectatorDetails.ticketHolder.identity.birthCountry | string | ISO Alpha-2 format | Ticket Holder's birth country. | ||||
| spectatorDetails.ticketHolder.identity.residenceCountry | string | ISO Alpha-2 format | Ticket Holder's residence country. | ||||
| spectatorDetails.ticketHolder.identity.address.line1 | string | 200 char | TIcket Holder's address line 1. | ||||
| spectatorDetails.ticketHolder.identity.address.line2 | string | 200 char | Ticket Holder's address line 2. | ||||
| spectatorDetails.ticketHolder.identity.address.line3 | string | 200 char | Ticket Holder's address line 3. | ||||
| spectatorDetails.ticketHolder.identity.address.city | string | 200 char | Ticket Holder's residence city. | ||||
| spectatorDetails.ticketHolder.identity.address.countryCode | string | 200 char | Ticket Holder's country code. | ||||
| spectatorDetails.ticketHolder.identity.address.zip | string | 50 char | Ticket Holder's zip code. | ||||
| spectatorDetails.ticketHolder.extraInfo1 | string | 100 char | Free field of extra info about the Ticket Holder. | ||||
| spectatorDetails.ticketHolder.extraInfo2 | string | 100 char | Second free field of extra info about the Ticket Holder. | ||||
| spectatorDetails.ticketHolder.reason | string | 512 char | Reason of why the assignment happen. Can be modified later by the spectator. (Optional) | ||||
| spectatorDetails.organizerSpectatorPreference.allowPromoEmail | boolean | boolean | Default false. Spectator accept promotional email from TIXnGO. | ||||
| spectatorDetails.organizerSpectatorPreference.allowPromoThirdPartyEmail | boolean | boolean | Default false. Spectator accept promotional email from Third-Party. | ||||
| spectatorDetails.organizerSpectatorPreference.allowTracking | boolean | boolean | Default false. Spectator accept to be tracked and data matching. | ||||
| ticketId | string | 256 char | Ticket ID differentiating each ticket. It must be unique (UUID). | ||||
| lang | string | 5 char ISO 639‑1 format | The default language for the Ticket. Injection communications will be sent in this language. Example: fr, en, de, it, es | ||||
| transferRules.groupId | string | 256 char | Transfer rules can technically be different for every ticket. Organizer might want to chose to have different transfer rules for different types of ticket (ex: Adult, child, VIP, etc…). This GroupID is the Transfer rules group ID representing a group of transfer rules applied to certain tickets. If Organizers want to apply the same rules to every tickets, by default this groupID is set to the EventID and every ticket will be in this group. | ||||
| transferRules.maxNumberOfTicketPerPhoneInGroupId | integer | integer | Maximum amount of tickets per phone for this Transfer rules group id. | ||||
| transferRules.maxResellPriceIncrease | integer | smallint | Maximum profit (price increase in %) of the orignial ticket price for a resell between spectator. | ||||
| transferRules.maxNumberOfTransferPerPhoneInGroupId | integer | integer | Total amount of transfers per Phone (-1 feature is disabled). | ||||
| transferRules.maxNumberOfTransferPerTicketInGroupId | integer | integer | Total amount of transfers per Ticket (-1 feature is disabled). | ||||
| transferRules.assignTransferLimit | integer | integer | Define upper bound of ticket's transfer level for the "Assign" function | ||||
| transferRules.allowTransfer | boolean | boolean | Enables or Disables transfer functionality for given match (Send menu item in the ticket view hidden or displayed). | ||||
| transferRules.allowTransferMainApplicant | boolean | boolean | Enable or Disable transfer functionnality for Main Applicant ticket's. | ||||
| transferRules.allowTransferAfterActivation | boolean | boolean | Enables or Disables transfer functionality for given match for Activated Tickets (Send menu item in the ticket view hidden or displayed). | ||||
| transferRules.allowTransferAfterControl | boolean | boolean | Enables or Disables transfer functionality for given match for Controlled Tickets (Send menu item in the ticket view hidden or displayed). | ||||
| transferRules.allowReturnToOrganizer | boolean | boolean | Allow to release ticket to resale / allow ticket shop resale | ||||
| transferRules.allowReturnToOrganizerForInitialSpectator | boolean | boolean | Only Initial Spectator can release ticket to resale | ||||
| transferRules.keepOneInGroupId | boolean | boolean | Force ALL ticket wallet holders to keep at least 1 ticket per given Match. | ||||
transferRules.keepOneAtInjectInGroupId | boolean | boolean | Force ticket wallet holder to whom tickets were originally injected to keep at least 1 ticket per given Match. E.g. all his transfer guests will be able to forward all the tickets they received. | ||||
| design.id | string | 256 char | The Design Id applies to the ticket. | ||||
| design.backgroundColor | string | 7 char hexadecimal color code | The background color of the corresponding design. | ||||
| ticketInjectionDate | string | Date follows RFC 3339 standard | The date at which the ticket was injected. | ||||
| mainApplicant | boolean | boolean | Optional Main Applicant flag (SecuTix) | ||||
| sortingKey | string | 256 char | A key to sort the tickets in the spectator view. The tickets will be sorted according to this key in alphabetical order. | ||||
| mobileAppId | string | 256 char | Mandatory | mobileAppId | string | 256 char | OptionalMobile Application App Id to use associated invitation email template (used by organizer using their own app or branded | apps).
| lang | string | 5 char ISO 639‑1 format | The default language for the Ticket. Injection communications will be sent in this language. Example: fr, en, de, it, es | ||||
| Design Id | string | 256 char | This Design Id representing a design applied to certain tickets in an Event | ||||
| apps). | |||||||
| contingent | string | 256 char | The type of contingent applies to the ticket | Background Color | string | 7 char hexadecimal color | The background color of the Ticket and the corresponding Design Id (If the Design Id is set). Example: #bbccdd |