> ## 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 Bill Pay Wallet > Show the authenticated consumer's Bill Pay Wallet. The payload includes billing defaults, saved payment profiles, which payment methods can still be saved, upcoming scheduled/failed payments, and accounts that block deleting each saved profile. ## OpenAPI ````yaml /api/consumer.openapi.yaml get /bill-pay-wallet 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: get: tags: - Bill Pay Wallet summary: Show Bill Pay Wallet description: >- Show the authenticated consumer's Bill Pay Wallet. The payload includes billing defaults, saved payment profiles, which payment methods can still be saved, upcoming scheduled/failed payments, and accounts that block deleting each saved profile. operationId: consumerShowBillPayWallet responses: '200': description: Bill Pay Wallet returned. content: application/json: schema: $ref: '#/components/schemas/ConsumerBillPayWalletResponse' '401': $ref: '#/components/responses/Unauthenticated' '409': $ref: '#/components/responses/ProfileIncomplete' security: - bearerAuth: [] components: schemas: ConsumerBillPayWalletResponse: type: object required: - data properties: data: $ref: '#/components/schemas/ConsumerBillPayWallet' ConsumerBillPayWallet: type: object required: - billing_profile - saveable_payment_methods - saved_payment_profiles - upcoming_payments - blocking_plan_accounts_by_payment_profile properties: billing_profile: $ref: '#/components/schemas/ConsumerBillPayWalletBillingProfile' saveable_payment_methods: $ref: '#/components/schemas/ConsumerBillPayWalletSaveablePaymentMethods' saved_payment_profiles: type: array description: Saved reusable wallet payment profiles, newest first. items: $ref: '#/components/schemas/ConsumerPaymentProfile' upcoming_payments: type: array description: >- Next five owned scheduled/failed future payments across the consumer profile. items: $ref: '#/components/schemas/ConsumerBillPayWalletUpcomingPayment' blocking_plan_accounts_by_payment_profile: type: object additionalProperties: type: array items: $ref: '#/components/schemas/ConsumerBillPayWalletBlockingPlanAccount' description: >- Map keyed by saved payment profile ID. Non-empty arrays mean the profile cannot be deleted until those scheduled/failed payments are moved. 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 ConsumerBillPayWalletBillingProfile: type: object properties: 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' default_method: $ref: '#/components/schemas/ConsumerPaymentMethod' 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. 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' 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 ConsumerPaymentMethod: type: - string - 'null' enum: - cc - ach - null 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' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: Sanctum token ````