> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payluk.ng/llms.txt
> Use this file to discover all available pages before exploring further.

# Get customer wallet

> Returns the wallet balances for a specific merchant customer. Requires the `customer-id` header.



## OpenAPI

````yaml openapi.json GET /v1/wallet
openapi: 3.0.3
info:
  title: Payluk ThirdParty API
  version: 1.0.0
  description: >-
    Merchant / Business API for the Payluk escrow and payments platform.


    All routes are mounted under `/v1` and authenticated with a secret key.
    Every response uses the standard envelope `{ status, message, data }`.
  contact:
    name: Payluk Developer Support
    email: support@payluk.ng
    url: https://payluk.ng
servers:
  - url: https://staging.api.payluk.ng
    description: 'Staging: use sk_test_ keys here for safe testing'
  - url: https://api.payluk.ng
    description: 'Production: use sk_live_ keys'
security:
  - bearerAuth: []
tags:
  - name: Escrow
    description: Create and manage standard escrow payment links.
  - name: Milestone Escrow
    description: Escrows that release funds in parts as milestones are confirmed.
  - name: Vault Escrow
    description: >-
      Merchant-only pooled-stake escrows: customers stake from their wallets and
      the merchant declares the winner.
  - name: Categories
    description: Organise escrows into merchant-defined categories.
  - name: Merchant Customers
    description: Manage the buyers and sellers that transact under your merchant account.
  - name: Disputes
    description: Confirm deliveries, raise disputes and resolve them.
  - name: Payments
    description: Fund wallets and escrows, verify references and manage payout details.
  - name: Debit Cards
    description: List and remove customers' saved debit cards.
  - name: Crypto Whitelist
    description: Manage whitelisted crypto withdrawal addresses.
  - name: Misc
    description: Supporting reference data.
paths:
  /v1/wallet:
    get:
      tags:
        - Merchant Customers
      summary: Get customer wallet
      description: >-
        Returns the wallet balances for a specific merchant customer. Requires
        the `customer-id` header.
      operationId: getCustomerWallet
      parameters:
        - $ref: '#/components/parameters/CustomerIdHeader'
      responses:
        '200':
          description: Wallet fetched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletResponse'
              example:
                status: 200
                message: Wallet fetched successfully
                data:
                  id: 6a19b580fa797d3af379ca30
                  mainBalance: 99000
                  escrowBalance: 1000
                  currency: NG
                  createdAt: '2026-05-29T15:49:20.041Z'
                  updatedAt: '2026-06-25T07:50:41.856Z'
        '400':
          $ref: '#/components/responses/MissingCustomerId'
components:
  parameters:
    CustomerIdHeader:
      name: customer-id
      in: header
      required: true
      description: The merchant customer this request acts on behalf of.
      schema:
        type: string
      example: 665f1b2c9a1e4d0012ab3c01
  schemas:
    WalletResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        message:
          type: string
          example: Wallet fetched successfully
        data:
          type: object
          properties:
            mainBalance:
              type: integer
              example: 50000
            escrowBalance:
              type: integer
              example: 1000000
            currency:
              type: string
              example: NGN
    ApiError:
      type: object
      description: Standard error envelope.
      properties:
        status:
          type: integer
          example: 400
        message:
          type: string
          example: Action not allowed
        data:
          type: object
          example: {}
  responses:
    MissingCustomerId:
      description: The required `customer-id` header is missing.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            status: 400
            message: customer-id header is required
            data: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your secret key as a Bearer token. The key prefix selects the
        environment: `sk_test_...` (test) or `sk_live_...` (live).

````