# VA balance and statement

### Summary

These APIs give Klasha’s merchants the ability to retrieve the balance of their Virtual Account as well as the statement of their transactions.

{% hint style="info" %}
 **Before you begin!**

* [Link](https://api.postman.com/collections/25963887-e69fa4f5-9279-418c-b6a4-80eeb9fbe97a?access_key=PMAT-01HG0E31P1RFBBTX05ZBW59CT6) to the Postman collection
* Find your keys on the Klasha Dashboard → Settings → Generate API Keys ([here](https://dashboard.klasha.com/settings/keys)). 
* Klasha Dashboard, Generate API Keys page

<img src="/files/LFFicElNA6dWGpxBEdo1" alt="" data-size="original">
{% endhint %}

### API specifications

**Generate a bearer token**

## Generate a bearer token

<mark style="color:green;">`POST`</mark> `{{env_url}}/auth/auth/login`

Using the Token endpoint on the Postman collection, the token can be obtained from the headers under the header name: token.

#### Headers

| Name                                        | Type   | Description |
| ------------------------------------------- | ------ | ----------- |
| {{token}}<mark style="color:red;">\*</mark> | String | token       |

#### Request Body

| Name                                       | Type   | Description |
| ------------------------------------------ | ------ | ----------- |
| username<mark style="color:red;">\*</mark> | String | username    |
| password<mark style="color:red;">\*</mark> | String | password    |

{% tabs %}
{% tab title="200: OK " %}

{% endtab %}
{% endtabs %}

**Get Virtual Account Balance**

## Get Virtual Account Balance

<mark style="color:blue;">`GET`</mark> `{{env_url}}/nucleus/virtual/account/collections/business/`

You’d need to pass the merchant public key in the header as the x-auth-token. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.

#### Headers

| Name                                           | Type   | Description         |
| ---------------------------------------------- | ------ | ------------------- |
| x-auth-token<mark style="color:red;">\*</mark> | String | merchant public key |

{% tabs %}
{% tab title="200: OK " %}

```json
{
    "message": "success",
    "error": null,
    "data": {
        "virtualAccountCollectionSettlement": 100.00,
        "virtualAccountCollectionsBalance": 200.00
    }
}
```

{% endtab %}

{% tab title="400: Bad Request " %}

```json
{
    "message": "A human readable error message",
    "error": "Bad Request",
    "data": null
}
```

{% endtab %}
{% endtabs %}

**Retrieve Transaction Statements**

## Retrieve Transaction Statements

<mark style="color:green;">`POST`</mark> `{{env_url}}/nucleus/tnx/paginated/filter/v2`

You will need to pass the merchant public key in the header as the x-auth-token. This can be obtained from your merchant dashboard → Settings → Generate API keys → Merchant public key.

You can get all your transactions by passing an empty body, or you can pass a body with any combination of the following 3 filters (all of them or just 1 or 2)

#### Headers

| Name                                           | Type   | Description         |
| ---------------------------------------------- | ------ | ------------------- |
| x-auth-token<mark style="color:red;">\*</mark> | String | merchant public key |

#### Request Body

| Name     | Type   | Description                                  |
| -------- | ------ | -------------------------------------------- |
| currency | String | NGN                                          |
| status   | String | failed                                       |
| tnxRef   | String | paylink-8e3172ac-4cb4-422f-a805-9a571f236939 |

{% tabs %}
{% tab title="200: OK " %}

```json
{
  "message": "success",
  "error": null,
  "data": {
    "pageNo": 1,
    "totalPages": 1,
    "totalCount": 1,
    "transactions": [
      {
        "transaction": {
          "status": "successful",
          "virtualAccountNumber": "000000001",
          "email": "email@email.com",
          "currency": "NGN",
          "tnxRef": "reference",
          "sourceCurrency": "NGN",
          "paymentType": "paymentType",
          "channel": "channel",
	  "previousBalance": 1003.02,
          "amountCredited": 100.00,
          "amountCollected": 200.00,
          "newBalance": 1103.02,
          "settledCurrency": "NGN",
          "createdAt": "2023-01-01 01:01:00",
          "payerDetails": {
            "bank": "bank name",
            "accountName": "account name",
            "accountNumber": "0000000022"
          }
        }
      },
    ]
  }
}     
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.klasha.com/~/revisions/wTs3QfcE0Q2ImN5VimGe/bank-account-collection/va-balance-and-statement.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.