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

# Delete wallet payment profile

> Delete an unused saved Bill Pay Wallet profile. The API returns 409 with blocking account details when scheduled or failed payments still reference the profile.



## OpenAPI

````yaml /api/consumer.openapi.yaml delete /bill-pay-wallet/payment-profiles/{paymentProfile}
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:
  /bill-pay-wallet/payment-profiles/{paymentProfile}:
    delete:
      tags:
        - Bill Pay Wallet
      summary: Delete wallet payment profile
      description: >-
        Delete an unused saved Bill Pay Wallet profile. The API returns 409 with
        blocking account details when scheduled or failed payments still
        reference the profile.
      operationId: consumerDeleteBillPayWalletPaymentProfile
      parameters:
        - $ref: '#/components/parameters/ConsumerPaymentProfileId'
      responses:
        '200':
          description: Wallet payment profile deleted.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConsumerBillPayWalletDeletePaymentProfileResponse
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/BillPayWalletConflict'
      security:
        - bearerAuth: []
components:
  parameters:
    ConsumerPaymentProfileId:
      name: paymentProfile
      in: path
      required: true
      description: Payment profile ID returned by the Bill Pay Wallet.
      schema:
        type: integer
  schemas:
    ConsumerBillPayWalletDeletePaymentProfileResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Payment profile deleted.
        data:
          type: object
          required:
            - saveable_payment_methods
          properties:
            saveable_payment_methods:
              $ref: '#/components/schemas/ConsumerBillPayWalletSaveablePaymentMethods'
    ConsumerBillPayWalletSaveablePaymentMethods:
      type: object
      required:
        - cc
        - ach
      properties:
        cc:
          type: boolean
          description: True when the profile does not already have a saved card.
        ach:
          type: boolean
          description: True when the profile does not already have a saved ACH method.
    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
    BillPayWalletPaymentProfileInUseResponse:
      type: object
      required:
        - message
        - code
        - blocking_plan_accounts
      properties:
        message:
          type: string
          example: This payment profile is used by active scheduled payments.
        code:
          type: string
          example: payment_profile_in_use
        blocking_plan_accounts:
          type: array
          items:
            $ref: '#/components/schemas/ConsumerBillPayWalletBlockingPlanAccount'
    ConsumerBillPayWalletBlockingPlanAccount:
      type: object
      properties:
        consumer_id:
          type: integer
        company_id:
          type:
            - integer
            - 'null'
        company_name:
          type:
            - string
            - 'null'
        account_name:
          type:
            - string
            - 'null'
        account_number:
          type:
            - string
            - 'null'
        next_schedule_date:
          type:
            - string
            - 'null'
          format: date
        payment_count:
          type: integer
        scheduled_count:
          type: integer
        failed_count:
          type: integer
  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'
    BillPayWalletConflict:
      description: >-
        The authenticated profile is incomplete, or the saved wallet payment
        profile is still used by active scheduled payments.
      content:
        application/json:
          schema:
            oneOf:
              - $ref: '#/components/schemas/ProfileIncompleteResponse'
              - $ref: '#/components/schemas/BillPayWalletPaymentProfileInUseResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum token

````