Skip to main content
View Categories

Checkout Shortcode

1 min read

The Checkout shortcode provides a complete checkout experience for property bookings, supporting multiple payment processors, guest management, and booking policies.

Usage #

[homerunner-checkout]

Parameters #

ParameterRequiredDefaultDescription
property_idNoProperty ID (auto-populated from quote)
quote_idNoQuote ID (auto-populated from URL)
rateplan_idNoRate plan ID (auto-populated from URL)
titleNofalseWhether to show the checkout title
backNotrueWhether to show the back button
collect_addressNo*Whether to collect guest address information

* Default collect_address value is determined by the global checkout settings

Features #

Payment Processing #

  • Supports multiple payment processors:
    • Stripe (with 3D Secure support)
    • GuestyPay
    • Direct card processing
  • Handles both instant bookings and inquiry-based reservations
  • Configurable payment terms and collection schedules
  • Secure payment processing with PCI compliance

Guest Management #

  • Guest information collection
  • Optional address collection
  • Guest checkout option for non-registered users
  • Integration with user accounts for registered users

Booking Policies #

  • Configurable cancellation policies
    • Full refund periods
    • Partial refund periods
    • Custom property-specific policies
  • Rental agreement integration
  • House rules display
  • Terms and privacy policy acceptance

Multi-PMS Support #

  • Works with all supported Property Management Systems
  • Consistent booking flow across different platforms
  • System-specific payment processing integration
  • Unified policy management

Examples #

Basic Usage #

[homerunner-checkout]

Custom Display Options #

[homerunner-checkout title="true" back="false"]

With Address Collection #

[homerunner-checkout collect_address="yes"]

Technical Notes #

  • Automatically handles quote validation and availability checking
  • Supports multiple currencies based on property settings
  • Integrates with WordPress user system
  • Provides fallback to default policies when property-specific ones aren’t set
  • Handles both logged-in and guest checkout flows
  • Supports customizable checkout section ordering
  • Includes built-in form validation
  • Provides comprehensive error handling and user feedback
  • Supports internationalization through WordPress localization