HolidaySG App
Book attractions faster
GET

Media Release

Ferry API for partners: sailings, exact prices and wallet bookings

Search sailings, quote the exact total on our server, book from the wallet and ask us to cancel.

Boats on turquoise water near a tropical island

HolidaySG has added ferry tickets to its Partner API. A partner can list sectors, search sailings for a date, receive the exact total worked out on HolidaySG servers and book from a prepaid wallet, with one or both ways. Cancellation is a request that our team reviews, so nothing is cancelled or refunded without a person.

What partners can do

The Ferry API sits under the same base address, with the same key, address allow-list, rate limits and request signing as the other services. A key needs the ferry scope; without it, every ferry path is refused. Prices are set by HolidaySG in Singapore dollars and worked out on our server, so a partner never sends a price in order to book. Payment is from the wallet only, with no card and no credit line, and a partner sets its own selling price.

  • GET /ferry/sectors lists routes and the nationality codes to use for passengers.
  • POST /ferry/search lists sailings and per-person prices.
  • POST /ferry/quote returns the exact total for the chosen sailing or sailings.
  • POST /ferry/bookings books, signed with an idempotency key.
  • GET /ferry/bookings/{id} reads a booking.
  • POST /ferry/bookings/{id}/cancel sends a cancellation request.

The flow, step by step

The recommended order is sectors, search, quote, booking, with the quote total passed back as the expected total.

  1. Read the sectors. Each has an identifier such as SIN-BAT for origin and destination, and the call also returns the nationality codes and the limit of nine passengers per booking.
  2. Search with the sector, the departure date, and the number of adults and children. For a two-way trip add a return date, or ask for an open return, and, if the return is on a different sector, name it.
  3. Choose a sailing. Each shows departure and arrival times, the vessel, seats, whether it is sold out, whether the return date is open, per-person prices and whether it is off sale. A sold-out or off-sale sailing cannot be booked.
  4. Request a quote for the chosen sailing. Per-person prices for a two-way trip depend on the pair, so take the total from the quote.
  5. Book with the quote total as the expected total.

Passenger details

A booking names the contact and every traveller, adults and children together. Each passenger needs a name, as on the passport with letters, spaces, apostrophes, full stops and hyphens, a gender of M or F, a date of birth, a passport number, a passport expiry date in the future and a nationality code from the sectors call. Passport data is stored encrypted and masked ninety days after travel.

Booking safely

The booking call is signed and needs an idempotency key. Repeating the same request returns the same booking. If HolidaySG's price has moved since the quote, the request is refused with a price-changed answer and nothing is charged, and the partner asks for a fresh quote.

Each answer says what to do next.

  • Booked, or the same booking again on a repeated key.
  • Accepted but under review: our team checks it. Do not retry; read the booking later.
  • Insufficient funds or payment failed: nothing was booked.
  • Sailing unavailable or price changed: search or quote again.
  • Request in progress or payment under review: do not retry and contact us.
  • Booking review: the wallet was debited and our team is reviewing the booking. Do not retry.

Cancellation is a request

The cancel call takes an optional reason of up to 300 characters and answers that the request was received. HolidaySG staff review it. Nothing is cancelled or refunded automatically, and a wallet refund follows only after a person approves it. Repeating the call returns the same request, and a booking that is already cancelled is reported as such.

Reading bookings and handling errors

A booking can be read with its status, booking reference, sector, dates, passenger counts, total and currency, and only by the partner who made it. Trouble when searching or quoting is reported with a code that carries the HTTP status, for example when schedules are temporarily unavailable, and the right response is to try again shortly. The booking reference field is the one to use; a second field with the same value is kept for older integrations and is deprecated.

Testing without a real booking

On a sandbox key, a booking is validated and priced exactly like a live one and is then answered as a simulation, with an identifier that starts with SBX- and a sandbox flag. Nothing is booked and nothing is charged. The simulated booking can be read back for seven days, only by the key that made it, and a cancellation request on it is answered but sent to nobody. A repeated idempotency key with the same request returns the same simulated booking, and a different request on that key is refused.

What is not included

The partner API does not cover visa services or flight reservations. Ferry is a wallet-only service, and partners who need a different arrangement should write to api@holidaysg.com.

Frequently asked questions

Do I send a price when I book?

No. Send the quote total as the expected total. If our price has moved, you receive a price-changed answer and nothing is charged.

Can I pay by card or credit line?

No. Ferry bookings are paid from the prepaid wallet only.

How do I book a two-way trip?

Add a return date, or ask for an open return, and name the return sector if it differs. Take the two-way total from the quote.

Is a cancellation immediate?

No. It is a request that our team reviews. Nothing is cancelled or refunded automatically.

What if a booking is accepted but under review?

Do not retry. Our team checks it, and you can read the booking later for its status.

Is passport data safe?

Passport details are stored encrypted and masked ninety days after travel.

How do I test without a real booking?

Use a sandbox key. The booking is simulated, starts with SBX- and can be read back for seven days.

Explore the Partner API

About HolidaySG

HolidaySG.com is a Singapore travel platform for attractions and tours, visas, hotels, ferry tickets and eSIM plans, with a B2B portal and Partner API for travel businesses.

Media enquiries: contact us.

Google reviews

5.0 ★★★★★

Based on 129 reviews of HolidaySG on Google

★★★★★

I booked all my tickets on this Singapore website. The process was smooth and efficient I’m very satisfied and would definitely use it again
Vincent Yu · 7 months ago on Google

★★★★★

Tickets are issued very fast. Price is also reasonable. Very satisfied purchase!
David Yap · 3 months ago on Google · Flight reservation customer

★★★★★

Fantastic experience with Holiday SG , i have planned 5 days Singapore for my daughters from India. The whole package includes Hotel Booking,Transport, Sightseeing, VISA...
Santosh Mkar · 7 months ago on Google

★★★★★

Had an amazing 3 Days Malaysia Tour with HolidaySG! Everything was perfectly organized from hotel pickup to sightseeing. Our itinerary included Day 1: Kuala Lumpur City T...
Htun · 4 months ago on Google

More from HolidaySG

Things to do worldwide

Attractions, tours and experiences in destinations around the world.

HolidaySG eSIM plans

Mobile data for your trip: install a HolidaySG eSIM on your phone before you travel, no SIM card swap needed. Choose your destination on the HolidaySG eSIM page; eSIM plans are bought there, separately from tickets.

Need a flight reservation for your visa?

Applying for a visa? Embassies often ask for a flight itinerary. A flight reservation is not an issued ticket.

Hotels worldwide

Compare hotels in popular destinations and check room rates for your dates on HolidaySG.

Free travel tools

Trip cost calculators and free online tools to plan your holiday.

Work with HolidaySG

Travel agents, suppliers and developers: join our partner programmes or connect through the HolidaySG API.

Ask me anything!
HolidaySG panda mascot

Luna
Luna — HolidaySG

We use cookies

Read our Cookie Policy