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.

Pay for order via "no-payment flow"

post/payments/no/payment

Confirm order payment with the "no-payment flow".

This flow can be used by any partner if the total price of an order is zero.

For orders with a total price greater than zero, this flow is reserved for partners acting as merchant of record. Permission to use this flow must be set up ahead of time.

For more info, check out our guide.
SecurityPartner
Request
header Parameters
X-Musement-Application
string (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-Currency
string (Currency code)
Default: USD

A valid currency code from the /currencies endpoint. Default value may vary depending on the X-Musement-Market header value.

X-Musement-Version
string^[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.
Request Body schema: application/json
required
id
integer
Deprecated

The numeric order ID.

uuid
required
string <uuid>

The order's UUID.

Responses
200

Order

404

Not found: specified order in request body does not exist

422

Unprocessable entity: order price is greater than zero and partner does not have permission to use "no-payment flow"

423

Locked: order has already been paid

default

Error

Request samples
application/json
{
  • "uuid": "de52057f-e788-46d6-8b18-6ccb8f9267d9"
}
Response samples
application/json
{
  • "customer": {
    },
  • "date": "2019-08-24T14:15:22Z",
  • "discount_amount": {
    },
  • "extra_data": "{\"clientReferenceId\":\"12345678\",\"firstName\":\"John\",\"lastName\":\"Smith\",\"reservationId\":\"3E5B7445-00E6-4ED6-9321-19E30D73A128\",\"utm_campaign\":\"example-it\",\"utm_content\":\"it-native\",\"utm_medium\":\"example-App it\",\"utm_source\":\"channel-abc\"}",
  • "identifier": "string",
  • "items": [
    ],
  • "market": "string",
  • "status": "KO",
  • "total_price": {
    },
  • "trustpilot_url": "http://example.com",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "total_retail_price_in_order_currency": {
    },
  • "total_supplier_original_retail_price_in_supplier_currency": {
    },
  • "total_supplier_price_in_supplier_currency": {
    },
  • "affiliate": {
    },
  • "affiliate_channel": "string",
  • "promo_codes": [
    ],
  • "source": "string"
}

Begin payment via Adyen or Stripe

post/payments/split/payment

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.
Request
header Parameters
X-Musement-Application
string (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-Version
string^[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.
Request Body schema: application/json
required
One of:
adyen_token
required
string

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

card_brand
string

The name of the credit card company.

card_country
string = 2 characters

The card's country code.

client_ip
string

The client application's IP address.

order_uuid
required
string <uuid>

The UUID of the order to pay for.

redirect_url_success_3d_secure
string <uri>

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

Responses
200

Payment details

302

Redirect to 3D Secure authentication

401

Unauthorized: order does not belong to partner

404

Not found: specified order in request body does not exist

422

Unprocessable entity: error during payment

423

Locked: order has already been paid

default

Error

Request samples
application/json
{
  • "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"
}
Response samples
application/json
{
  • "gateway": "ADYEN",
  • "3d_secure": {
    },
  • "reason": "BUSINESS_STRATEGY"
}

Complete payment via Adyen or Stripe

post/payments/split/complete_3d_secure

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.
Request
header Parameters
X-Musement-Application
string (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-Version
string^[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.
Request Body schema: application/json
required
order_uuid
required
string <uuid>

The order's UUID.

payment_intent_id
required
string

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

Responses
200

Payment details

401

Unauthorized: order does not belong to partner

404

Not found: specified order in request body does not exist

422

Unprocessable entity: error during payment

423

Locked: order has already been paid

default

Error

Request samples
application/json
{
  • "order_uuid": "e56795c7-0bc3-4742-a52f-988d2af8608f",
  • "payment_intent_id": "string"
}
Response samples
application/json
{
  • "3d_secure": {
    }
}