Para desenvolvedores
API Pix da AnimusPay: cash in e cash out
A API Pix da AnimusPay é uma API REST para receber e enviar Pix a partir do seu sistema. Com ela você gera QR Codes de cobrança, faz transferências por chave Pix, devolve depósitos, consulta saldo e recebe webhooks a cada mudança de status, com autenticação por token Bearer, comunicação somente por HTTPS e ambiente de testes (sandbox).
O que a API faz
Cash in Pix
Cria cobranças Pix com QR Code em imagem base64 e código copia e cola, com split opcional entre recebedores.
Cash out Pix
Transfere valores por chave Pix: CPF ou CNPJ, e-mail, telefone ou chave aleatória, com comprovante em PDF.
Devolução
Reembolsa um depósito recebido a partir do identificador da transação.
Saldo e estatísticas
Consulta saldo disponível, a liberar, retido e transferido, e estatísticas de depósitos e saques por período.
Relatórios
Lista depósitos e saques com filtros de status e data, e exporta relatórios por e-mail.
Webhooks
Notificações por POST no endereço que você informa em cada transação.
Como começar
Crie sua conta
Cadastre-se na AnimusPay com CPF ou CNPJ e envie os dados para a análise de compliance.
Receba o acesso à API
Depois que o cadastro é aprovado pelo compliance, o token de API e o ambiente de testes são liberados para a sua conta.
Teste no sandbox
Simule cobranças e transferências no ambiente de testes antes de ir para produção.
Configure os webhooks
Informe o
postbackUrlem cada transação e trate as notificações no seu sistema.
Autenticação
Todas as chamadas usam a URL base https://api.animuspay.com.br/api/public/cash e o token no cabeçalho Authorization, no formato Bearer. Use sempre HTTPS e nunca envie o token na query string.
Authorization: Bearer SEU_API_TOKEN
Content-Type: application/jsonEndpoints
| Método | Caminho | Função |
|---|---|---|
POST | /deposits/pix | Gera um QR Code Pix para depósito (cash in) |
GET | /deposits | Lista depósitos com filtros de status e data |
GET | /deposits/{depositHash} | Consulta um depósito |
POST | /deposits/{depositHash}/refund | Devolve um depósito |
POST | /deposits/export | Exporta relatório de depósitos por e-mail |
POST | /withdrawals | Faz uma transferência por chave Pix (cash out) |
GET | /withdrawals | Lista saques com filtros de status e data |
GET | /withdrawals/{transferHash} | Consulta um saque |
GET | /withdrawals/{transferHash}/receipt | Baixa o comprovante em PDF |
POST | /withdrawals/export | Exporta relatório de saques por e-mail |
GET | /balance | Consulta o saldo |
GET | /statistics | Estatísticas de depósitos e saques por período |
GET | /account | Dados, limites e taxas da conta |
PUT | /account | Atualiza dados cadastrais da conta |
Exemplo: gerar uma cobrança Pix
Os valores são enviados em centavos. Os campos amount, method, transactionOrigin e payer (com name e email) são obrigatórios.
curl -X POST https://api.animuspay.com.br/api/public/cash/deposits/pix \
-H "Authorization: Bearer SEU_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"amount": 10000,
"method": "pix",
"transactionOrigin": "cashin",
"externalId": "pedido_123",
"postbackUrl": "https://seusite.com/webhooks/cash",
"payer": {
"name": "João Silva",
"email": "[email protected]",
"document": "12345678900"
}
}'{
"id": "dep_01HXXXXXXXXXXXXXXXXX",
"externalId": "pedido_123",
"method": "pix",
"status": "paid",
"pix": {
"code": "00020126580014br.gov.bcb.pix0136123e4567-e89b-12d3-a456-426614174000...",
"imageBase64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
},
"payer": {
"name": "João Silva",
"document": "12345678900",
"email": "[email protected]"
},
"amount": 10000,
"netAmount": 9900,
"fee": 100,
"endToEndId": "E12345678202301011234abcdefghijkl",
"postbackUrl": "https://seusite.com/webhooks/cash"
}A requisição foi montada com os campos da documentação oficial; o objeto de depósito reproduz o exemplo da documentação de webhooks, com valores fictícios.
Exemplo: transferência por chave Pix
No cash out, informe o valor em centavos, o tipo pix e os dados do recebedor. O tipo de chave pode ser document, email, phone_number ou aleatory.
curl -X POST https://api.animuspay.com.br/api/public/cash/withdrawals \
-H "Authorization: Bearer SEU_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"amount": 50000,
"type": "pix",
"description": "Saque para conta bancária",
"externalId": "saque_123",
"postbackUrl": "https://seusite.com/webhooks/cash",
"recipient": {
"name": "João Silva",
"document": "12345678900",
"pixKeyType": "email",
"pixKey": "[email protected]"
}
}'{
"id": "wth_01HXXXXXXXXXXXXXXXXX",
"amount": 50000,
"fee": 200,
"description": "Saque para conta bancária",
"status": "transferred",
"statusLabel": "Transferido",
"type": "pix"
}Webhooks
A AnimusPay envia um POST em JSON para o postbackUrl da transação a cada mudança de status. Responda com HTTP 2xx em menos de 30 segundos, trate as notificações de forma idempotente, porque elas podem ser reenviadas, e confirme o status consultando a API antes de liberar um pedido.
| Tipo | Status notificados |
|---|---|
| Depósito (cash in) | pending, paid, expired, refunded |
| Saque (cash out) | scheduled, processing, transferred, returned, cancelled, refused, failed |
Cartão, boleto, links e assinaturas por API
Além da API Pix, a AnimusPay oferece uma API de pagamentos para cobranças com cartão de crédito em até 12 vezes, boleto, links de pagamento e assinaturas, com webhooks assinados por HMAC-SHA256. Para receber a documentação, escreva para [email protected].
Recursos ligados
Perguntas frequentes sobre a API Pix
O que é uma API Pix?
É uma interface que permite ao seu sistema criar cobranças Pix, acompanhar pagamentos e fazer transferências de forma automática, sem operar manualmente pelo aplicativo do banco.
Como funciona a autenticação da API da AnimusPay?
Por token Bearer enviado no cabeçalho Authorization de cada requisição, sempre por HTTPS. O token nunca deve ir na query string.
A API da AnimusPay tem sandbox?
Sim. Há um ambiente de testes para simular cobranças e transferências antes de ir para produção.
Quais tipos de chave Pix posso usar no cash out?
CPF ou CNPJ, e-mail, telefone e chave aleatória.
Os valores são enviados em reais ou em centavos?
Em centavos. Um Pix de R$ 100,00 é enviado como 10000.
Quais são as taxas e os limites da API?
As taxas e os limites de cada conta podem ser consultados pelo endpoint GET /account. Para conhecer as condições comerciais, escreva para [email protected].
Integre o Pix ao seu sistema
Leia a documentação completa e crie sua conta para começar. Dúvidas técnicas? Escreva para [email protected].
Ver documentação