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

# Get Wallet Balances

> Retrieve all business wallet balances for the authenticated tenant.

## Overview

Returns all business wallet balances for your account. Use this endpoint to:

* Display available balances per currency before initiating payouts
* See which source currencies you can pay out from (e.g. NGN, USD)
* Check balance sufficiency before calling `POST /quote` or `POST /initiate`

Only **business wallets** are returned (one per currency your business holds).

## Request

```http theme={null}
GET /v1/payout-api/payouts/wallets HTTP/1.1
Host: gateway.staging.useyala.com
x-api-key: <YOUR_API_KEY>
```

### Headers

| Header      | Required | Description  |
| ----------- | -------- | ------------ |
| `x-api-key` | Yes      | Your API key |

## Response

```json theme={null}
{
  "data": [
    {
      "walletId": "550e8400-e29b-41d4-a716-446655440000",
      "currency": "NGN",
      "balance": 100000.5,
      "availableBalance": 100000.5
    },
    {
      "walletId": "660e8400-e29b-41d4-a716-446655440001",
      "currency": "USD",
      "balance": 5000.0,
      "availableBalance": 5000.0
    }
  ]
}
```

### Response Fields

| Field                     | Type          | Description                                              |
| ------------------------- | ------------- | -------------------------------------------------------- |
| `data`                    | array         | List of wallet balance objects                           |
| `data[].walletId`         | string (UUID) | Wallet identifier                                        |
| `data[].currency`         | string        | Currency code (e.g. NGN, USD)                            |
| `data[].balance`          | number        | Current balance in that currency                         |
| `data[].availableBalance` | number        | Available balance (same as balance for business wallets) |

## Error Responses

### 401 Unauthorized

```json theme={null}
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

**Solution**: Verify your API key is correct.

## Usage Example

```javascript theme={null}
const response = await fetch('https://gateway.staging.useyala.com/v1/payout-api/payouts/wallets', {
  method: 'GET',
  headers: {
    'x-api-key': 'your-api-key'
  }
});

const { data: wallets } = await response.json();
// Show balances per currency before user selects source currency for payout
wallets.forEach(w => {
  console.log(`${w.currency}: ${w.balance} (available: ${w.availableBalance})`);
});
```

## Notes

* Returns only business wallets (one per currency). Collection and suspense wallets are not included.
* Use the returned `currency` and `balance` to validate sufficient funds before initiating a payout; debit always comes from the **sourceCurrency** wallet.
* If you have no wallets, `data` is an empty array `[]`.


## OpenAPI

````yaml GET /v1/payout-api/payouts/wallets
openapi: 3.0.3
info:
  title: Yala Payout APIs
  description: >-
    Yala Payout API documentation. This comprehensive API suite enables seamless
    integration with our financial services platform, providing secure and
    efficient access to cross-border payment solutions.


    <details>

    <summary><b>✨ Key Features</b></summary>


    - Real-time payment processing

    - Secure wallet management

    - Comprehensive exchange rate calculations

    - Robust transaction monitoring

    </details>


    <details>

    <summary><b>💰 Payment Methods and Fees</b></summary>


    ## USD Payments


    | Destination | Method | Fees | Settlement Time |

    |------------|---------|------|-----------------|

    | United States | Wire | $20 | 1 day |

    | | ACH | $5.00 | 1 to 3 days |

    | China, Hong Kong | China wire/HK FPS | $20 | 24 to 72 hours |

    | Other Countries | Swift | $50 (<$2k)<br>$40 ($2k-$10k)<br>$0 (≥$10k) | 24
    to 72 hours |


    ### EUR Payments


    | Destination | Method | Fees | Settlement Time |

    |------------|---------|------|-----------------|

    | EU Countries | SEPA | $5.00 | < 48 hrs |

    | Other Countries | Swift | $50 (<$2k)<br>$40 ($2k-$10k)<br>$0 (≥$10k) | 24
    to 72 hours |


    ### GBP Payments


    | Destination | Method | Fees | Settlement Time |

    |------------|---------|------|-----------------|

    | United Kingdom | Faster Payments/BACS | $2.00 | < 24 hrs |

    | Other Countries | Swift | $50 (<$2k)<br>$40 ($2k-$10k)<br>$0 (≥$10k) | 24
    to 72 hours |


    ### Other Currencies


    | Currency | Destination | Method | Fees | Settlement Time |

    |----------|------------|---------|------|-----------------|

    | NGN | Nigeria | NIP | N100 | < 24 hrs |

    | CNY | All countries | Swift | $50 (<$2k)<br>$40 ($2k-$10k)<br>$0 (≥$10k) |
    24 to 72 hours |

    | HKD | Hong Kong | FPS | $20 | < 24 hrs |

    | Multiple* | Any Country | Swift | $50 (<$2k)<br>$40 ($2k-$10k)<br>$0
    (≥$10k) | 24 to 72 hours |


    *Includes: GHS, XAF, ZAR, XOF, CAD, KES, UGX, INR

    </details>


    For additional support or integration assistance, please contact our
    developer support team.
  version: 1.0.0
  termsOfService: https://useyala.com/
  contact:
    name: API Support
    email: developers@useyala.com
servers:
  - url: https://gateway.useyala.com
    description: Production server
  - url: https://gateway.staging.useyala.com
    description: Staging (Sandbox) server
security:
  - ApiKeyAuth: []
tags:
  - name: Payouts
    description: Operations related to payouts
  - name: Countries
    description: Operations to fetch supported countries and currency information
  - name: Transactions
    description: Operations to fetch transaction history and details
  - name: Webhooks
    description: Register and manage webhook URLs for payout status notifications
paths:
  /v1/payout-api/payouts/wallets:
    get:
      tags:
        - Payouts
      summary: Get wallet balances
      description: Get all wallet balances for the authenticated business.
      operationId: getWalletBalances
      responses:
        '200':
          description: Wallet balances retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WalletBalancesResponse'
        '401':
          description: Unauthorized
components:
  schemas:
    WalletBalancesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/WalletBalanceItem'
          description: List of wallet balances for the tenant
    WalletBalanceItem:
      type: object
      properties:
        walletId:
          type: string
          format: uuid
          description: Wallet UUID
        currency:
          type: string
          example: NGN
          description: Currency code
        balance:
          type: number
          format: float
          description: Current balance
        availableBalance:
          type: number
          format: float
          description: Available balance (same as balance for business wallets)
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````