Solde

Consulte le solde du compte bancaire associe a l'API Key.

Endpoint

GET /api/external/balance

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}

Exemple

curl -X GET https://api.owem.com.br/api/external/balance \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Reponse de Succes (200)

{
  "worked": true,
  "balance": 3000000,
  "available": 2700000,
  "pending": 300000,
  "currency": "BRL"
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
balance	Integer	Solde total en unites de base (/ 10 000 pour reais). 3000000 = R$ 300,00
available	Integer	Solde disponible pour les operations en unites de base. 2700000 = R$ 270,00
pending	Integer	Montant retenu par les transactions en attente en unites de base. 300000 = R$ 30,00
currency	String	Code de la devise (toujours BRL)

Valeurs de reponse en unites de base

Toutes les valeurs de reponse sont des entiers en unites de base. Pour convertir en reais, divisez par 10 000. Exemple : 3000000 / 10 000 = R$ 300,00. N'utilisez jamais de virgule flottante.

Relation entre les champs

• balance = available + pending
• available : montant pouvant etre utilise pour de nouveaux virements PIX
• pending : somme des montants des transactions non encore liquidees

Reponse d'Erreur (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}