Consultar conta

Retorna os dados de uma conta específica vinculada à entidade autenticada. Mesmo shape do array accounts[] devolvido por /authenticate, mas envelopado em { account }.

GET/accounts/:accountId

balance, monthlyGoal, monthlySpending e savingsProgress são em reais (decimal), diferente da API Pix que usa centavos como string. Cuidado ao consumir.

Path params

accountIdObrigatório
string (UUID)
ID da conta. Use o id retornado em accounts[] do /authenticate.

Headers

AcceptObrigatório
string
application/json
AuthorizationObrigatório
string
Bearer <token> — JWT retornado em /authenticate.
X-Tenant-IdObrigatório
string (UUID)
Identificador do tenant (deve coincidir com o tenant do token).

Exemplo de requisição

bash

curl https://baas.staterpay.io/accounts/00000000-0000-0000-0000-000000000020 \  -H "Accept: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000"

Resposta

account.id
string (UUID)
ID da conta.
account.bank
string
Código do banco (3 dígitos).
account.agency
string
Agência (4 dígitos).
account.number
string
Número da conta.
account.balance
number
Saldo atual em reais (não centavos).
account.status
"APPROVED" | "PENDING" | "REJECTED"
Estado de provisionamento da conta.
account.monthlyGoal
number
Meta de gastos mensal definida pelo usuário (0 quando não definida).
account.monthlySpending
number
Total gasto no mês corrente em reais.
account.savingsProgress
number
Progresso na meta de economia.

json

{  "account": {    "id": "00000000-0000-0000-0000-000000000020",    "bank": "000",    "agency": "0001",    "number": "1000002",    "balance": 224.93,    "status": "APPROVED",    "monthlyGoal": 0,    "monthlySpending": 22.20,    "savingsProgress": 0  }}

URL base:https://baas.staterpay.io

Consultar conta

Consultar conta

Path params

Headers

Exemplo de requisição

Resposta

On this page