> For the complete documentation index, see [llms.txt](https://payfric.gitbook.io/payfric-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://payfric.gitbook.io/payfric-api-docs/getting-account-balance.md).

# Getting account balance

This section describes how to retrieve your Payfric balance.

## Send a Get request

<mark style="color:blue;">`GET`</mark> `https://payfric.com/wp-json/payfric/v1/balance`

This endpoint allows you to get your payfric account base currency balance. Base currency balance means the currency you selected during registration on Payfric.

#### Query Parameters

| Name        | Type   | Description                                  |
| ----------- | ------ | -------------------------------------------- |
| secret\_key | string | You get your secrete key from your dashboard |
| email       | string | Your payfric email address                   |

{% tabs %}
{% tab title="200 If account was found" %}
{% code title=" Json response" %}

```javascript
{
   "status": "OK",
   "response": "Response OK",
   "code": 200,
   "data": {
     "error": 0,
     "message": "Account found",
     "data": {
       "balance": 5836.045,
       "currency": "NGN"
     }
   }
 }
```

{% endcode %}
{% endtab %}

{% tab title="404 If account not found" %}

```javascript
{
   "status": "OK",
   "response": "Response OK",
   "code": 200,
   "data": {
     "error": 1,
     "message": "Account not found",
     "data": {
       "balance": 0,
       "currency": "NGN"
     }
   }
 }
```

{% endtab %}
{% endtabs %}
