Skip to main content
GET
/
api
/
v1
/
balance
Obter saldo
curl --request GET \
  --url https://upay-sistema-api.onrender.com/api/v1/balance \
  --header 'X-API-Key: <api-key>'
{
  "message": "<string>",
  "balance": {
    "current": 123,
    "currency": "BRL",
    "lastUpdated": "2023-11-07T05:31:56Z"
  },
  "recentEntries": [
    {
      "id": "<string>",
      "type": "CREDIT",
      "reason": "<string>",
      "amount": 123,
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Chave de API obtida através do endpoint /api/credentials. Também aceita formato Bearer Token: Authorization: Bearer <api_key>

Response

Saldo obtido com sucesso

message
string
balance
object
recentEntries
object[]