---
title: "Create a shareable customer checkout link"
method: POST
path: "/v1/admin/checkouts/payment-link"
tags: ["admin"]
---

# Create a shareable customer checkout link

`POST /v1/admin/checkouts/payment-link`

## Request

- Base URL: `https://api.getmyhotels.com`
- URL: `https://api.getmyhotels.com/v1/admin/checkouts/payment-link`
- Auth: HTTP bearer

## Request body

- object
  - `hotelPublicId` string, required
  - `hotelName` string, required
  - `roomName` string, required
  - `checkIn` string, required
  - `checkOut` string, required
  - `price` number, required
  - `stayTotal` number
  - `nightlyPrice` number
  - `pricingBasis` 'stay_total' | 'nightly'
  - `availableRooms` number
  - `currency` string, required
  - `rooms` object[]
    - `id` string, required
    - `name` string, required
    - `bedType` string, required
    - `maxOccupancy` number, required
    - `amenities` string[], required
    - `price` number, required
    - `stayTotal` number
    - `nightlyPrice` number
    - `pricingBasis` 'stay_total' | 'nightly'
    - `availableRooms` number
  - `offerRef` string
  - `requiresLatinGuestNames` boolean
  - `supplierCode` string
  - `supplierHotelId` string
  - `supplierRoomId` string
  - `hotelStarRating` number
  - `hotelCity` string
  - `hotelCountry` string
  - `images` unknown[]
    - unknown
  - `address` string
  - `reviewScore` number
  - `reviewCount` number
  - `property` object: Supplier property display snapshot.
  - `roomMaxOccupancy` number
  - `roomBedType` string
  - `bookingRooms` number
  - `adults` number
  - `childGuests` number
  - `childrenAges` number[]
  - `infants` number
  - `cancellationSummary` string
  - `refundable` boolean
  - `freeCancellationUntil` string, nullable
  - `mealPlan` string
  - `supplements` object[]
    - `type` string, required
    - `description` string, required
    - `price` number, required
    - `currency` string, required
  - `rateConditions` string[]
  - `roomPromotions` string[]
  - `amenities` string[]
  - `withTransfers` boolean
  - `perNightRates` number[]
  - `savedPaymentMethodPublicId` string

## Response `200`

Success

- unknown

## Other responses

- `400`: Request validation failed or the router rejected the input
- `401`: Missing or invalid bearer session token
- `403`: The account does not have admin access
- `409`: The request conflicts with the resource's current state
- `426`: Reported X-GMH-App-Version is below the supported minimum — the app must update
- `500`: Unexpected server error (opaque; details stay in logs)

---

[API](https://skmtc.dev/getmyhotels/apis/getmyhotels-rest-api.md) · [All operations](https://skmtc.dev/getmyhotels/apis/getmyhotels-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getmyhotels/apis/getmyhotels-rest-api/revisions/cba24a9c13f0?raw)