AbacatePay Pix API
The Pix API from AbacatePay — 3 operation(s) for pix.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/abacatepay:abacatepay-pix-api"
All apis
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.
Get an API 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 Specification
openapi: 3.2.0
info:
title: AbacatePay Pix 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: Pix
paths:
/pix/send:
post:
summary: Enviar PIX
description: 'Permite que você envie dinheiro via PIX para qualquer chave PIX que não seja do titular da conta.
Você pode usar esta rota para:
- **Enviar pagamentos** para fornecedores, parceiros ou terceiros
- **Realizar transferências** para contas de outras pessoas ou empresas
- **Efetuar pagamentos** diretamente pela API
**Importante**: Esta funcionalidade é diferente dos payouts, pois permite enviar dinheiro para chaves PIX que não pertencem ao titular da conta. Use payouts quando quiser enviar para sua própria chave PIX.'
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Dados necessários para enviar um PIX.
required:
- amount
- externalId
- pix
additionalProperties: false
example:
amount: 10000
externalId: pix-123
description: Pagamento para fornecedor
pix:
key: '11987654321'
type: PHONE
properties:
amount:
type: number
description: Valor do PIX em centavos. A taxa (`platformFee`) é descontada desse valor; o destinatário recebe `amount` menos a taxa.
minimum: 100
example: 10000
externalId:
type: string
description: Identificador único do PIX em seu sistema.
example: pix-123
description:
type: string
description: Descrição opcional do PIX.
example: Pagamento para fornecedor
x-mint:
hidden: true
pix:
type: object
description: Dados da chave PIX de destino.
required:
- key
- type
additionalProperties: false
properties:
key:
type: string
description: Chave PIX de destino.
example: '11987654321'
type:
type: string
description: Tipo da chave PIX.
enum:
- CPF
- CNPJ
- PHONE
- EMAIL
- RANDOM
- BR_CODE
example: PHONE
responses:
'200':
description: PIX enviado com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PixTransaction'
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:
- Pix
operationId: postPixSend
x-operation-id-source: derived
/pix/get:
get:
summary: Buscar PIX
description: 'Permite que você recupere os detalhes de uma transação PIX específica usando o ID ou externalId.
Você pode buscar usando:
- `id`: Identificador único da transação PIX na AbacatePay
- `externalId`: Identificador único do PIX em seu sistema
**Importante**: Você deve fornecer pelo menos um dos parâmetros (`id` ou `externalId`).'
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único da transação PIX na AbacatePay.
required: true
schema:
type: string
example: txn_abc123xyz
- name: externalId
in: query
description: Identificador único do PIX em seu sistema.
required: false
schema:
type: string
example: pix-123
responses:
'200':
description: Detalhes do PIX retornados com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/PixTransaction'
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.
'404':
description: PIX não encontrado.
content:
application/json:
schema:
type: object
properties:
data:
type: string
nullable: true
example: null
error:
type: string
description: Mensagem de erro indicando que o PIX não foi encontrado.
example: PIX não encontrado com o ID ou externalId fornecido.
tags:
- Pix
operationId: getPixGet
x-operation-id-source: derived
/pix/list:
get:
summary: Listar PIX
description: 'Consulta um envio de PIX pelo `id`. Apesar do nome, esta rota não pagina nem aceita filtros: `id` é obrigatório e o contrato é o mesmo de `/pix/get`.'
security:
- bearerAuth: []
parameters:
- name: id
in: query
description: Identificador único do PIX enviado
required: true
schema:
type: string
example: pix_out_abc123xyz
- name: externalId
in: query
description: Identificador do PIX no seu sistema
required: false
schema:
type: string
example: pix-123
responses:
'200':
description: Lista de PIX retornada com sucesso.
content:
application/json:
schema:
type: object
properties:
data:
type: array
description: Lista de transações PIX criadas.
items:
$ref: '#/components/schemas/PixTransaction'
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:
- Pix
operationId: getPixList
x-operation-id-source: derived
components:
schemas:
Success:
type: boolean
description: Se a requisição obteve sucesso ou não.
example: true
PixTransaction:
type: object
description: Dados de uma transação PIX.
properties:
id:
type: string
description: Identificador único da transação PIX.
example: tran_abc123xyz
status:
type: string
description: Status atual da transação.
enum:
- COMPLETE
- FAILED
example: COMPLETE
devMode:
type: boolean
description: Indica se a transação foi criada em ambiente de testes.
example: false
receiptUrl:
type: string
format: uri
description: URL do comprovante da transação.
example: https://app.abacatepay.com/receipt/tran_abc123xyz
amount:
type: number
description: Valor da transação em centavos.
example: 10000
platformFee:
type: number
description: Taxa da plataforma em centavos, descontada do `amount`.
example: 80
externalId:
type: string
nullable: true
description: Identificador externo da transação.
example: pix-123
createdAt:
type: string
format: date-time
description: Data de criação da transação.
example: '2024-11-04T18:38:28.573Z'
updatedAt:
type: string
format: date-time
description: Data de atualização da transação.
example: '2024-11-04T18:38:28.573Z'
required:
- id
- status
- devMode
- receiptUrl
- amount
- platformFee
- createdAt
- updatedAt
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.
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).
'