Skip to main content
GET
/
user
/
balance
cURL
curl --request GET \
  --url https://chat.muffinscorp.com/api/public/user/balance \
  --header 'x-api-key: <api-key>'
{
  "balance": {
    "regularBalance": 123,
    "dailyBalance": 123,
    "totalBalance": 123,
    "hasDailyCredit": true,
    "credits": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "amount": 123,
        "expiresAt": "2023-11-07T05:31:56Z",
        "extendedExpiresAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "usedAmount": 123,
        "type": "<string>"
      }
    ],
    "dailyCredit": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "grantedAmount": 123,
      "amount": 123,
      "grantedDate": "2023-12-25",
      "used": true
    }
  },
  "success": true,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Response

Saldo retornado com sucesso.

​
balance
object
required
​
success
boolean
required

Indica se a requisição foi bem sucedida.

​
timestamp
string<date-time>
required

Data e hora da resposta.