01 — Introdução

Bem-vindo à API Pixispay

Essa é a API da Pixispay — uma subadquirente B2B brasileira que processa PIX, Boleto e Cartão de crédito. Aqui você encontra tudo o que precisa para integrar pagamentos na sua aplicação.

URL Base

https://api.pixispay.com

Sobre os valores

Todos os valores (amount) são enviados e retornados em centavos. Por exemplo, R$ 19,90 é enviado como 1990.

💡 Dica: Para começar, baixe nossa collection do Postman e teste todos os endpoints sem precisar escrever código.
02 — Integração

Passo a passo

Em quatro passos você está integrado à Pixispay e pronto para receber pagamentos em produção.

1. Aprovação da conta

Crie sua conta em app.pixispay.com/register e aguarde a aprovação. Após aprovado, acesse app.pixispay.com com seu usuário e senha.

2. Gere sua API Key

No painel, vá até a página Integrações (penúltimo item do menu lateral). Clique em Adicionar, dê um nome para a chave e clique em Criar. A chave aparecerá na lista — clique no ícone de copiar para guardá-la em segurança.

⚠ Importante: A API Key é sensível. Nunca exponha ela no frontend, em repositórios públicos ou em logs. Use variáveis de ambiente.

3. Cadastre seu Webhook

No menu lateral, acesse Webhooks e clique em Novo Webhook. Informe a URL do endpoint que receberá os eventos (transações e/ou saques).

Você pode criar um webhook para cada tipo de evento, ou um único endpoint que receba todos.

4. Faça sua primeira chamada

Pronto! Com a API Key em mãos, você já pode criar transações. Veja a seção Transações abaixo.

03 — Autenticação

Autenticação

A autenticação na API Pixispay é feita via header HTTP x-api-key.

Header obrigatório

x-api-key: SUA_API_KEY_AQUI

Exemplo de chamada autenticada

curl -X GET https://api.pixispay.com/balance \
  -H "x-api-key: pk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Endpoints de gerenciamento de chaves

POST/api-keys

Cria uma nova chave de API

GET/api-keys

Lista todas as chaves de API ativas

GET/api-keys/:id

Busca uma chave específica

DELETE/api-keys/:id

Remove uma chave da API

04 — Transações

Transações

A API suporta três meios de pagamento: PIX, Boleto e Cartão de crédito (com 3DS).

Endpoints de transações

POST/transactions/pix

Gera uma cobrança PIX (QR Code + copia-e-cola)

POST/transactions/boleto

Gera um boleto bancário

POST/transactions/card

Processa pagamento com cartão de crédito (com suporte a 3DS)

GET/transactions

Lista todas as transações com paginação

GET/transactions/:id

Busca uma transação específica pelo ID

GET/transactions/metadata

Busca transações por metadata customizada

Exemplo: Gerar PIX

curl -X POST https://api.pixispay.com/transactions/pix \
  -H "x-api-key: pk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 1990,
    "description": "Pedido #12345",
    "customer": {
      "name": "João Silva",
      "email": "joao@email.com",
      "document": "12345678900"
    }
  }'

Lembre-se: amount é em centavos (1990 = R$ 19,90).

📘 3DS no Cartão: Para pagamentos com cartão, leia também nosso guia 3DS — Primeiros passos.
05 — Webhooks

Webhooks

Configure URLs no painel para receber notificações em tempo real sobre transações e saques.

Tipos de webhook

Transação

Recebe atualizações de status de cobranças (PIX, Boleto e Cartão)

Saque

Recebe atualizações de operações de cash out

Eventos de transação

  • TRANSACTION_PAID — Pagamento confirmado
  • TRANSACTION_PENDING — Aguardando pagamento
  • TRANSACTION_REFUNDED — Estornado
  • TRANSACTION_FAILED — Falha no processamento
  • TRANSACTION_EXPIRED — Expirou sem pagamento

Endpoints de gerenciamento

POST/webhooks

Cadastra um novo webhook

GET/webhooks

Lista webhooks cadastrados

DELETE/webhooks/:id

Remove um webhook

06 — Saques

Withdraw / Cash Out

A API de saques permite enviar valores via PIX para qualquer chave válida no Brasil.

Tipos de chave PIX aceitos

  • PHONE — Telefone
  • EMAIL — E-mail
  • EVP — Chave aleatória
  • CPF — CPF
  • CNPJ — CNPJ

Endpoints

POST/withdraw/cash-out

Solicita um saque PIX

GET/withdraw

Lista todos os saques

GET/withdraw/:id

Busca um saque específico

Exemplo: Cash Out

curl -X POST https://api.pixispay.com/withdraw/cash-out \
  -H "x-api-key: pk_live_xxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "amount": 5000,
    "pix_key_type": "CPF",
    "pix_key": "12345678900",
    "description": "Saque mensal"
  }'
07 — Saldo

Balance

Consulte o saldo disponível na sua conta Pixispay em tempo real.

GET/balance

Retorna o saldo disponível e a receber

Exemplo

curl -X GET https://api.pixispay.com/balance \
  -H "x-api-key: pk_live_xxxxxxxxxxxxxxxx"

Taxas (Fees)

GET/fees

Consulta as taxas configuradas para a sua conta de seller

08 — Disputas

Disputes

Gerencie disputas e contestações de pagamentos com cartão diretamente pela API.

GET/disputes

Lista todas as disputas em aberto

GET/disputes/:id

Busca os detalhes de uma disputa específica

POST/disputes/:id/seller-appeal

Envia documentação de contestação como seller

Health Check

GET/check

Verifica se a API está online (use para health checks de monitoramento)

09 — Códigos de erro

Códigos de erro

400
Bad Request

Parâmetros inválidos ou faltantes na requisição

401
Unauthorized

API Key inválida, expirada ou ausente no header x-api-key

403
Forbidden

Sua conta não tem permissão para executar esta operação

404
Not Found

Recurso solicitado não existe

422
Unprocessable Entity

Validação falhou (ex: CPF inválido, valor abaixo do mínimo)

429
Too Many Requests

Limite de requisições por minuto excedido

500
Internal Server Error

Erro interno. Tente novamente em alguns minutos.

📚 Documentação completa: esta é uma referência resumida. Para a documentação interativa completa, com exemplos em todas as linguagens e ambiente de testes, acesse doc.pixispay.com.