> ## 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 completed payment summary

> Show the compact Your Payment Summary payload for one owned settled account. The negotiated payoff total is the sum of successful transactions. Successful transaction rows are returned first, followed by cancelled schedule rows represented as payments made outside. Use the existing agreement endpoint to download the PDF.



## OpenAPI

````yaml /api/consumer.openapi.yaml get /accounts/{consumer}/payments/summary
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/summary:
    get:
      tags:
        - Accounts
      summary: Show completed payment summary
      description: >-
        Show the compact Your Payment Summary payload for one owned settled
        account. The negotiated payoff total is the sum of successful
        transactions. Successful transaction rows are returned first, followed
        by cancelled schedule rows represented as payments made outside. Use the
        existing agreement endpoint to download the PDF.
      operationId: consumerShowCompletedPaymentSummary
      parameters:
        - $ref: '#/components/parameters/ConsumerAccountId'
      responses:
        '200':
          description: Completed payment summary returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerCompletedPaymentSummaryResponse'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/AccountActionConflict'
      security:
        - bearerAuth: []
components:
  parameters:
    ConsumerAccountId:
      name: consumer
      in: path
      required: true
      description: Consumer account ID.
      schema:
        type: integer
  schemas:
    ConsumerCompletedPaymentSummaryResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/ConsumerCompletedPaymentSummary'
    ConsumerCompletedPaymentSummary:
      type: object
      required:
        - consumer_id
        - full_name
        - address
        - account
        - company
        - balances
        - agreement
        - transactions
      properties:
        consumer_id:
          type: integer
          example: 88
        full_name:
          type: string
          example: Sem Karan
        address:
          $ref: '#/components/schemas/ConsumerCompletedPaymentAddress'
        account:
          $ref: '#/components/schemas/ConsumerCompletedPaymentAccount'
        company:
          $ref: '#/components/schemas/ConsumerCompletedPaymentCompany'
        balances:
          $ref: '#/components/schemas/ConsumerCompletedPaymentBalances'
        agreement:
          $ref: '#/components/schemas/ConsumerCompletedPaymentAgreement'
        transactions:
          type: array
          description: >-
            Successful transaction rows ordered by ID, followed by cancelled
            schedule rows ordered by schedule date.
          items:
            $ref: '#/components/schemas/ConsumerCompletedPaymentTransaction'
    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
    AccountActionUnavailableResponse:
      type: object
      required:
        - code
        - message
        - current_state
      properties:
        code:
          type: string
          example: account_action_unavailable
        message:
          type: string
          example: This account action is not available for the current account state.
        current_state:
          type:
            - string
            - 'null'
          example: payment_declined
    ConsumerCompletedPaymentAddress:
      type: object
      required:
        - address1
        - address2
        - city
        - state
        - zip
      properties:
        address1:
          type:
            - string
            - 'null'
          example: 4240 Centennial Farm Road
        address2:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
          example: New York
        state:
          type:
            - string
            - 'null'
          example: NY
        zip:
          type:
            - string
            - 'null'
          example: '10022'
    ConsumerCompletedPaymentAccount:
      type: object
      required:
        - name
        - number
        - member_account_number
      properties:
        name:
          type:
            - string
            - 'null'
          example: Medical Account
        number:
          type:
            - string
            - 'null'
          example: '6678222240045226'
        member_account_number:
          type:
            - string
            - 'null'
          example: '511220'
    ConsumerCompletedPaymentCompany:
      type: object
      required:
        - name
      properties:
        name:
          type:
            - string
            - 'null'
          example: Acme Agency
    ConsumerCompletedPaymentBalances:
      type: object
      required:
        - original
        - negotiated_payoff
      properties:
        original:
          type:
            - string
            - 'null'
          example: '4000.00'
        negotiated_payoff:
          type: string
          description: >-
            Sum of successful transaction amounts, matching the 1.0 payment
            summary.
          example: '3400.00'
    ConsumerCompletedPaymentAgreement:
      type: object
      required:
        - available
        - filename
      properties:
        available:
          type: boolean
          description: >-
            Whether the settled account has an active negotiation that supports
            the existing agreement download endpoint.
          example: true
        filename:
          type: string
          example: 6678222240045226_you_negotiate_agreement.pdf
    ConsumerCompletedPaymentTransaction:
      type: object
      required:
        - record_key
        - record_type
        - payment_date
        - transaction_id
        - payment_method
        - amount
        - status
      properties:
        record_key:
          type: string
          examples:
            - transaction:44
            - scheduled:55
        record_type:
          type: string
          enum:
            - successful_payment
            - payment_made_outside
        payment_date:
          type:
            - string
            - 'null'
          format: date
        transaction_id:
          type:
            - string
            - 'null'
          description: >-
            Gateway transaction ID, or `Payment made outside` for a cancelled
            schedule row.
        payment_method:
          anyOf:
            - $ref: '#/components/schemas/ConsumerCompletedPaymentMethod'
            - type: 'null'
        amount:
          type: string
          example: '340.00'
        status:
          $ref: '#/components/schemas/ConsumerPaymentStatus'
    ConsumerCompletedPaymentMethod:
      type: object
      required:
        - method
        - last_four
        - label
      properties:
        method:
          type:
            - string
            - 'null'
          enum:
            - cc
            - ach
            - null
        last_four:
          type:
            - string
            - 'null'
          example: '4242'
        label:
          type:
            - string
            - 'null'
          example: CARD (xx-4242)
    ConsumerPaymentStatus:
      type: object
      properties:
        value:
          type: string
          enum:
            - successful
            - failed
            - processing
            - scheduled
            - rescheduled
            - consumer_change_date
            - creditor_change_date
            - cancelled
        label:
          type: string
          example: Scheduled
  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'
    AccountActionConflict:
      description: >-
        The authenticated profile is incomplete, or the requested account action
        is not available for the account's current state.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/ProfileIncompleteResponse'
              - $ref: '#/components/schemas/AccountActionUnavailableResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````