Obter detalhes da loja

Permite que você recupere os detalhes da sua conta/loja, incluindo informações de saldo.

GET /store/get

Obter detalhes da loja

cURL

curl --request GET \
  --url https://api.abacatepay.com/v1/store/get \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.abacatepay.com/v1/store/get"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.abacatepay.com/v1/store/get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.abacatepay.com/v1/store/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.abacatepay.com/v1/store/get"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.abacatepay.com/v1/store/get")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.abacatepay.com/v1/store/get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

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

{
  "error": "Token de autenticação inválido ou ausente."
}

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

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

const response = await fetch('https://api.abacatepay.com/v2/store/get', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.abacatepay.com/v2/store/get', headers=headers)
data = response.json()
print(data)

<?php
$headers = [
    'Authorization: Bearer YOUR_API_KEY',
    'Content-Type: application/json'
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.abacatepay.com/v2/store/get');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

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

print_r($data);
?>

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

Verificar saldo disponível

Use este endpoint para verificar quanto dinheiro você tem disponível para saque antes de criar uma nova transação de saque.

Dashboard da loja

Ideal para exibir informações da loja em dashboards administrativos, mostrando saldos e identificação da conta.

Reconciliação de contas

Ú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

200

application/json

Detalhes da loja retornados com sucesso.

Option 1

Option 2

error · string · required

Mensagem de erro caso ocorra algum problema.

Example:

"Erro ao recuperar dados da loja."

data · null

Example:

null