Last updated

Use cases

Follow the use cases instructions to construct your order/create request according to your specific business scenario.


The following examples show the most common payment scenarios applied to different parnership types, methods, timings and type of payments (online and offline payments).

  • Each use case shows the payment structure that you need to define in the /orders/create request for each case.

  • Follow the instructions that are relevant to your particular payment use case.

1. Check the available payment options

Before going to specific instructions on how to create your order request for your payment scenario, you must check the available timings, schedules and, payment methods for the desired accommodations.

Depending on the use case you are implementing, use one of the endpoints provided to check the available payment options.

Type
Endpoint
Response
houseIconPay at propertyUse /accommodations/detailsIt returns the set of methods that a property accepts when paying at the property at checkin date.
walletOnline paymentUse /orders/previewIt returns the set of methods that a property accepts to secure the reservation:
  • For pay online now / later, securing the reservation also means paying for it.
  • For pay at property, the payment methods shown in /orders/preview might be only used for cancellation and no show fees.

Refer to the Quick guide for examples and initial instructions on how to check available payments options.

2. Create your order

When the traveller has selected how and when they want to book, use /orders/create to make the booking.

  • You need to construct your order request matching the requirements of your particular payment use case.
  1. Jump into the payment use case that is relevant to your business for specific instructions on how to set your order requests.
  2. Go to your /orders/create request.
  3. Specify the needed information in the payment object, following the examples and recommendations provided in each use case.

Use cases

Partners paying on travellers behalf

Partners not paying on travellers behalf

Corporate partners

Traveller paying at property