BookingDeposit

Interface

Buyer-facing details required to complete a reservation deposit.

Property

Type

Optional

Description

amountCents

number

No

Deposit amount in minor currency units (for example, cents). Always a positive integer.

captureToken

string

No

Short-lived, opaque capability authorizing a guest to refresh this payment.<br>Pass it unchanged to ReservationsService.refreshPayment after checkout.

checkoutUrl

string

No

Opaque hosted-checkout URL where the buyer completes the deposit.

currency

string

No

ISO 4217 currency code for the deposit (for example, 'EUR').

paymentId

string

No

Opaque payment reference (prefixed 'pay_...') used by ReservationsService.refreshPayment.

BookingDepositResult

TypeAlias

Result of ReservationsService.book. A reservation without an online deposit keeps the existing confirmed Booking shape. A reservation that requires a deposit is returned as pending with the hosted-checkout details needed to continue.

TypeScript
type BookingDepositResult = Booking & { deposit?: never } | Omit<Booking, "status"> & { deposit: BookingDeposit; status: "pending" }

PaymentRefreshResult

Interface

Status-only response returned by ReservationsService.refreshPayment.

Property

Type

Optional

Description

bookingStatus

"pending" | "confirmed" | "completed" | "cancelled" | "no_show" | null

No

Current reservation lifecycle status. null only when no payable reservation was<br>resolved; normally pending before capture and confirmed after capture.

status

PaymentRefreshStatus

No

Current payment state, or a non-mutating reconciliation outcome.

PaymentRefreshStatus

TypeAlias

Reconciliation outcomes that do not replace the durable PaymentStatus.

TypeScript
type PaymentRefreshStatus = PaymentStatus | "ignored" | "mismatch"

PaymentStatus

TypeAlias

Durable payment lifecycle states exposed to storefront consumers.

TypeScript
type PaymentStatus = "pending" | "processing" | "captured" | "failed" | "expired"

ReservationOffering

Interface

A live reservation formula available for a bookable product. Returned by ReservationsService.offerings as a closed buyer-safe shape in the merchant's display order.

Property

Type

Optional

Description

durationMin

number

No

Effective appointment duration in minutes after the server applies the offering, product, and resource fallback chain.

id

string

No

Opaque offering id (prefixed 'roff_...'). Echo it as AvailabilityFilters.offeringId and BookingCreateData.offeringId.

label

string

No

Merchant-defined formula name shown to the buyer. Always non-empty and at most 255 characters.

maxPartySize

number | null

No

Maximum party size for this offering, or null when the resource capacity is the only ceiling.

minPartySize

number | null

No

Minimum party size for this offering, or null when only the global minimum of 1 applies.

position

number

No

Merchant-defined display position. Ascending, but not guaranteed to be contiguous.

priceCents

number

No

Fixed total price in minor currency units, derived server-side when booked. May be 0 for a free offering.