2026-05-21

Improvements to the guest payment method and vendor documentation

Changed

  • Rename POST /guests/{id}/payment-methods from “Create payment method" to “Create guest payment method”
  • Label the POST /guests/{id}/payment-methods request-body variants as Stripe Payment Method and Guesty Pay Payment Method while preserving their required fields
  • Document payoutMethod in vendor response bodies for GET /vendors and GET /vendors/{id}, including bank account, routing, BSB, sort code, account holder, and business address fields

Added

  • Document the 201 application/json response body for POST /guests/{id}/payment-methods with a guest payment method schema and example
  • Document the 200 application/json response body for GET /guests/{id}/payment-methods with a list of guest payment methods and example
  • Add PaymentMethod and PaymentMethodList schemas for guest payment method response documentation covering /guests/{id}/payment-methods
  • Add POST /vendors for creating vendors with company, firstName, lastName, email, optional contact details, tax code, notes, and payoutMethod request fields
  • Add PATCH /vendors/{id} for updating vendor details and vendor payoutMethod data by vendor ID
  • Add create and update vendor schemas for POST /vendors and PATCH /vendors/{id}, including CreatePayoutMethodDto, UpdatePayoutMethodDto, and vendor response schemas