Integrating with VostroPay on your website
Purpose
This article will outline what is needed to replace your
existing Vault integration with a VostroPay (Till Payments) integration. You will have the choice
of either taking a payment at the time of booking or saving card details to be
charged in the future (like your existing Vault implementation).
We have two options to choose from:
- Simple Integration - our API will do most of the work for you (saving card details for future payments, no payments can be taken yet using this integration)
- Full Control Integration - you will integrate directly with the Payment Gateway and have full control over styling, display and event handling, and be able to take a payment at the time of booking.
OPTION 1 - Simple Integration
This option is the quickest and easiest way to get up and running with VostroPay in your website. Note that this option will create a credit card registration token which will allow you to create payments and authorisations via RCM later in the booking process. This option will not take a payment.
1. Start the Transaction
After your API booking call has succeeded, call our v3.2 API method createpaymenttransaction with the following parameters:
- var jsonStr = JSON.stringify({
- "method": "createpaymenttransaction"
- , "reservationref": rcmReservationRef //the reservationref field that is returned from the booking API method
- , "paymentgatewaytype": "VOSTROPAY"
- , "transactiontype": "cardregistration"
- , "amount": 0
- , "payscenario": "1" //1=card registration taken at the time of booking, 2=card registration when quotation converted to booking, 3=card registration at any other time
- , "paysource": "your payment source here" //descriptive text for the source of this card registration, e.g. your website
- , "emailoption": "1" //0=no email, 1=default behaviour, 2=always send - if card registration is successful then the confirmation email will be sent to the customer
- });
This API method will return various fields, the one that you are interested in is the "RedirectUrl". See sample response below:
2. Load the Credit Card Input Page
Using our API response, find the "RedirectUrl" output. This is an HTML page that will have all the card entry fields. You will need to host this page within an IFrame on your own page.
e.g. HTML:
- <iframe src="about:blank" id="paymentIFrame" style="width: 100%; height: 600px;"></iframe>
e.g. Javascript:
- document.getElementById('paymentIFrame').src = data.results.RedirectUrl;
Your IFrame will display the credit card input screen as follows:
3. Listen for the Result
Your page that hosts the IFrame will need to register an event listener. The event type will be "VostroPayCallback", and the event.data will have a "result" of one of the following:
- "success" - card has been registered successfully, and recorded in RCM. Confirmation email has been sent where required.
- "success" - card has been registered successfully, and recorded in RCM. Confirmation email has been sent where required.
- "error" - the card was invalid or unable to be verified. The booking remains in RCM but it may not be in its final state, e.g. depending on your system settings, it may remain as a quotation. No email is sent to the customer.
- "cancel" - the user cancelled out of the process, as above the booking may not be in its final state.
- window.addEventListener("message", receiveMessage, false);
- function receiveMessage(event) {
- if (event.data.type && event.data.type === 'VostroPayCallback') {
- var result = event.data.result;
- if (result === 'success') {
- GoToConfirmation(); //booking process has ended successfully, show a nice summary screen
- } else {
- GoToBookedWithProblem(); //card registration was unsuccessful, but the booking still exists so provide a message asking customer to (perhaps) contact you to confirm next steps
- }
- }
- }
Note: If you'd like to verify the origin of the event, you can expect it to come from https://paymentcallback.rentalcarmanager.com
OPTION 2 - Full Control Integration
For advanced development - you will have full control over the display, styling and event handling by interacting directly with the payment gateway APIs. You will need to call our API once the card registration/payment has been finalised.
Website Changes
We recommend reviewing Till Payment's Gateway Documentation as a starting point. This will familiarise you with the high level concepts of the Till Payments API and prepare you for the technical integration. For API specifics, please see Till's API Reference V3 documentation.
Till Payments Integration Options
We recommend using Till’s Javascript Integration which will
let you embed a card entry form in your website and give you the most control
over payments/collecting card details. You also have the options of Full-Page Redirect and Hosted Payment Form integrations which may be simpler to implement but won't provide as seamless of a customer experience as the Javascript integration.
- Javascript integration - The most seamless experience for customers and the most flexible integration method in terms of styling/design.
- Hosted Payment Form - The card form is embedded in an iframe and hosted by Till, keeps users in your checkout but less flexible styling options.
- Full-Page Redirect - Redirects the customer from your checkout to a Till hosted page to collect card details. The user is then redirected back to your site after the transaction is complete.
You can read more about each of these integration methods here: https://gateway.tillpayments.com/documentation/gateway#transaction-process.
Saving Cards for Future Charges
If you need to save the card details to be charged in the future,
please ensure you have set the “withRegister” parameter when creating
your Debit request or you are using the Register transaction type if you do not need to take payment at the time of booking. To save a customer’s card details without charging them at the time of booking see the Register transaction type: https://gateway.tillpayments.com/documentation/apiv3?php#transaction-request-register.
You can read more about saving customer cards here: https://gateway.tillpayments.com/documentation/gateway#card-on-file-and-recurring-transactions.
3D Secure
We recommend enabling 3D Secure on transactions to help protect you (the merchant) from chargebacks/disputes with customers. 3D Secure is configured at the transaction level with Till, you can read more about 3D Secure here: https://gateway.tillpayments.com/documentation/gateway#3d-secure-authentication.
RCM API Calls
You will need to pass the results from Till to RCM to
record any payments and add any collected card details for use in RCM.
Payment
To save a Till payment call the “confirmpayment” RCM API method and pass in the following Till details:
Parameter | Value |
reservationref | Booking reference code returned from method booking. |
amount | Payment amount. |
success | Indicate if payment was successful. |
paytype | Payment type, like Visa or Mastercard. |
paydate | Payment date. |
supplierid | |
transactid | The Till transaction UUID (e.g., “abcde12345abcde12345”). |
dpstxnref | The Till transaction UUID (e.g., “abcde12345abcde12345”). |
cardholder | The cardholder’s name. |
paysource | Optional Payment Source eq. 'Payment from Web API3.x'. |
cardnumber | The last 4 digits of the card as returned by Till. |
| cardexpiry | The card expiry returned by Till in the format of “MM/YY”. |
transtype | The transaction type, in this case “Payment”. |
merchfeeid | Optional Merchant Fee ID corresponding to a Merchant Fee ID setup within the system. |
payscenario | Payment scenario when calling this method, possible values are: 1= at time of original booking (default), 2=convertquote, 3=prehire e.g. editbooking. |
emailoption | Email option, 0=never send email, 1=default behaviour, 2=always send email. |
Example request body:
{"method": "confirmpayment","reservationref": "43F355C1223","amount": 500,"success": true,"paytype": "Credit Card","paydate": "01/01/2022","supplierid": 0,"transactid": "abcde12345abcde12345","dpstxnref": "abcde12345abcde12345","cardnumber": "9969","cardexpiry": "01/25","cardholder": "John Doe","transtype": "Payment"}
Card Registration Only (No Payment)
If you are only collecting the customer’s payment details for future usage, call the
“rebillingtoken” method with the following parameters:
Parameter | Value |
reservationref | Booking reference code returned from method booking |
paytype | Payment type, like visa or mastercard |
supplierid | |
paysource | Optional Payment Source eq. 'Payment from Web API3.x' |
rebillingtoken | The Till transaction UUID (e.g., “abcde12345abcde12345”). |
cardnumber | The last 4 digits of the card as returned by Till. |
cardexpiry | The card expiry returned by Till in the format of “MM/YY”. |
cardholder | The cardholder’s name. |
Example request body:
{"method": "rebillingtoken","reservationref": "43F355C1223","paytype": "Credit Card","supplierid": 0,"paysource": "Website","rebillingtoken": "abcde12345abcde12345","cardnumber": "9969","cardexpiry": "01/25","cardholder": "John Doe"}
Important Articles
- Whats New in RCM
- Getting Started with RCM
- Standard RCM Procedures
- Card Vault Deprecation 2025 – Frequently Asked Questions
Related Articles
Integrating with Stripe on your website
Purpose This article will outline what is needed to replace your existing Vault integration with a Stripe integration. You will have the choice of either taking a payment at the time of booking or saving card details to be charged in the future (like ...API V3.2 Booking Process
Overview The RCM API and Agent API allow you to make unallocated bookings for a specified vehicle category, for a specified pickup and drop off date. An unallocated booking is a booking that has been made for a particular category (e.g. small car), ...Getting Started with API V3.2
Overview Rental Car Manager (RCM) provides a Web API through which you are able to use to build a set of booking steps which you can plug into your website. This API also allows for Agents to have access and search for availability of vehicles and to ...Package Deals Process
Overview Rental Car Manager (RCM) allows for the setup of Packages which can be used as the basis to create a new booking. You are able to use the Web API to obtain information about available packages and also make a booking based on a package deal. ...Relocation Specials Process
Overview The Relocation Specials function allows Rental Car Companies to setup relocation special deals within Rental Car Manager (RCM) and have them available for booking on their websites. The Web API can be used to both obtain a listing of ...