> ## 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.

# Show Helping Hand payment

> Validate a signed Helping Hand link and return the public payer-facing account, amount, allocation, and payment-method data. The DFA donation terms are static frontend content and are not returned by this endpoint. No consumer authentication token is required. The signed `c`, optional `allocation`, and `signature` query parameters must be preserved exactly from the generated backend payment URL.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /payment
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:
  /payment:
    get:
      tags:
        - Gift Registry
      summary: Show Helping Hand payment
      description: >-
        Validate a signed Helping Hand link and return the public payer-facing
        account, amount, allocation, and payment-method data. The DFA donation
        terms are static frontend content and are not returned by this endpoint.
        No consumer authentication token is required. The signed `c`, optional
        `allocation`, and `signature` query parameters must be preserved exactly
        from the generated backend payment URL.
      operationId: consumerShowExternalPayment
      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: Helping Hand payment page data returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalPaymentPageResponse'
        '403':
          description: Invalid or expired link.
          content:
            application/json:
              schema:
                $ref: d7f83941-731e-4dcf-87d4-d5fe33ae6d95
              example:
                message: Invalid or expired link.
        '409':
          description: >-
            The account is settled, hidden, or otherwise no longer eligible for
            Helping Hand payment.
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ExternalPaymentSettledResponse'
                  - $ref: '#/components/schemas/ExternalPaymentUnavailableResponse'
        '422':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    ConsumerPaymentAllocationStrategy:
      type: string
      enum:
        - due_date
        - plan_level
      example: due_date
    ExternalPaymentPageResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ExternalPaymentPageData'
    ExternalPaymentSettledResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          const: account_settled
        message:
          type: string
          const: This account has been settled.
    ExternalPaymentUnavailableResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          const: payment_unavailable
        message:
          type: string
          example: This Helping Hand payment is no longer available.
    ExternalPaymentPageData:
      type: object
      required:
        - recipient
        - account
        - payment
        - allocation
        - supported_payment_methods
      properties:
        recipient:
          type: object
          required:
            - display_name
          properties:
            display_name:
              type: string
              example: Sem Karan
        account:
          type: object
          required:
            - name
            - creditor_name
          properties:
            name:
              type:
                - string
                - 'null'
              example: Medical Account
            creditor_name:
              type:
                - string
                - 'null'
              example: Acme Agency
        payment:
          $ref: '#/components/schemas/ExternalPaymentAmount'
        allocation:
          anyOf:
            - $ref: '#/components/schemas/ExternalPaymentAllocation'
            - type: 'null'
        supported_payment_methods:
          type: array
          description: >-
            Available payment methods in frontend display order. Card is
            returned before ACH when both are supported.
          items:
            $ref: '#/components/schemas/ExternalPaymentMethod'
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ExternalPaymentAmount:
      type: object
      required:
        - mode
        - amount_editable
        - amount
        - minimum_amount
        - maximum_amount
        - current_balance
        - installment_type
        - installment_type_label
        - monthly_amount
      properties:
        mode:
          type: string
          enum:
            - settlement
            - payment_plan
        amount_editable:
          type: boolean
          description: >-
            Render an amount input only when true. Otherwise display and submit
            the fixed server amount.
        amount:
          type: string
          pattern: ^\d+\.\d{2}$
          example: '100.00'
        minimum_amount:
          type: string
          example: '1.00'
        maximum_amount:
          type: string
          example: '100.00'
        current_balance:
          type: string
          example: '200.00'
        installment_type:
          type:
            - string
            - 'null'
          example: monthly
        installment_type_label:
          type:
            - string
            - 'null'
          example: Monthly
        monthly_amount:
          type:
            - string
            - 'null'
          example: '50.00'
    ExternalPaymentAllocation:
      type: object
      required:
        - value
        - label
      properties:
        value:
          $ref: '#/components/schemas/ConsumerPaymentAllocationStrategy'
        label:
          type: string
          example: Pay earliest installments first
    ExternalPaymentMethod:
      type: object
      required:
        - value
        - label
      properties:
        value:
          type: string
          enum:
            - cc
            - ach
        label:
          type: string
          enum:
            - Card
            - ACH
  responses:
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
    TooManyRequests:
      description: Request was rate limited.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'

````