Skip to content

Consultar Saldo

Retorna os dados de saldo da conta autenticada ou de uma sub-conta.

GET /api/me

Endpoint

GET https://api.divipay.com.br/api/me

Headers

HeaderValorObrigatório
AuthorizationBearerSim

Query Parameters

CampoTipoDescriçãoObrigatório
customerIdstringId da sub-conta. Se não informado, retorna dados da conta principalNão

Exemplo de Requisição

bash
curl -X GET "https://api.divipay.com.br/api/me" \
  -H "Authorization: Bearer SEU_TOKEN"
javascript
const response = await fetch('https://api.divipay.com.br/api/me', {
  headers: {
    'Authorization': 'Bearer SEU_TOKEN'
  }
});

const data = await response.json();
console.log('Saldo:', data.balance);
python
import requests

response = requests.get(
    'https://api.divipay.com.br/api/me',
    headers={
        'Authorization': 'Bearer SEU_TOKEN'
    }
)

data = response.json()
print(f"Saldo: {data['balance']}")
php
<?php
$ch = curl_init('https://api.divipay.com.br/api/me');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer SEU_TOKEN'
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

echo 'Saldo: ' . $data['balance'];
?>

Consultar Sub-conta

bash
curl -X GET "https://api.divipay.com.br/api/me?customerId=5a4c2b18-8f01-49cc-9e3d-2b3b7f1d4e66" \
  -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso

Status: 200 OK

json
{
  "id": "5a4c2b18-8f01-49cc-9e3d-2b3b7f1d4e66",
  "name": "Empresa Exemplo LTDA",
  "balance": 15000.50,
  "balanceBlocked": 500.00,
  "balanceLocked": 0.00
}
CampoTipoDescrição
idstringId da conta
namestringNome da conta
balancenumberSaldo disponível
balanceBlockednumberSaldo bloqueado (pendente)
balanceLockednumberSaldo travado

Respostas de Erro

401 Unauthorized

Token inválido ou expirado.

404 Not Found

Conta não encontrada.

json
{
  "statusCode": 404,
  "message": "Customer not found"
}

Documentação da API DiviPay