Skip to content
API reference/
/
Complete payment via Adye...

Musement API (3.5.0)

For merchant or affiliate partners wishing to use the Musement API.

Find out more about Musement API

Authentication

See the Authentication section for details on how to authenticate with the API.

Release notes

2024-06-18

Endpoints

  • GET /activities/{activityUuid}/dates/{date}
    • Changed default min_buy value from -1 to 1

2024-02-21

Endpoints

  • Added GET /orders/{orderUuid}/refunds
    • Returns an array of paid refunds for an order

2024-02-20

Endpoints

  • GET /activities/{activityUuid}/dates/{date}
    • Added availability, max_buy and min_buy properties to timeslots. For more info, check out our guide
Download OpenAPI description
openapi.json
openapi.yaml
Overview
API distribution team
api-distribution@tui.com
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://partner-api.musement.com/_mock/reference/openapi
Sandbox server
https://sandbox.musement.com/api/v3
Production server
https://api.musement.com/api/v3

Searching activities

A collection of endpoints which can be used to search the catalog for relevant activities.

Operations

Activity info

A collection of endpoints which can be used to provide information to customers about a specific activity.

Operations

Pickups

Some activities require selecting a pickup location as part of the booking flow.

Operations

Dates

A collection of endpoints for selecting available dates and products.

Operations

Carts

A collection of endpoints for managing a customer's cart during the booking flow.

Operations

Customer info

When making a reservation, different steps must be taken to provide information about the customers. This collection includes endpoints for submitting info about the lead booker, extra customer data and participant info.

Operations

Orders

A collection of endpoints for managing orders as part of the booking flow.

Operations

Payments

A collection of endpoints regarding payment during the booking flow. Partners have multiple payment options at their disposal, depending on agreements with the Strategic partnerships team.

Operations

Begin payment via Adyen or Stripe

Request

Start paying for an order using either Adyen or Stripe.

Use of this endpoint requires completing payment with the POST /payments/split/complete_3d_secure endpoint.

For more info, check out our guide.
Headers
X-Musement-Applicationstring(Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

For more info, check out our guide.
X-Musement-Versionstring^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
For more info, check out our guide.
Bodyapplication/jsonrequired
One of:
adyen_tokenstringrequired

The Adyen token, prepared on the client application's side.

card_brandstring

The name of the credit card company.

card_countrystring= 2 characters

The card's country code.

client_ipstring

The client application's IP address.

order_uuidstring(uuid)required

The UUID of the order to pay for.

redirect_url_success_3d_securestring(uri)

The URL to send customers to after they have completed 3D Secure authentication.

curl -i -X POST \
  https://partner-api.musement.com/_mock/reference/openapi/payments/split/payment \
  -H 'Content-Type: application/json' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0' \
  -d '{
    "adyen_token": "string",
    "card_brand": "string",
    "card_country": "st",
    "client_ip": "string",
    "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
    "redirect_url_success_3d_secure": "http://example.com"
  }'

Responses

Payment details

Bodyapplication/json
gatewaystring

The payment gateway to use.

Enum"ADYEN""STRIPE"
3d_secureobject(Payment3dSecure)

Information required for setting up 3D Secure authentication.

reasonstring

An indication of which payment gateway was selected:

  • BUSINESS_STRATEGY: automatically based on which gateway provides the best commission.
  • CLIENT_SELECTED: based on request body.
  • FALLBACK: when one gateway payment attempt fails, the other is selected for a second attempt.
Enum"BUSINESS_STRATEGY""CLIENT_SELECTED""FALLBACK"
Response
application/json
{
  "gateway": "ADYEN",
  "3d_secure": {
    "payload": {},
    "payment_intent_client_secret": "string",
    "type": "FORM",
    "url": "http://example.com"
  },
  "reason": "BUSINESS_STRATEGY"
}

Complete payment via Adyen or Stripe

Request

Finish paying for an order using either Adyen or Stripe.

After completing 3D Secure authentication, use this endpoint to confirm successful payment for the order.

For more info, check out our guide.
Headers
X-Musement-Applicationstring(Application value)

A partner's application value, used for analyzing API usage and to identify areas of improvement.

For more info, check out our guide.
X-Musement-Versionstring^[0-9]+?.[0-9]+?.[0-9]+?$

The API version to use for the request.

When absent, the latest version is used by default, however the latest version may not be stable. Partners are encouraged to use the latest stable version: 3.4.0.

Example: 3.4.0
For more info, check out our guide.
Bodyapplication/jsonrequired
order_uuidstring(uuid)required

The order's UUID.

payment_intent_idstringrequired

The payment intent ID received from starting 3D Secure authentication.

curl -i -X POST \
  https://partner-api.musement.com/_mock/reference/openapi/payments/split/complete_3d_secure \
  -H 'Content-Type: application/json' \
  -H 'X-Musement-Application: string' \
  -H 'X-Musement-Version: 3.4.0' \
  -d '{
    "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
    "payment_intent_id": "string"
  }'

Responses

Payment details

Bodyapplication/json
3d_secureobject(Payment3dSecure)

Information required for setting up 3D Secure authentication.

Response
application/json
{
  "3d_secure": {
    "payload": {},
    "payment_intent_client_secret": "string",
    "type": "FORM",
    "url": "http://example.com"
  }
}

Cancellations

It is possible to cancel reservations, provided that the activity in question is refundable.

Operations

Activities

Activities can be any tour, attraction or experience that customers can reserve via the Musement API.

Operations

Categories

Categories group activities based on similar characteristics.

Operations

Cities

Cities are different types of destinations: islands, natural landmarks, beaches, actual cities and more.

Operations

Countries

A collection of endpoints related to countries in the Musement catalog.

Operations

Lists

Lists are collections of Musement activities and third-party destinations grouped together based on editorial themes.

Operations

Venues

Venues are popular attractions or landmarks.

Operations

Additional searches

A collection of additional endpoints which can be used to search parts of the catalog.

Operations

Carts

A collection of cart endpoints which are not strictly necessary for the booking flow.

Operations

Metadata

Metadata is used for configuring several activity properties.

Operations

Reviews

Customers may leave reviews about their experience with an activity. Reviews consist of a numeric rating and optional written comment.

Operations

Vouchers

A collection of endpoints to use at the end of the booking flow to retrieve reserved tickets and vouchers.

Operations

Webhooks

A collection of webhook requests that Musement's API can make to a partner's service.

Webhooks

Activities

A collection of deprecated endpoints for activities.

Operations

Carts

A collection of deprecated endpoints for carts.

Operations

Cities

A collection of deprecated endpoints for cities.

Operations

Verticals

Verticals are a type of macro category which group various parts of the catalog together based on similar characteristics.

They are considered deprecated.

Operations

Cities

A collection of endpoints for cities that were removed from the API.

Operations

Countries

A collection of endpoints for countries that were removed from the API.

Operations

Events

A collection of endpoints for events, an older term for activities, that were removed from the API.

Operations

Misc

A collection of various endpoints that were removed from the API.

Operations

Venues

A collection of endpoints for venues that were removed from the API.

Operations
Copyright © TUI Musement. All rights reserved.