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

> Generate signed frontend gift-payment and QR-code links for one owned Gift Registry account. Accepted settlements return settlement links. Accepted installment plans return due-date and plan-level allocation links. Joined or not-paying accounts without an accepted negotiation create today's discounted settlement offer first, then return settlement links. Every successful response includes the default QR-code payload.



## OpenAPI

````yaml /api/consumer.openapi.yaml post /accounts/{consumer}/payments/helping-hand-link
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:
  /accounts/{consumer}/payments/helping-hand-link:
    post:
      tags:
        - Gift Registry
      summary: Generate Helping Hand link
      description: >-
        Generate signed frontend gift-payment and QR-code links for one owned
        Gift Registry account. Accepted settlements return settlement links.
        Accepted installment plans return due-date and plan-level allocation
        links. Joined or not-paying accounts without an accepted negotiation
        create today's discounted settlement offer first, then return settlement
        links. Every successful response includes the default QR-code payload.
      operationId: consumerGenerateHelpingHandLink
      parameters:
        - $ref: '#/components/parameters/ConsumerAccountId'
      responses:
        '200':
          description: Helping Hand link generated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerHelpingHandLinkResponse'
              example:
                message: Helping Hand link generated.
                data:
                  mode: accepted_payment_plan
                  type: payment_plan
                  title: Your Payment Plan Gift Link
                  description: >-
                    You're not alone anymore! Share this link so anyone can gift
                    a payment on your payment plan. Every gift helps you move
                    forward and gives back with a tax deduction.
                  account:
                    id: 123
                    company_id: 45
                    company_name: ABC Collections
                    account_name: Visa Account
                    account_number: ACC-100
                  negotiation:
                    id: 789
                    negotiation_type: installment
                    negotiation_type_label: Payment Plan
                    offer_accepted: true
                    counter_offer_accepted: false
                    first_pay_date: '2026-06-25'
                  payment:
                    amount: '640.00'
                    label: Pay off $640.00
                    monthly_amount: '80.00'
                    installment_type: monthly
                    installment_type_label: Monthly
                    no_of_installments: 8
                  default_allocation: due_date
                  payment_url: >-
                    https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
                  qr_code:
                    payload_url: >-
                      https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
                    image_url: >-
                      https://api.consumer.younegotiate.com/qr-code?c=313233&allocation=due_date&signature=signed
                  allocation_options:
                    - value: due_date
                      label: Pay earliest installments first
                      sort_direction: asc
                      payment_url: >-
                        https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
                      qr_code:
                        payload_url: >-
                          https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
                        image_url: >-
                          https://api.consumer.younegotiate.com/qr-code?c=313233&allocation=due_date&signature=signed
                    - value: plan_level
                      label: Pay latest installments first
                      sort_direction: desc
                      payment_url: >-
                        https://consumer.younegotiate.com/payment?c=313233&allocation=plan_level&signature=signed
                      qr_code:
                        payload_url: >-
                          https://consumer.younegotiate.com/payment?c=313233&allocation=plan_level&signature=signed
                        image_url: >-
                          https://api.consumer.younegotiate.com/qr-code?c=313233&allocation=plan_level&signature=signed
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  parameters:
    ConsumerAccountId:
      name: consumer
      in: path
      required: true
      description: Consumer account ID.
      schema:
        type: integer
  schemas:
    ConsumerHelpingHandLinkResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Helping Hand link generated.
        data:
          $ref: '#/components/schemas/ConsumerHelpingHandLinkPayload'
    ConsumerHelpingHandLinkPayload:
      type: object
      required:
        - mode
        - type
        - title
        - description
        - account
        - negotiation
        - payment
        - default_allocation
        - payment_url
        - qr_code
        - allocation_options
      properties:
        mode:
          type: string
          description: Flow used to generate the link.
          enum:
            - discounted_settlement_without_negotiation
            - accepted_settlement
            - accepted_payment_plan
          example: accepted_payment_plan
        type:
          type: string
          enum:
            - settlement
            - payment_plan
          example: payment_plan
        title:
          type: string
          example: Your Payment Plan Gift Link
        description:
          type: string
          example: >-
            You're not alone anymore! Share this link so anyone can gift a
            payment on your payment plan. Every gift helps you move forward and
            gives back with a tax deduction.
        account:
          $ref: '#/components/schemas/ConsumerHelpingHandAccount'
        negotiation:
          $ref: '#/components/schemas/ConsumerHelpingHandNegotiation'
        payment:
          $ref: '#/components/schemas/ConsumerHelpingHandPayment'
        default_allocation:
          anyOf:
            - $ref: '#/components/schemas/ConsumerPaymentAllocationStrategy'
            - type: 'null'
          description: >-
            Default installment allocation strategy. Settlement links return
            null.
          example: due_date
        payment_url:
          type: string
          format: uri
          description: Signed frontend URL to copy or share.
          example: >-
            https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
        qr_code:
          $ref: '#/components/schemas/ConsumerHelpingHandQrCode'
          description: >-
            QR payload for frontend QR rendering. Present for every successful
            Helping Hand link response.
        allocation_options:
          type: array
          description: >-
            Payment-plan allocation choices. Settlement links return an empty
            array.
          items:
            $ref: '#/components/schemas/ConsumerHelpingHandAllocationOption'
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    ProfileIncompleteResponse:
      type: object
      required:
        - code
        - message
        - required_steps
      properties:
        code:
          type: string
          example: profile_incomplete
        message:
          type: string
          example: Please complete your communication profile before viewing accounts.
        required_steps:
          type: array
          items:
            type: string
          example:
            - profile_communication
    ValidationErrorResponse:
      type: object
      required:
        - message
        - errors
      properties:
        message:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    ConsumerHelpingHandAccount:
      type: object
      required:
        - id
        - company_id
        - company_name
        - account_name
        - account_number
      properties:
        id:
          type: integer
          example: 123
        company_id:
          type: integer
          example: 45
        company_name:
          type:
            - string
            - 'null'
          example: ABC Collections
        account_name:
          type:
            - string
            - 'null'
          example: Visa Account
        account_number:
          type:
            - string
            - 'null'
          example: ACC-100
    ConsumerHelpingHandNegotiation:
      type: object
      required:
        - id
        - negotiation_type
        - negotiation_type_label
        - offer_accepted
        - counter_offer_accepted
        - first_pay_date
      properties:
        id:
          type: integer
          example: 789
        negotiation_type:
          $ref: '#/components/schemas/ConsumerNegotiationType'
        negotiation_type_label:
          type:
            - string
            - 'null'
          example: Payment Plan
        offer_accepted:
          type: boolean
          example: true
        counter_offer_accepted:
          type: boolean
          example: false
        first_pay_date:
          type:
            - string
            - 'null'
          format: date
          example: '2026-06-25'
    ConsumerHelpingHandPayment:
      type: object
      required:
        - amount
        - label
        - monthly_amount
        - installment_type
        - installment_type_label
        - no_of_installments
      properties:
        amount:
          type: string
          description: >-
            Settlement amount or payment-plan payoff balance as a decimal
            string.
          example: '640.00'
        label:
          type: string
          example: Pay off $640.00
        monthly_amount:
          type:
            - string
            - 'null'
          example: '80.00'
        installment_type:
          anyOf:
            - $ref: '#/components/schemas/ConsumerInstallmentType'
            - type: 'null'
        installment_type_label:
          type:
            - string
            - 'null'
          example: Monthly
        no_of_installments:
          type:
            - integer
            - 'null'
          example: 8
    ConsumerPaymentAllocationStrategy:
      type: string
      enum:
        - due_date
        - plan_level
      example: due_date
    ConsumerHelpingHandQrCode:
      type: object
      required:
        - payload_url
        - image_url
      properties:
        payload_url:
          type: string
          format: uri
          description: >-
            Frontend payment URL encoded into the QR image. Use for copy/share
            or client-side QR fallback.
          example: >-
            https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
        image_url:
          type: string
          format: uri
          description: >-
            Backend API image URL that returns `image/png`. Use this URL
            directly in an `<img>` for the QR code modal.
          example: >-
            https://api.consumer.younegotiate.com/qr-code?c=313233&allocation=due_date&signature=signed
    ConsumerHelpingHandAllocationOption:
      type: object
      required:
        - value
        - label
        - sort_direction
        - payment_url
        - qr_code
      properties:
        value:
          $ref: '#/components/schemas/ConsumerPaymentAllocationStrategy'
        label:
          type: string
          example: Pay earliest installments first
        sort_direction:
          type: string
          enum:
            - asc
            - desc
          example: asc
        payment_url:
          type: string
          format: uri
          example: >-
            https://consumer.younegotiate.com/payment?c=313233&allocation=due_date&signature=signed
        qr_code:
          $ref: '#/components/schemas/ConsumerHelpingHandQrCode'
    ConsumerNegotiationType:
      type:
        - string
        - 'null'
      enum:
        - pif
        - installment
        - null
    ConsumerInstallmentType:
      type:
        - string
        - 'null'
      enum:
        - weekly
        - bimonthly
        - monthly
        - null
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    Forbidden:
      description: Authenticated consumer cannot access the resource.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
    ProfileIncomplete:
      description: >-
        The authenticated consumer profile must complete communication setup
        before My Account can be shown.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ProfileIncompleteResponse'
    ValidationError:
      description: Request validation failed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````