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.comSobre os valores
Todos os valores (amount) são enviados e retornados em centavos. Por exemplo, R$ 19,90 é enviado como 1990.
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.
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.
Autenticação
A autenticação na API Pixispay é feita via header HTTP x-api-key.
Header obrigatório
x-api-key: SUA_API_KEY_AQUIExemplo 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
/api-keysCria uma nova chave de API
/api-keysLista todas as chaves de API ativas
/api-keys/:idBusca uma chave específica
/api-keys/:idRemove uma chave da API
Transações
A API suporta três meios de pagamento: PIX, Boleto e Cartão de crédito (com 3DS).
Endpoints de transações
/transactions/pixGera uma cobrança PIX (QR Code + copia-e-cola)
/transactions/boletoGera um boleto bancário
/transactions/cardProcessa pagamento com cartão de crédito (com suporte a 3DS)
/transactionsLista todas as transações com paginação
/transactions/:idBusca uma transação específica pelo ID
/transactions/metadataBusca 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).
Webhooks
Configure URLs no painel para receber notificações em tempo real sobre transações e saques.
Tipos de webhook
TransaçãoRecebe atualizações de status de cobranças (PIX, Boleto e Cartão)
SaqueRecebe atualizações de operações de cash out
Eventos de transação
TRANSACTION_PAID— Pagamento confirmadoTRANSACTION_PENDING— Aguardando pagamentoTRANSACTION_REFUNDED— EstornadoTRANSACTION_FAILED— Falha no processamentoTRANSACTION_EXPIRED— Expirou sem pagamento
Endpoints de gerenciamento
/webhooksCadastra um novo webhook
/webhooksLista webhooks cadastrados
/webhooks/:idRemove um webhook
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— TelefoneEMAIL— E-mailEVP— Chave aleatóriaCPF— CPFCNPJ— CNPJ
Endpoints
/withdraw/cash-outSolicita um saque PIX
/withdrawLista todos os saques
/withdraw/:idBusca 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"
}'Balance
Consulte o saldo disponível na sua conta Pixispay em tempo real.
/balanceRetorna 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)
/feesConsulta as taxas configuradas para a sua conta de seller
Disputes
Gerencie disputas e contestações de pagamentos com cartão diretamente pela API.
/disputesLista todas as disputas em aberto
/disputes/:idBusca os detalhes de uma disputa específica
/disputes/:id/seller-appealEnvia documentação de contestação como seller
Health Check
/checkVerifica se a API está online (use para health checks de monitoramento)
Códigos de erro
Parâmetros inválidos ou faltantes na requisição
API Key inválida, expirada ou ausente no header x-api-key
Sua conta não tem permissão para executar esta operação
Recurso solicitado não existe
Validação falhou (ex: CPF inválido, valor abaixo do mínimo)
Limite de requisições por minuto excedido
Erro interno. Tente novamente em alguns minutos.