Event Escapes Payment Links API

openapi: 3.2.0
info:
  title: Eventescapes Com Payment Links API
  version: 1.0.0
  contact:
    name: Event Escapes support
    email: support@eventescapes.com
    url: https://eventescapes.com/contact
  termsOfService: https://eventescapes.com/terms/ai-agents
  description: 'Operations tagged Payment Links across 2 of this provider''s published API definitions: openapi.json, eventescapes-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://eventescapes.com
security: []
tags:
- name: Payment Links
paths:
  /api/v1/payment-links:
    post:
      operationId: createPaymentLink
      summary: 'Book for a customer: lock live prices and get a secure payment link'
      description: 'Creates a booking cart and returns a payment URL the customer pays. Requires agent_terms_accepted: true (AI Agent Terms) and the customer''s own words asking for the booking. Totals above about AUD 5,000 also need total_confirmation in the customer''s words; above about AUD 20,000 the customer books with our team. A result with status action_required lists what is still needed; call again with the same items plus those fields. Every payment link is recorded with the agent, consent, items and total as booking evidence.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentLinkRequest'
      responses:
        '200':
          description: '{ status: ''payment_link_ready'' | ''action_required'', payment_url?, expires_in_minutes?, authorisation_id?, agent_terms_version?, steps, message }'
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          $ref: '#/components/responses/RequestFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '502':
          $ref: '#/components/responses/Upstream'
      tags:
      - Payment Links
    servers:
    - url: https://eventescapes.com
components:
  schemas:
    BookingItem:
      type: object
      required:
      - type
      properties:
        type:
          type: string
          enum:
          - hotel
          - event
          - experience
        hotel_id:
          type: string
          description: 'HOTEL: from /api/v1/events/{idOrSlug}/hotels.'
        check_in:
          type: string
          format: date
        check_out:
          type: string
          format: date
        adults:
          type: integer
          minimum: 1
          maximum: 6
        children:
          type: integer
          minimum: 0
          maximum: 6
        breakfast:
          type: boolean
        free_cancellation:
          type: boolean
        event_id:
          type: string
          format: uuid
          description: 'EVENT: from /api/v1/events.'
        event_slug:
          type: string
        ticket_id:
          type: string
        quantity:
          type: integer
          minimum: 1
          maximum: 10
        activity_code:
          type: string
          description: 'EXPERIENCE: from /api/v1/experiences.'
        activity_date:
          type: string
          format: date
        child_ages:
          type: string
        modality_code:
          type: string
        session_code:
          type: string
    PaymentLinkRequest:
      type: object
      required:
      - customer_email
      - customer_first_name
      - customer_last_name
      - customer_consent
      - items
      - agent_terms_accepted
      properties:
        customer_email:
          type: string
          format: email
        customer_first_name:
          type: string
          maxLength: 80
        customer_last_name:
          type: string
          maxLength: 80
        customer_phone:
          type: string
          maxLength: 20
          description: E.164, if known.
        residency_country:
          type: string
          maxLength: 60
          description: Customer's country of residence, if stated (hotel prices vary by residency).
        customer_consent:
          type: string
          minLength: 2
          maxLength: 500
          description: The customer's own words asking to book these items.
        agent_terms_accepted:
          type: boolean
          const: true
          description: Acceptance of https://eventescapes.com/terms/ai-agents.
        agent_name:
          type: string
          maxLength: 80
          description: Name of the AI assistant making the booking.
        total_confirmation:
          type: string
          maxLength: 300
          description: 'Only when a previous result asked for it: the customer''s words confirming the total.'
        items:
          type: array
          minItems: 1
          maxItems: 4
          items:
            $ref: '#/components/schemas/BookingItem'
        attendee_names:
          type: string
          maxLength: 600
        attendee_details:
          type: string
          maxLength: 2000
        details_confirm_quote:
          type: string
          maxLength: 500
        accept_new_price:
          type: boolean
        promo_code:
          type: string
          maxLength: 40
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    RateLimited:
      description: Too many requests; see Retry-After.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RequestFailed:
      description: The request could not be completed; message says what to fix.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Upstream:
      description: Temporary upstream problem; retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-refined-from:
- openapi.json
- eventescapes-com-openapi.json