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

# Payaza Account

> Retrieve your main Payaza account details — including balance, account reference, and virtual account numbers — for use across your integration.

## Overview

The Payaza Account API gives you access to the core details of your merchant account: your `payazaAccountReference` (required for initiating transfers), current balance per currency, and any virtual account numbers assigned to your account.

This is typically called once at startup, or refreshed before any significant money movement to confirm your available balance.

***

## Key Requirements

<Info>
  Use your **public API key** encoded in Base64. See the [Authentication guide](/guides/authentication) for setup instructions.
</Info>

Set these headers on the request:

```json theme={null}
{
  "Authorization": "Payaza <base64-encoded-public-key>",
  "X-TenantID": "test"
}
```

***

## Endpoint

| Method | Endpoint                                                    | Description                                  |
| ------ | ----------------------------------------------------------- | -------------------------------------------- |
| `GET`  | `/payaza-account/api/v1/mainaccounts/merchant/enquiry/main` | Retrieve all main accounts for your merchant |

***

## Key response fields

| Field                    | Description                                                                                                   |
| ------------------------ | ------------------------------------------------------------------------------------------------------------- |
| `payazaAccountReference` | The account reference used in Transfer requests. Use the one that matches the currency you want to send from. |
| `accountBalance`         | Current available balance for this currency account                                                           |
| `currency`               | The currency of this account (e.g. `"NGN"`, `"GHS"`)                                                          |
| `status`                 | Account status — should be `"ACTIVE"` before initiating transfers                                             |
| `virtualAccounts`        | Any virtual account numbers assigned to this account                                                          |
| `postNoDebit`            | If `true`, outbound transactions (payouts) are blocked — check this before initiating a transfer              |

<Note>
  The response returns one object per currency. Each currency your account supports (NGN, GHS, etc.) will appear as a separate item in the `data` array. Use the `payazaAccountReference` from the item whose `currency` matches your intended payout.
</Note>

***

## How to use it

<Steps>
  <Step title="Fetch account details">
    Call the Main Accounts endpoint to retrieve your full account summary across all currencies.
  </Step>

  <Step title="Select the correct account reference">
    Find the account in the response whose `currency` matches the currency you want to send from. Copy its `payazaAccountReference`.
  </Step>

  <Step title="Use the reference in transfer requests">
    Pass the `payazaAccountReference` as `account_reference` in your [Initiate A Transfer](/guides/transfers#step-3) request body.
  </Step>
</Steps>

***

## Best practices

* Cache the `payazaAccountReference` per currency — it does not change and you do not need to re-fetch it on every transfer
* Always check `postNoDebit` and `accountBalance` before initiating a large transfer to surface issues early
* If `postNoDebit` is `true`, contact [support@payaza.africa](mailto:support@payaza.africa) to have the restriction reviewed

***

## What's next

<CardGroup cols={2}>
  <Card title="Transfers" icon="money-bill-transfer" href="/guides/transfers">
    Use your account reference to initiate payouts to bank accounts and mobile wallets.
  </Card>

  <Card title="Sub Accounts" icon="users" href="/guides/sub-accounts">
    Create segmented accounts for separate business units or verticals.
  </Card>
</CardGroup>