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

# Update scheduled payment profiles

> Update one or more owned scheduled/failed payment rows to use either an existing owned payment profile or a new one-time Basis Theory tokenized payment method.



## OpenAPI

````yaml /api/consumer.openapi.yaml patch /bill-pay-wallet/schedule-transactions/payment-profile
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/schedule-transactions/payment-profile:
    patch:
      tags:
        - Bill Pay Wallet
      summary: Update scheduled payment profiles
      description: >-
        Update one or more owned scheduled/failed payment rows to use either an
        existing owned payment profile or a new one-time Basis Theory tokenized
        payment method.
      operationId: consumerUpdateBillPayWalletScheduledPaymentProfiles
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/UpdateBillPayWalletSchedulePaymentProfileRequest
      responses:
        '200':
          description: Scheduled payment profile updated.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ConsumerBillPayWalletSchedulePaymentProfileMutationResponse
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '409':
          $ref: '#/components/responses/ProfileIncomplete'
        '422':
          $ref: '#/components/responses/ValidationError'
      security:
        - bearerAuth: []
components:
  schemas:
    UpdateBillPayWalletSchedulePaymentProfileRequest:
      type: object
      required:
        - schedule_transaction_ids
      properties:
        schedule_transaction_ids:
          type: array
          minItems: 1
          description: Owned scheduled/failed schedule transaction IDs to update.
          items:
            type: integer
        payment_profile_id:
          type:
            - integer
            - 'null'
          description: >-
            Existing owned payment profile to apply. Required when
            `new_payment_method` is omitted.
        new_payment_method:
          anyOf:
            - $ref: '#/components/schemas/StoreBillPayWalletPaymentProfileRequest'
            - type: 'null'
          description: >-
            New one-time tokenized method to create and apply. Required when
            `payment_profile_id` is omitted.
    ConsumerBillPayWalletSchedulePaymentProfileMutationResponse:
      type: object
      required:
        - message
        - data
      properties:
        message:
          type: string
          example: Scheduled payment profile updated.
        data:
          type: object
          required:
            - updated_count
            - payment_profile
            - upcoming_payments
          properties:
            updated_count:
              type: integer
              example: 2
            payment_profile:
              $ref: '#/components/schemas/ConsumerPaymentProfile'
            upcoming_payments:
              type: array
              items:
                $ref: '#/components/schemas/ConsumerBillPayWalletUpcomingPayment'
    StoreBillPayWalletPaymentProfileRequest:
      type: object
      required:
        - first_name
        - last_name
        - address
        - city
        - state
        - zip
        - method
        - basis_theory_response
      properties:
        first_name:
          type: string
          maxLength: 255
          example: Jane
        last_name:
          type: string
          maxLength: 255
          example: Consumer
        address:
          type: string
          maxLength: 255
          example: 123 Main St
        city:
          type: string
          maxLength: 255
          example: Austin
        state:
          type: string
          example: TX
        zip:
          type: string
          pattern: ^\d{5}(-\d{4})?$
          example: '73301'
        method:
          $ref: '#/components/schemas/ConsumerPaymentMethod'
        account_type:
          type:
            - string
            - 'null'
          enum:
            - checking
            - savings
            - null
          description: Required when `method` is `ach`.
        basis_theory_response:
          $ref: '#/components/schemas/BasisTheoryTokenIntentResponse'
    ConsumerPaymentProfile:
      type: object
      properties:
        id:
          type: integer
        method:
          $ref: '#/components/schemas/ConsumerPaymentMethod'
        method_label:
          type:
            - string
            - 'null'
          example: Card
        label:
          type: string
          example: Card ending in 4242
        last_four_digit:
          type:
            - string
            - 'null'
        account_number_last_four:
          type:
            - string
            - 'null'
        expiration_month:
          type:
            - string
            - 'null'
        expiration_year:
          type:
            - string
            - 'null'
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        address:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        state:
          type:
            - string
            - 'null'
        zip:
          type:
            - string
            - 'null'
        is_saved_for_future_use:
          type: boolean
    ConsumerBillPayWalletUpcomingPayment:
      type: object
      properties:
        id:
          type: integer
        consumer_id:
          type: integer
        company_id:
          type:
            - integer
            - 'null'
        company_name:
          type:
            - string
            - 'null'
        account_name:
          type:
            - string
            - 'null'
        account_number:
          type:
            - string
            - 'null'
        transaction_type:
          type:
            - string
            - 'null'
          enum:
            - pif
            - installment
            - partial_pif
            - null
        transaction_type_label:
          type:
            - string
            - 'null'
          example: Plan
        schedule_date:
          type:
            - string
            - 'null'
          format: date
        amount:
          type: string
          example: '125.00'
        amount_label:
          type: string
          example: $125.00
        status:
          type:
            - string
            - 'null'
          enum:
            - scheduled
            - failed
            - null
        status_label:
          type:
            - string
            - 'null'
          example: Scheduled
        payment_profile:
          anyOf:
            - $ref: '#/components/schemas/ConsumerPaymentProfile'
            - type: 'null'
    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
    ConsumerPaymentMethod:
      type:
        - string
        - 'null'
      enum:
        - cc
        - ach
        - null
    BasisTheoryTokenIntentResponse:
      type: object
      required:
        - id
      description: >-
        Basis Theory token intent payload generated by the frontend tokenization
        flow. The backend verifies this id and converts it to a token when the
        profile must be reusable.
      properties:
        id:
          type: string
          example: token_intent_card
        type:
          type:
            - string
            - 'null'
          example: card
      additionalProperties: true
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      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

````