Skip to main content
GET
Listar bloqueios de saldo

Autorizações

Authorization
string
header
obrigatório

Access token obtido no POST /auth (client_id + client_secret). Válido por 300 segundos.

Cabeçalhos

X-Sub-Account
string

Reference da subconta em que a operação deve ser executada. Quando omitido, a operação acontece na conta principal; o valor reservado principal também resolve para a conta principal e é equivalente a omitir o header. Aceito em todos os endpoints, exceto POST /auth e os próprios endpoints de /sub-accounts, que sempre operam na conta principal.

Erros possíveis: 404 SUB_ACCOUNT_NOT_FOUND, 403 SUB_ACCOUNT_FORBIDDEN, 403 SUB_ACCOUNT_SUSPENDED.

Exige que a credencial tenha o acesso a subcontas habilitado (Configurações → Integração → Credenciais de API). Ele nasce desligado e não é substituído por nenhuma permissão, nem por FULL_ACCESS: sem ele a resposta é 403 SUB_ACCOUNT_FORBIDDEN.

Pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
Exemplo:

"loja-centro"

Parâmetros de consulta

status
enum<string>

Filtra os bloqueios pelo status. Se omitido, retorna todos os bloqueios da conta.

Opções disponíveis:
awaiting_response,
defended,
approved,
rejected

Resposta

Lista de bloqueios de saldo da conta

items
object[]
obrigatório

Lista de bloqueios de saldo da conta

total
integer
obrigatório

Total de bloqueios retornados

Exemplo:

3