Skip to main content
GET
Obter detalhes da loja
Requer a permissão STORE:READ.
Este endpoint permite que você recupere todas as informações da sua loja, incluindo saldos disponíveis, pendentes e bloqueados.

Exemplo de uso

Resposta de sucesso

Resposta de erro

Casos de uso

Use este endpoint para verificar quanto dinheiro você tem disponível para saque antes de criar uma nova transação de saque.
Ideal para exibir informações da loja em dashboards administrativos, mostrando saldos e identificação da conta.
Útil para processos de reconciliação, permitindo verificar o estado atual dos saldos da sua conta.
Este endpoint requer autenticação via Bearer token. Certifique-se de incluir sua chave de API no cabeçalho Authorization.

Authorizations

Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Response

Detalhes da loja retornados com sucesso.

data
object

Dados da loja/conta do usuário.

error
string | null
Example:

null

success
boolean

Se a requisição obteve sucesso ou não.

Example:

true