> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Show a designation-only checkout page

> Builds the public checkout payload for a donation page that accepts designations without sponsorship entities. The controller creates or refreshes a Redis frontend session, loads public donor signup fields for the HysForm, filters designations by client and HysForm, computes saved cart totals/frequency text from Redis, and returns checkout settings used by the frontend. This endpoint does not require bearer authentication; the optional session id carries the cart state.



## OpenAPI

````yaml get /frontend/orderD/{client_id}/{hysform_id}/{designation_id}/{session_id}
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /frontend/orderD/{client_id}/{hysform_id}/{designation_id}/{session_id}:
    get:
      tags:
        - Public
      summary: Show a designation-only checkout page
      description: >-
        Builds the public checkout payload for a donation page that accepts
        designations without sponsorship entities. The controller creates or
        refreshes a Redis frontend session, loads public donor signup fields for
        the HysForm, filters designations by client and HysForm, computes saved
        cart totals/frequency text from Redis, and returns checkout settings
        used by the frontend. This endpoint does not require bearer
        authentication; the optional session id carries the cart state.
      operationId: showDesignationOnlyCheckout
      parameters:
        - name: client_id
          in: path
          description: >-
            Client id that owns the designation checkout page, donor form, and
            available designations.
          required: true
          schema:
            type: integer
          example: 207
        - name: hysform_id
          in: path
          description: >-
            Donor HysForm id used to list public signup fields and standardized
            donor fields.
          required: true
          schema:
            type: integer
          example: 42
        - name: designation_id
          in: path
          description: >-
            Designation selector. `all` returns all client designations that
            include this HysForm; otherwise the controller loads the specified
            designation id.
          required: true
          schema:
            type: string
          example: all
        - name: session_id
          in: path
          description: >-
            Optional Redis frontend session id. If missing or expired, the
            controller creates a new session and initializes checkout cart
            hashes.
          required: true
          schema:
            type: string
          example: 7f2c8f8d64b8a1d4a9e2
      responses:
        '200':
          description: Designation-only checkout payload.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    properties:
                      session_id:
                        type: string
                        example: 7f2c8f8d64b8a1d4a9e2
                      client_id:
                        type: integer
                        example: 207
                      program_id:
                        type: integer
                        example: null
                        nullable: true
                      hysform_id:
                        type: integer
                        example: 42
                      designation_id:
                        type: string
                        example: all
                      entities:
                        description: Always an empty array for designation-only checkout.
                        type: array
                        items:
                          type: object
                      designations:
                        description: >-
                          Map of designation id to designation records allowed
                          for this client and HysForm.
                        type: object
                        nullable: true
                      amount_permissions:
                        description: >-
                          Legacy amount-permission data, currently empty in this
                          controller.
                        type: array
                        items:
                          type: object
                      signup_fields:
                        description: >-
                          Public donor fields from the HysForm, ordered by field
                          order.
                        type: array
                        items:
                          type: object
                      show_standardized_fields:
                        type: boolean
                        example: true
                      visible_standard_field_keys:
                        type: array
                        items:
                          type: string
                        example:
                          - first_name
                          - last_name
                          - email
                      required_standard_field_keys:
                        type: array
                        items:
                          type: string
                        example:
                          - first_name
                          - last_name
                      standard_field_contract:
                        description: >-
                          Current public donor-field contract, including the
                          policy revision used during submission.
                        type: object
                      payment_availability:
                        description: >-
                          Current Stripe payment availability and donor-facing
                          recovery message.
                        type: object
                      text_checkout:
                        type: string
                        example: ''
                      profilePics:
                        type: array
                        items:
                          type: object
                      titles:
                        type: array
                        items:
                          type: object
                      frequencies:
                        type: array
                        items:
                          type: object
                      d_frequencies:
                        description: Saved designation frequency hash from Redis.
                        type: object
                      frequency_options:
                        type: array
                        items:
                          type: object
                      d_frequency_options:
                        description: >-
                          Available designation frequency labels keyed by
                          frequency code.
                        type: object
                      vars:
                        description: >-
                          Legacy checkout variables, including the currency
                          symbol.
                        type: object
                      useStripe:
                        type: boolean
                        example: true
                      hasStripe:
                        type: boolean
                        example: false
                      designation:
                        description: >-
                          Selected designation record when a concrete
                          designation id is supplied.
                        type: object
                        nullable: true
                      saved_designations:
                        description: >-
                          Redis map of designation id to amount currently in the
                          cart.
                        type: object
                      total:
                        type: number
                        format: float
                        example: 75
                      login_box:
                        type: string
                        example: '1'
                      checks:
                        type: string
                        example: ''
                      num_of_sponsorships:
                        type: integer
                        example: 2
                      designations_allowed:
                        type: string
                        example: '1'
                      frequency_text:
                        type: string
                        example: 2 paid monthly
                      useCC:
                        type: boolean
                        example: true
                      months:
                        description: Month options keyed by two-digit month number.
                        type: object
                      years:
                        description: Ten-year list of card expiration years.
                        type: object
                      donation_amounts_array:
                        description: >-
                          Suggested donation amounts from the selected
                          designation.
                        type: object
                    type: object
                type: object
        '404':
          description: The donor form or selected client-owned record was not found.
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.