Last updated

Payments - 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.

Use the right endpoint for each type of payment:

Type
Endpoint
Response
houseIconPay at the property/accommodations/detailsIt returns the set of methods that a property accepts when paying offline at the property at checkin date.
walletOnline payments/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 the 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 payment options.

2. Create your order

Once a traveller has chosen how and when to book, use /orders/create to process the payment.

Construct your request to match the specific requirements of your payment use case.

Steps
  1. Jump into the payment use case that is relevant to your business.
  2. Check whether you meet all the requirements.
  3. Look at the order/preview response provided as example.
  4. Go to your /orders/create request.
  5. Specify the needed information in the payment object following the examples and recommendations provided for your use case.

Use cases

Partners paying on travellers behalf

Partners not paying on travellers behalf

Corporate partners

Traveller paying at property

Curious to know more?
  • Learn about all the available payment methods and timings.
  • Refer to the Quick guide for initial instructions on how to check available payment options.
  • Explore the Orders section for examples and best practices on creating and checking orders.
Previous page
Next page