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

# Generate Helping Hand QR code

> Return a PNG QR code image for a signed Helping Hand payment URL. The QR image encodes the frontend `/payment` URL, while this endpoint itself must be called on the consumer API domain.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /qr-code
openapi: 3.1.0
info:
  title: YouNegotiate Consumer API
  version: '2.0'
  description: >-
    Stateless API endpoints for consumer portal authentication and account
    access.
servers:
  - url: https://api.consumer.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public consumer domain system and health endpoints.
  - name: Authentication
    description: >-
      Consumer identity matching, contact capture, OTP verification, token
      creation, and logout endpoints.
  - name: Profile - My ecoAddress
    description: Consumer profile tab for signed-in identity / ecoAddress context.
  - name: Profile - Communication Controls
    description: >-
      Consumer profile tab for communication permissions, email/mobile changes,
      and email/mobile verification.
  - name: Profile - My Billing Details
    description: >-
      Consumer profile tab for billing name and billing address details used for
      payment verification.
  - name: Profile - Personalize My Portal
    description: Consumer profile tab for portal colors and profile image personalization.
  - name: Accounts
    description: Consumer-owned account list and account detail endpoints.
  - name: Bill Pay Wallet
    description: >-
      Consumer Bill Pay Wallet saved payment profiles and scheduled payment
      method update endpoints.
  - name: Upcoming Payments
    description: >-
      Consumer My Bill Pay Calendar upcoming-payment rows and calendar display
      data.
  - name: Calendar Sync
    description: >-
      Consumer Google and Microsoft calendar connection, OAuth callback, and
      live-update endpoints.
  - name: Gift Registry
    description: >-
      Consumer Bill Pay Gift Registry account list, shared registry, and Helping
      Hand link endpoints.
  - name: EcoMailbox
    description: Consumer MyEcoMailBox list endpoints and unread sidebar badge state.
  - name: Notice Responses
    description: >-
      Consumer My Account notice-response wizard endpoints for sender details
      and account details.
paths:
  /qr-code:
    get:
      tags:
        - System
      summary: Generate Helping Hand QR code
      description: >-
        Return a PNG QR code image for a signed Helping Hand payment URL. The QR
        image encodes the frontend `/payment` URL, while this endpoint itself
        must be called on the consumer API domain.
      operationId: consumerGenerateHelpingHandQrCode
      parameters:
        - name: c
          in: query
          required: true
          description: Hex-encoded consumer account ID embedded in the generated link.
          schema:
            type: string
          example: '313233'
        - name: allocation
          in: query
          required: false
          description: >-
            Payment-plan allocation strategy. Settlement links omit this
            parameter.
          schema:
            $ref: '#/components/schemas/ConsumerPaymentAllocationStrategy'
        - name: signature
          in: query
          required: true
          description: Laravel URL signature generated by the backend.
          schema:
            type: string
          example: signed
      responses:
        '200':
          description: PNG QR code image.
          content:
            image/png:
              schema:
                type: string
                format: binary
        '403':
          description: Invalid or expired link.
          content:
            application/json:
              schema:
                $ref: d7f83941-731e-4dcf-87d4-d5fe33ae6d95
              example:
                message: Invalid or expired link.
        '422':
          $ref: '#/components/responses/ValidationError'
components:
  schemas:
    ConsumerPaymentAllocationStrategy:
      type: string
      enum:
        - due_date
        - plan_level
      example: due_date
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'

````