# Retrieve balance

**Url**

<mark style="color:blue;">**`POST`**</mark>    **`https://api.antgst.com/user/account/balance`**

**Content-Type**

**`application/json`**

**Request Body**

| NameType                                                                   | Description |                                                                                                                              |
| -------------------------------------------------------------------------- | ----------- | ---------------------------------------------------------------------------------------------------------------------------- |
| [authSecret](https://doc.antgst.com/introduction/authentication#api-key-1) | string      | [authSecret = AccessKey ID+ AccessKey Secret Provided by Antgst](https://doc.antgst.com/introduction/authentication#api-key) |

**Curl Example**

```sh
curl --location --request POST 'https://api.antgst.com/user/account/balance' 
--header 'Content-Type: application/json' 
--data '{"authSecret": "YOUR_API_KEY"}'
```

**Response**

{% tabs %}
{% tab title="200 success" %}

```json
{
    "msg": "SUCCESS",
    "code": 200,
    "result": {
        "smsBalance": -18.383,
        "voipBalance": 0.0,
        "currency": "CNY"
    }
}
```

{% endtab %}

{% tab title="400 fail" %}

```json
{
	"msg": "auth secret error!",
	"code": -22
}
```

{% endtab %}
{% endtabs %}

**Response parameter description**

| Filed                                                   | Description                 |
| ------------------------------------------------------- | --------------------------- |
| msg                                                     | response result information |
| [code](https://doc.antgst.com/introduction/errors#code) | response status code        |
| result                                                  | response result parameter   |
| result.smsBalance                                       | balance of SMS service      |
| result.voipBalance                                      | balance of voip service     |
| result.currency                                         | currency                    |
