{"info":{"_postman_id":"8c1a0916-50e3-47b0-9399-32bfabd2859e","name":"TicketPlan API","description":"

REST API

The REST API is used for getting premium values (quotes) and for purchasing policies. A quote does not have to be generated in order to create a policy, if you already know the required information.

Authentication

In order to use the API, you will require your Distributor ID along with your API username and password. This information is specific to you and carry specific privilages, so ensure you keep the details secure to stop any unauthorized access to the API

Failure to provide the correct authentication details will result in results being returned as403 Forbidden

API requests must be made over HTTPS. Calls made over HTTP will fail.

Errors

The API uses conventional HTTP response codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided (e.g. a required parameter was omitted), and codes in the 5xx range indicate an internal error with the API.

200 OK - The request has succeeded. The client can read the result of the request in the body and the headers of the response.

400 Bad Request - The request could not be understood by the server due to malformed syntax. The message body will contain more information

401 Unauthorized - The request requires user authentication or, if the request included authorization credentials, authorization has been refused for those credentials.

403 Forbidden - The server understood the request, but is refusing to fulfill it. The most common reason to receive this status code would be because your account doesn't have permission to view the selected resource.

404 Not Found - The requested resource could not be found. This error can be due to a temporary or permanent condition.

422 Unprocessable Entity - Response status code indicates that the server understands the content type of the request entity, and the syntax of the request entity is correct, but it was unable to process the contained instructions.

500 Internal Server Error - You should never receive this error but if you do please report it to us so we can investiage.

Response

All API responses will response data as JSON objects.

DistributorID

All distributors have their own unique ID that links quotes and sales. The DistributorID would have been given to you as part of the onboarding process and must be sent with all API requests.

API Username and Password

All API requests must be supplied with your API username and Password. Your credentials would have been given to you as part of the onboarding process.

To send the API username / password, add an Authorization header to the API request with a value of username:password which needs to be base64-encoded

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7294044","collectionId":"8c1a0916-50e3-47b0-9399-32bfabd2859e","publishedId":"2s9YeBdDiQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-01-19T11:41:13.000Z"},"item":[{"name":"getpremium","id":"db88ae63-cfff-4c0b-b9a6-0693679498dd","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{}},"request":{"method":"GET","header":[{"key":"Authorization","value":"ZXZlbnR3b3Jrczp6dHd1UkxjYlY0MnI1Qzg3RlFEWkFU","description":"

Base64 encoded username:password

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country\": \"MT\",\r\n \"rate_type\": 1,\r\n \"ticket_prices\": [\r\n {\r\n \"price\": 4000\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/getpremium/21FFD807-6080-454B-ABCD-5E77833F9C7C","description":"

This HTTP GET request is used to retrieve premium information to build a specific quote. The request should be made to the following endpoint: https://api.ticketplan.com/api/v1/getpremium/{distributorID}

Request

This request retrives specific distribution rates from the API.

The following JSON is required to return the correct distribution rates:

{\n    \"country\": \"\",\n    \"rate_type\": 0,\n    \"ticket_prices\": [\n        {\n            \"price\": 0\n        }\n    ]\n}\n\n

The request body includes the following properties:

country: The 2 digit ISO country code for the rates to return.
\n
rate_type: 1 for Banded prices or 2 for Unbanded prices.
\n
ticket_prices: An array of objects representing individual ticket prices that you wish to retrive a premium for. Note if you require premiums for different countries, then these need to be sent as seperate requests. Each rate object include the following properties:
\n
- price: The ticket price that you wish to retrive the premium for.
\n

Response

The response to this request will have a status code of 200, indicating a successful request. The response body will contain premium information for the quote. Here is an example of the response:

{\n    \"quote_id\": \"58513880-30FB-462F-B96B-8F74257C1C51\",\n    \"total_price\": 2500,\n    \"total_premium\": 150,\n    \"total_ipt\": 38,\n    \"total_nett\": 112,\n    \"rates\": [\n        {\n            \"price\": 2500,\n            \"premium\": 150,\n            \"ipt\": 38,\n            \"nett\": 112\n        }\n    ]\n}\n\n

The response body includes the following properties:

quote_id: The unique ID of the quote.
\n
total_price: The total cost of all the tickets in the request.
\n
total_premium: The total premium amount for all the tickets quoted.
\n
total_ipt: The total Insurance Premium Tax for all the tickets quoted.
\n
total_nett: The total nett premium for all the tickets quoted.
\n
rates: An array of objects representing individual rates for the premium. Each rate object includes the following properties:
\n
- price: The price of the ticket.
  \n
- premium: The premium amount for the ticket.
  \n
- ipt: The insurance premium tax for the premium.
  \n
- nett: The nett premium.
  \n
\n

Please note that the values in the example response are placeholders and may not reflect the actual values returned by the API.

\n","urlObject":{"protocol":"https","path":["api","v1","getpremium","21FFD807-6080-454B-ABCD-5E77833F9C7C"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[{"id":"a145bc48-2e35-4009-a17f-cc8f9d8d7599","name":"GET","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","description":"Base64 encoded username:password","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"country\": \"DE\",\r\n \"rate_type\": 1,\r\n \"ticket_prices\": [\r\n {\r\n \"price\": 6500\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/getpremium/AD28CF2E-0054-4571-8E81-90873D7151BC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"quote_id\": \"58513880-30FB-462F-B96B-8F74257C1C51\",\n \"total_price\": 2500,\n \"total_premium\": 150,\n \"total_ipt\": 38,\n \"total_nett\": 112,\n \"rates\": [\n {\n \"price\": 2500,\n \"premium\": 150,\n \"ipt\": 38,\n \"nett\": 112\n }\n ]\n}"}],"_postman_id":"db88ae63-cfff-4c0b-b9a6-0693679498dd"},{"name":"createpolicy","id":"5172afee-3b6e-4b44-9091-684e27097da1","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"

Base64 encoded username:password

\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": \"\",\r\n \"quote_country\": \"BE\",\r\n \"booking_date\": \"2023-10-13\",\r\n \"quantity\": 1,\r\n \"order_number\": \"123456\",\r\n \"booking_fee\": 750,\r\n \"ticket_details\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\",\r\n \"price\": 6500,\r\n \"premium\": 350\r\n }\r\n ],\r\n \"customer_data\": {\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"john.smith@pierinsurance.com\",\r\n \"address_1\": \"101 High Street\",\r\n \"address_2\": \"\",\r\n \"city\": \"Southend On Sea\",\r\n \"county\": \"Essex\",\r\n \"postcocde\": \"SS1 1HZ\",\r\n \"country\": \"United Kingdom\",\r\n \"language\": \"EN\",\r\n \"telephone_no\": \"01702 123456\"\r\n },\r\n \"event\": {\r\n \"event_name\": \"Champions League Final\",\r\n \"event_start_date\": \"2024-05-31\",\r\n \"event_end_date\": \"2024-05-31\",\r\n \"venue_name\": \"Wembley Stadium\",\r\n \"venue_location\": \"London\",\r\n \"venue_country\": \"GB\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/createpolicy/{DistributorID}","description":"

This API endpoint allows you to create a new policy by sending an HTTP POST request to the specified URL. The request should include the necessary parameters to create the policy.

Request

Method: POST
URL: https://api.ticketplan.com/api/v1/createpolicy/{distributorID}

Response

The response of the last execution of this API request was as follows:

Status: 200

{\n    \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\n    \"total_premium\": 350,\n    \"total_ipt\": 30,\n    \"email_result\": {\n        \"sent\": false,\n        \"reason\":\"documents not required to be sent\"\n    }\n}\n\n

The response body contains the details of the newly created policy. The policyid field represents the unique identifier of the policy. The total_premium field indicates the total premium amount for the policy, while the total_ipt field represents the total insurance premium tax.

Additionally, the email_result field provides information about the email sent as a result of creating the policy. The sent field is a boolean value indicating whether the email was successfully sent or not. The reason field provides any additional information or error message related to the email sending process.

Please note that the specific values in the response may vary for each execution and should be retrieved from the response dynamically.

\n","urlObject":{"protocol":"https","path":["api","v1","createpolicy","{DistributorID}"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[{"id":"e8f2eb8e-5d8f-484b-992a-e25d07783440","name":"POST","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"Base64 encoded username:password"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": \"\",\r\n \"quote_country\": \"BE\",\r\n \"booking_date\": \"2023-10-13\",\r\n \"quantity\": 1,\r\n \"order_number\": \"123456\",\r\n \"booking_fee\": 750,\r\n \"ticket_details\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\",\r\n \"price\": 6500,\r\n \"premium\": 350\r\n }\r\n ],\r\n \"customer_data\": {\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"john.smith@pierinsurance.com\",\r\n \"address_1\": \"101 High Street\",\r\n \"address_2\": \"\",\r\n \"city\": \"Southend On Sea\",\r\n \"county\": \"Essex\",\r\n \"postcocde\": \"SS1 1HZ\",\r\n \"country\": \"United Kingdom\",\r\n \"language\": \"EN\",\r\n \"telephone_no\": \"01702 123456\"\r\n },\r\n \"event\": {\r\n \"event_name\": \"Champions League Final\",\r\n \"event_start_date\": \"2024-05-31\",\r\n \"event_end_date\": \"2024-05-31\",\r\n \"venue_name\": \"Wembley Stadium\",\r\n \"venue_location\": \"London\",\r\n \"venue_country\": \"GB\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/createpolicy/AD28CF2E-0054-4571-8E81-90873D7151BC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\n \"total_premium\": 350,\n \"total_ipt\": 30,\n \"email_result\": {\n \"sent\": false,\n \"reason\": \"documents not required to be sent\"\n }\n}"}],"_postman_id":"5172afee-3b6e-4b44-9091-684e27097da1"},{"name":"amendpolicy","id":"15846749-529c-4fb3-bc1c-c4791d2dc1a0","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"

Base64 encoded username:password

This API endpoint allows you to amend an existing policy by sending an HTTP POST request to the specified URL. This endpoint will cancel the existing tickets based on the \"ticket_ref\" field(s) and setup the policy based on the details in the JSON with the new ticket details. If the existing policy that the tickets are attached too has no non-cancelled tickets on the policy, the policy will also be cancelled. The request should include the necessary parameters to create the policy.

Request

Method: POST
URL: https://api.ticketplan.com/api/v1/amendpolicy/{distributorID}

Response

The response of the last execution of this API request was as follows:

Status: 200

{\n    \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\n    \"total_premium\": 350,\n    \"total_ipt\": 30,\n    \"email_result\": {\n        \"sent\": false,\n        \"reason\":\"documents not required to be sent\"\n    }\n}\n\n

Please note that the specific values in the response may vary for each execution and should be retrieved from the response dynamically.

\n","urlObject":{"protocol":"https","path":["api","v1","amendpolicy","{DistributorID}"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[{"id":"3236ddd5-eed9-4f8c-887f-140abaaffd59","name":"POST","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"Base64 encoded username:password"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"quote_id\": \"\",\r\n \"quote_country\": \"BE\",\r\n \"booking_date\": \"2023-10-13\",\r\n \"quantity\": 1,\r\n \"order_number\": \"123456\",\r\n \"booking_fee\": 750,\r\n \"ticket_details\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\",\r\n \"price\": 6500,\r\n \"premium\": 350\r\n }\r\n ],\r\n \"customer_data\": {\r\n \"firstname\": \"John\",\r\n \"lastname\": \"Smith\",\r\n \"email\": \"john.smith@pierinsurance.com\",\r\n \"address_1\": \"101 High Street\",\r\n \"address_2\": \"\",\r\n \"city\": \"Southend On Sea\",\r\n \"county\": \"Essex\",\r\n \"postcocde\": \"SS1 1HZ\",\r\n \"country\": \"United Kingdom\",\r\n \"language\": \"EN\",\r\n \"telephone_no\": \"01702 123456\"\r\n },\r\n \"event\": {\r\n \"event_name\": \"Champions League Final\",\r\n \"event_start_date\": \"2024-05-31\",\r\n \"event_end_date\": \"2024-05-31\",\r\n \"venue_name\": \"Wembley Stadium\",\r\n \"venue_location\": \"London\",\r\n \"venue_country\": \"GB\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/amendpolicy/AD28CF2E-0054-4571-8E81-90873D7151BC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\n \"total_premium\": 350,\n \"total_ipt\": 30,\n \"email_result\": {\n \"sent\": false,\n \"reason\": \"documents not required to be sent\"\n }\n}"}],"_postman_id":"15846749-529c-4fb3-bc1c-c4791d2dc1a0"},{"name":"cancelpolicy","id":"128d3e3e-2886-46b2-864f-b7facb40e2f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"

Base64 encoded username:password

\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\r\n \"tickets\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/cancelpolicy/{DistributorID}","description":"

This API endpoint is used to cancel a policy by sending an HTTP POST request to the specified URL. The request should include the distributor ID in the URL.

Request

Method: POST
\n
URL: https://api.ticketplan.com/api/v1/cancelpolicy/{distributorID}
\n

Response

The response to this request will have a status code of 200, indicating a successful request. The response body will contain information for the requested cancellation. Here is an example of the response:

[\n    {\n        \"ticket_ref\": \"TCX-TEST-001\",\n        \"result\": true,\n        \"reason\": \"\"\n    }\n]\n\n

The response is an array containing a single or multiple objects. The object has the following properties:

ticket_ref (string): The reference number of the ticket associated with the cancellation.
\n
result (boolean): Indicates whether the cancellation was successful (true) or not (false).
\n
reason (string): A description of the reason if the cancellation operation failed.
\n

Please note that the actual values of ticket_ref and reason may vary in the response.

\n","urlObject":{"protocol":"https","path":["api","v1","cancelpolicy","{DistributorID}"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[{"id":"92fcfaec-bff0-452b-bb50-82c88f0ab1b0","name":"cancelpolicy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text","description":"Base64 encoded username:password"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\r\n \"tickets\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/cancelpolicy/AD28CF2E-0054-4571-8E81-90873D7151BC"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ticket_ref\": \"TCX-TEST-001\",\n \"result\": true,\n \"reason\": \"\"\n }\n]"}],"_postman_id":"128d3e3e-2886-46b2-864f-b7facb40e2f8"},{"name":"uncancelpolicy","id":"5add65aa-29c9-42da-a7cd-d6cf8c08e394","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","description":"

Base64 encoded username:password

\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"policyid\": \"6303f099-d635-4d01-9326-20468b26cf78\",\r\n \"tickets\": [\r\n {\r\n \"ticket_ref\": \"TCX-TEST-001\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/uncancelpolicy/{DistributorID}","description":"

This API endpoint is used to uncancel a policy by sending an HTTP POST request to the specified URL. The request should include the distributor ID in the URL.

Request

Method: POST
\n
URL: https://api.ticketplan.com/api/v1/uncancelpolicy/{distributorID}
\n

Response

[\n    {\n        \"ticket_ref\": \"TCX-TEST-001\",\n        \"result\": true,\n        \"reason\": \"\"\n    }\n]\n\n

The response is an array containing a single or multiple objects. The object has the following properties:

ticket_ref (string): The reference number of the ticket associated with the uncancellation.
\n
result (boolean): Indicates whether the uncancellation was successful (true) or not (false).
\n
reason (string): A description of the reason if the uncancellation operation failed.
\n

Please note that the actual values of ticket_ref and reason may vary in the response.

\n","urlObject":{"protocol":"https","path":["api","v1","uncancelpolicy","{DistributorID}"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5add65aa-29c9-42da-a7cd-d6cf8c08e394"},{"name":"updatecustomerdetails","id":"ec755d2c-b804-46df-80fa-24ff39cc83ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"dGVzdDpXZWxjb21lMTIz","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"firstname\": \"Jurgen\",\r\n \"lastname\": \"Klopp\",\r\n \"email\": \"jurgen.klopp@me.com\",\r\n \"address_1\": \"\",\r\n \"address_2\": \"\",\r\n \"city\": \"\",\r\n \"county\": \"\",\r\n \"postcocde\": \"\",\r\n \"country\": \"\",\r\n \"language\": \"\",\r\n \"telephone_no\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.ticketplan.com/api/v1/updatecustomerdetails/{DistributorID}/{PolicyID}","description":"

This API endpoint is used to update customer policy details by sending an HTTP POST request to the specified URL. The request should include the distributor ID and the policy ID in the URL.

Request

Method: POST
\n
URL: https://api.ticketplan.com/api/v1/updatecustomerdetails/{distributorID}/{policyID}
\n

Any of the fields in the JSON body can be used to update the clients details associated with the policy. If you do not with to update a field, simply set the value to an empty string.

Response

The response to this request will have a status code of 200, indicating a successful request. The response body will contain information for the requested update. Here is an example of the response:

[\n    {\n        \"completed\": true,\n        \"errordesc\": \"\"     \n    }\n]\n\n

The response will indicate if the update has completed successfully or not and what error occured if the update failed.

\n","urlObject":{"protocol":"https","path":["api","v1","updatecustomerdetails","{DistributorID}","{PolicyID}"],"host":["api","ticketplan","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec755d2c-b804-46df-80fa-24ff39cc83ba"}]}