AbacatePay Stores API
The Stores API from AbacatePay — 2 operation(s) for stores.
The Stores API from AbacatePay — 2 operation(s) for stores.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/abacatepay:abacatepay-stores-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: AbacatePay Stores API
description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
version: 1.0.0
servers:
- url: https://api.abacatepay.com/v2
description: Único servidor para os ambientes de produção e sandbox.
tags:
- name: Stores
paths:
/stores/get:
get:
summary: Obter detalhes da loja
description: Permite que você recupere os detalhes da sua conta/loja, incluindo informações de saldo.
security:
- bearerAuth: []
responses:
'200':
description: Detalhes da loja retornados com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Store'
error:
type: string
nullable: true
example: null
success:
$ref: '#/components/schemas/Success'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
tags:
- Stores
operationId: getStoresGet
x-operation-id-source: derived
/stores/list:
get:
summary: Listar lojas
description: Retorna as lojas visíveis para a sua chave de API.
security:
- bearerAuth: []
parameters:
- $ref: '#/components/parameters/QueryAfter'
- $ref: '#/components/parameters/QueryBefore'
- $ref: '#/components/parameters/QueryLimit'
- $ref: '#/components/parameters/QueryStartDate'
- $ref: '#/components/parameters/QueryEndDate'
- name: id
in: query
description: Filtrar por identificador único da loja
required: false
schema:
type: string
- name: name
in: query
description: Filtrar por nome da loja
required: false
schema:
type: string
responses:
'200':
description: Lojas listadas com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de lojas.
items:
$ref: '#/components/schemas/Store'
success:
$ref: '#/components/schemas/Success'
error:
type: string
nullable: true
example: null
pagination:
$ref: '#/components/schemas/PaginationCursor'
'401':
description: Não autorizado. Falha na autenticação.
content:
application/json:
schema:
type: object
properties:
error:
type: string
description: Mensagem de erro descrevendo o motivo da falha na autenticação.
example: Token de autenticação inválido ou ausente.
tags:
- Stores
operationId: getStoresList
x-operation-id-source: derived
components:
parameters:
QueryAfter:
name: after
in: query
description: Cursor para buscar itens após este ponto (use o `publicId` retornado em `pagination.next`).
required: false
schema:
type: string
QueryEndDate:
name: endDate
in: query
description: 'Filtra registros criados até esta data (inclusive). Formato `YYYY-MM-DD`. O intervalo é interpretado no fuso horário `America/Sao_Paulo` (23:59:59.999 do dia final).
'
required: false
schema:
type: string
format: date
example: '2026-01-31'
QueryBefore:
name: before
in: query
description: Cursor para buscar itens antes deste ponto (use o `publicId` retornado em `pagination.before`).
required: false
schema:
type: string
QueryLimit:
name: limit
in: query
description: Quantidade de itens por página (1-100).
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 100
example: 100
QueryStartDate:
name: startDate
in: query
description: 'Filtra registros criados a partir desta data (inclusive). Formato `YYYY-MM-DD`. O intervalo é interpretado no fuso horário `America/Sao_Paulo` (00:00 do dia inicial).
'
required: false
schema:
type: string
format: date
example: '2026-01-01'
schemas:
Success:
type: boolean
description: Se a requisição obteve sucesso ou não.
example: true
PaginationCursor:
type: object
description: Informações de paginação baseada em cursor.
required:
- hasMore
- next
- before
additionalProperties: false
properties:
hasMore:
type: boolean
description: Indica se existe uma próxima página.
next:
type: string
nullable: true
description: Cursor da próxima página (usar em `after`). `null` na última página.
before:
type: string
nullable: true
description: Cursor da página anterior (usar em `before`). `null` na primeira página.
Store:
type: object
description: Dados da loja/conta do usuário.
required:
- id
- name
- balance
additionalProperties: false
properties:
id:
type: string
description: Identificador único da loja.
example: store_abc123xyz
name:
type: string
description: Nome da loja.
example: Minha Loja
balance:
type: object
description: Informações de saldo da loja.
required:
- available
- pending
- blocked
additionalProperties: false
properties:
available:
type: number
description: Saldo disponível para saque em centavos.
example: 50000
pending:
type: number
description: Saldo pendente de confirmação em centavos.
example: 10000
blocked:
type: number
description: Saldo bloqueado em disputas em centavos.
example: 0
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: '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](/pages/authentication).
'