REFUND PROTECT INTEGRATION GUIDE

  Introduction

Welcome to the Refund Protect Integration Guide, which is designed to help you set up the Refund Protect offering on your booking platform.

For the first step of the Refund Protect integration, a member of the Protect Group team will provide you with a new Protect Platform account with your VendorID and API Key.

If you have registered for a Protect Platform account you will receive an email from our Protect Platform with access credentials.

Please get in touch with our integrations team ([email protected]) should you require your VendorID, API Key and/or Protect Platform details

About the API

This simple Refund Protect API is a REST service with UTF-8 encoding. 
This Integration Guide is split into 2 parts:

• REST API Documentation
• Checkout Placement Setup

We have produced a Postman collection to allow you to view examples of the requests and to act as a template, you can view the collections in the sections below.

Suggested Development Process

1. Receive your UAT VendorID and API Key from Protect Group Manager ([email protected])
2. Using the Sales Request Header and Data Structure as found in this guide, write your code and test using the UAT Endpoint (found below). Here are a couple of hints:
   
   1. You can use the json data from this guide as a content starting point and send transactions from within Postman.
   2. Using Postman you can input your data to create content and validate
   3. Each API call requires a unique vendor reference ID
3. Once the integration work is tested and approved, you will need to swap the UAT Endpoint and UAT VendorID / API Key with the Live Production Platform Endpoint and VendorID / API Key. Please Note: UAT and production credentials are NOT the same and production credentials are provided by the Protect Group team once tests have been validated.
4. Remember that transactions sent through UAT will be not be officially protected and are not billed for, therefore you can send through as many as are needed for testing. We recommend a minimum of 10 test transactions before proceeding to the Live Production Platform and this includes both sold:true and sold:false transactions.

Postman Collections You can access our Postman Collection which contains examples of the headers, requests and allows you to directly test your data structure.

  Sales Request

What does this do?

This tells us that a customer has or has not selected Refund Protect to protect their non-refundable transaction. You will send us the request in the same format as the data structure as shown below when a customer completes their booking and makes their payment.

We also need to know when the customer chooses not to select Refund Protect on their booking as this helps us to analyse your customer conversion rate and help optimise your sales process of Refund Protect. Please note: this is a mandatory requirement however can receive “false” information in the data structure to comply with data regulations.

Request URL

The following URL is to be used in order to send test transactions to the UAT Endpoint. Once tests have been validated by the Refund Protect Technical team, you will be provided with a Live Production URL which you will simply swap.

UAT Request URL - https://test.api.protectgroup.co/api/v1/refundprotect/salesoffering

IMPORTANT INFORMATION

  Sales Request Data Structure

Each sales request must have a predefined set of content and must conform exactly to the specified rules as found below:

The data structure is separated into 2 entities:

• Transaction related data
• Sales related data

{

"vendorCode": "DemoVendorId ",
"vendorSalesReferenceId": "UniqueID-9166-9877-1234-3211", 
"VendorSalesDate":"2020-03-02T07:42:36.73+11:00",
"customerFirstName": "John",

"customerLastName": "Doe",

"products": [ 
{

"productCode": "HTL",

"currencyCode": "USD",

"productPrice": 100,

"premiumRate": 8.0,

"offeringMethod": "OPT-OUT",

"sold": true,

"insuranceEndDate": "2018-06-15T23:59:59.999" 
}
]
}

Postman Collections Test your data structure using our Postman Collections here!

Transaction Related Data Explanation:

Sales Related Data Explanation:

Response Signals:

IMPORTANT INFORMATION

  Cancellation API

This API is used to cancel a previously submitted transaction. This API uses a slightly different Request URL, requiring the transaction booking reference number at the end of the URL however everything else is exactly the same.

UAT Request URL - https://test.api.protectgroup.co/api/v1/refundprotect/{transactionID}{transactionID}

Once the tests have been validated by the Protect Group team, you will be provided with a Request URL for the Live Production Environment.

Request Header

  Checkout Placement Setup

The following section provides the wording and visuals for the front-end placement of Refund Protect in your online checkout and booking confirmation emails.

It is important that you decide on the best front-end sales process of Refund Protect to incorporate within your booking flow. You MUST consider the local consumer sales regulations of your country as this sales process is your responsibility as the Member of Refund Protect.

You must present Refund Protect in the following way to ensure that your option of a refundable booking is in no way considered insurance and is not connected to our Refund Protect brand.

Option A		INFORMED CHOICE
Option B		NEXT STEP
Option C		APPLY TO ALL

OPTION A:  INFORMED CHOICE INFORMED CHOICE is a process where the Refundable booking is offered to customers in a single-page checkout and/or booking flow. The price is included within the section and the ‘Refundable’ selection is highlighted and ‘(Recommended)’. The customer must be provided with both a ‘REFUNDABLE’ and ‘NON-REFUNDABLE’ option and must select either one to proceed with the next step of the booking process. **IMPORTANT: Please ensure that INFORMED CHOICE is compliant with consumer sales regulations within your country if you wish to adopt this sales process. WORDING O Refundable booking (Recommended) £X.XX - Sickness, Accident, Injury - Public transport failure - Private vehicle failure - Emergency services recall - Home emergency - Immediate relative sickness - Pre-existing medical conditions And many more… Upgrade your booking and receive a 100% refund if you cannot attend and can evidence one of the many reasons in our Terms and Conditions, which you accept when you select a Refundable Booking. O Non-refundable booking Terms and Conditions URL You must link the Terms and Conditions in the placement wording above to our most up-to-date terms using the URL: https://www.refundable.me/ For a personalised Refundable URL with your brand included, please contact your Protect Group Manager.

OPTION B:  NEXT STEP NEXT STEP is designed for multi-step checkouts whereby the Refundable option is offered to the customer on a separate page before payment. The customer is encouraged to opt-in through the “Refundable booking” button in Green. This process is only suitable for booking flows that are multi-stage and would not be fit for implementation into a single page checkout. We’d therefore recommend the INFORMED CHOICE sales process for these types of checkouts. **IMPORTANT: Please ensure that NEXT STEP is compliant with consumer sales regulations within your country if you wish to adopt this sales process. WORDING Upgrade to a Refundable booking (Recommended) - Sickness, Accident, Injury - Public transport failure - Private vehicle failure - Emergency services recall - Home emergency - Immediate relative sickness - Pre-existing medical conditions And many more… Upgrade your booking and receive a 100% refund if you cannot attend and can evidence one of the many reasons in our Terms and Conditions, which you accept when you select a Refundable Booking. Keep my booking Non-refundable Terms and Conditions URL You must link the Terms and Conditions in the placement wording above to our most up-to-date terms using the URL: https://www.refundable.me/ For a personalised Refundable URL with your brand included, please contact your Protect Group Manager.

  Terms of Sale

To add the latest version of the Refundable Terms into your existing terms of sale, you can either insert a section of text which directs customers to the external Refundable Terms URL (https://refundable.me), or you can embed the below code to display the live Refundable Terms within your own website.

Both of these methods are inserted within your Terms of Sale to customers to always provide customers with access to the Refundable Terms and Conditions and all wording is provided below:

Option A: External Link Wording

Please insert the following wording into your existing Terms of Sale alongside your standard refund terms. Please note, if you choose the “Apply to All” sales implementation method above, please insert the Apply To All wording as below.

INFORMED CHOICE / NEXT STEP sales methods wording:
If you have selected Refundable Terms on your booking and are unable to attend your booking due to unforeseen circumstances outside of your control you may be entitled to a refund - please see our full set of Refundable Terms and Conditions here. To apply for a refund, please find the instructions on how to apply in the booking confirmation email you received after payment.

For any other refund enquiries, including where your is cancelled or changed by the , please contact our customer service team at .

APPLY TO ALL sales method wording:
We provide all our customers with Refundable Terms so if you are unable to attend your booking due to unforeseen circumstances outside of your control you may be entitled to a refund - please see our full set of Refundable Terms and Conditions here. To apply for a refund, please find the instructions on how to apply in the booking confirmation email you received after payment.

For any other refund enquiries, including where your is cancelled or changed by the , please contact our customer service team at .

Option B: Embed Refundable Terms & Conditions

To display the latest set of Refundable Terms within your own terms of sale page, you can insert the following code to display a live embed of the Refundable Terms.

Please use the title “Refundable Bookings” for this section within your Terms of Sale.

Embed code

Booking Confirmation Email It’s very important that you place the wording in your Booking Confirmation email which you normally send to customers after their payment to confirm their booking. This must be the only email referencing Refundable Terms to position the service correctly in a legal and compliant manner. The following additional wording in your booking confirmation email provides information on their Refundable Terms which are applied to their booking, how to apply for a refund should they be prevented from attending due to a circumstance within the Refundable Terms and the reference (your own booking referenceb posted through API) they should use for the Refund Application Form: INFORMED CHOICE / NEXT STEP sales methods wording: You selected refundable terms with your booking, so if you are unable to attend your booking due to unforeseen circumstances and can provide evidence as listed in the Terms and Conditions here, you may be entitled to a full refund. You will need your reference number <Insert VendorSalesReferenceID> to apply for your refund using the form here. For any other refund enquiries, including where your <Insert booking type> is cancelled or changed by the <Insert supplier type>, please contact our customer service team at <Insert your standard customer service point of contact>. APPLY TO ALL sales methods wording: This is a Refundable booking, so if you are unable to attend your booking due to unforeseen circumstances and can provide evidence as listed in the Terms and Conditions here, you may be entitled to a full refund. You will need your reference number <Insert VendorSalesReferenceID> to apply for your refund using the form here. For any other refund enquiries, including where your <Insert booking type> is cancelled or changed by the <Insert supplier type>, please contact our customer service team at <Insert your standard customer service point of contact>.

CONTACT OUR TEAM

If you have any questions or require further clarification on the Refund Protect API Integration, please get in touch with our technical support team using at [email protected]