Solde

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

Endpoint

GET /api/v2/external/balance

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	Bearer {access_token}

Exemple

curl -X GET https://api.owem.com.br/api/v2/external/balance \
  -H "Authorization: Bearer $TOKEN"

Reponse de Succes (200)

{
  "worked": true,
  "balance": 1500000,
  "available": 1450000,
  "pending": 50000,
  "currency": "BRL"
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
balance	Integer	Solde total du compte en centimes
available	Integer	Solde disponible pour les operations en centimes
pending	Integer	Montant retenu dans les transactions en attente en centimes
currency	String	Code de la devise (toujours BRL)

Valeurs en centimes

Toutes les valeurs sont des entiers en centimes. 1500000 = R$ 15.000,00. Divisez par 100 pour obtenir la valeur en reais.

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)

{
  "worked": false,
  "detail": "Token invalide ou expire"
}