Skip to main content
GET
/
store
/
get
Obter detalhes da loja
curl --request GET \
  --url https://api.abacatepay.com/v1/store/get \
  --header 'Authorization: Bearer <token>'
{
  "error": "Erro ao recuperar dados da loja.",
  "data": null
}

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

curl -X GET "https://api.abacatepay.com/v2/store/get" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Resposta de sucesso

{
  "data": {
    "id": "store_abc123xyz",
    "name": "Minha Loja",
    "balance": {
      "available": 50000,
      "pending": 10000,
      "blocked": 0
    }
  },
  "success": true,
  "error": null
}

​
Resposta de erro

{
  "success": false,
  "error": "Erro ao recuperar dados da loja.",
  "data": null
}

​
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

Cabeçalho de autenticação Bearer no formato Bearer <abacatepay-api-key> onde <abacatepay-api-key> é a sua chave de API.

Response

Detalhes da loja retornados com sucesso.

​
error
string
required

Mensagem de erro caso ocorra algum problema.

Example:

"Erro ao recuperar dados da loja."

​
data
null
Example:

null