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

# Get merchant wallets

> Returns a list of wallets with balances for the specified merchant,
optionally filtered by currency.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/wallets
openapi: 3.0.0
info:
  title: FastPay API
  version: 1.0.0
  description: >-
    API for creating and managing payment charges.


    ## Authentication


    This API uses **Basic Authentication** for direct API access, such as
    creating charges.

    Use your API key as the username and an empty string as password.

    The header should be formatted as:


    `Authorization: Basic {base64(apiKey:)}`.


    For example:


    ```

    Authorization: Basic YWxleG91dG9uOiIi

    ```


    ## Webhooks


    FastPay sends webhooks to notify your application about charge status
    changes in real-time.

    Webhooks are sent via HTTP POST requests to your configured webhook
    endpoints.


    ### Webhook Events


    The following webhook events are available for charges:


    - `charge.created` - Sent when a new charge is created

    - `charge.pending` - Sent when a charge is pending payment

    - `charge.paid` - Sent when a charge is successfully paid

    - `charge.updated` - Sent when a charge is updated


    ### Webhook Payload Structure


    All webhook payloads follow this structure:


    ```json

    {
      "id": "webhook_event_id",
      "event": "charge.paid",
      "data": {
        // Complete charge object
      }
    }

    ```


    ### Webhook Delivery


    - Webhooks are sent via HTTP POST requests

    - Content-Type: `application/json`

    - Retry logic is implemented for failed deliveries

    - Webhook events are stored in the database for audit purposes

    - Delivery logs are maintained for debugging and monitoring


    ### Webhook Security


    - Webhooks are sent to pre-configured endpoints

    - Endpoints can be enabled/disabled per merchant

    - Event filtering is supported (only receive specific events)

    - Failed deliveries are retried with exponential backoff
servers:
  - url: https://api-global.fastpaybrasil.com
    description: Produção e Sandbox (diferenciados pela API key)
security: []
paths:
  /v1/wallets:
    get:
      tags:
        - Wallets
      summary: Get merchant wallets
      description: |-
        Returns a list of wallets with balances for the specified merchant,
        optionally filtered by currency.
      parameters:
        - name: merchantId
          in: query
          description: Merchant ID to get wallets for
          required: true
          schema:
            type: string
            example: 2vorkDcXyvzifL63YX09S9VqcnI
        - name: currency
          in: query
          description: Filter wallets by currency code
          required: false
          schema:
            type: string
            example: BRL
      responses:
        '200':
          description: Successfully retrieved the list of wallets
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Wallet'
        '401':
          description: Unauthorized - invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 401
                  message:
                    type: string
                    example: Unauthorized
        '403':
          description: Forbidden - insufficient permissions
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 403
                  message:
                    type: string
                    example: Forbidden
        '404':
          description: Merchant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: integer
                    example: 404
                  message:
                    type: string
                    example: Unauthorized
                  error:
                    type: string
                    example: Merchant not found
      security:
        - bearer: []
components:
  schemas:
    Wallet:
      type: object
      properties:
        currency:
          type: string
          description: The currency code of the wallet
          example: BRL
        isWithdrawalEnabled:
          type: boolean
          description: Whether withdrawals are enabled for this currency
          example: true
        balance:
          type: object
          description: Balance amounts in the original currency
          properties:
            available:
              type: number
              description: Available balance amount
              example: 1000.5
            pending:
              type: number
              description: Pending balance amount
              example: 250
            reserved:
              type: number
              description: Reserved balance amount
              example: 100
        usdBalance:
          type: object
          description: Balance amounts converted to USD
          properties:
            available:
              type: number
              description: Available balance amount in USD
              example: 200.1
            pending:
              type: number
              description: Pending balance amount in USD
              example: 50
            reserved:
              type: number
              description: Reserved balance amount in USD
              example: 20
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: |-
        JWT Bearer token authentication. Use the JWT token obtained
        from the login endpoint in the Authorization header as 'Bearer {token}'.

````