API REST · JSON · PIX instantâneo

Documentação da API BANKPIX

Integre pagamentos e transferências PIX ao seu sistema em minutos. Gere cobranças com QR Code, envie pagamentos e receba confirmações automáticas por webhook.

Introdução

A API BANKPIX permite que qualquer sistema gere cobranças PIX (cash-in) e realize transferências PIX (cash-out) de forma programática. Todas as requisições enviam os dados como x-www-form-urlencoded e recebem respostas em JSON sobre HTTPS.

Para obter suas credenciais (client_id e client_secret), acesse Minhas Chaves de API no painel. Ainda não tem conta? Crie a sua gratuitamente.

Autenticação

Toda requisição deve incluir seu client_id e client_secret no corpo. Mantenha o client_secret em segredo — nunca o exponha no front-end.

Campo	Descrição
`client_id`	Identificador público da sua integração.
`client_secret`	Chave secreta. Trate como uma senha.

URL base

BASEhttps://bankpix.dexcheck.online

Todos os endpoints abaixo são relativos a esta URL base.

Gerar PIX (cobrança / cash-in)

Cria uma cobrança PIX e retorna o código copia e cola (EMV) para o pagador.

POSThttps://bankpix.dexcheck.online/v3/pix/qrcode

Parâmetros

Parâmetro	Descrição	Exemplo
`client_id`obrigatório	Identificação da integração	seu_client_id
`client_secret`obrigatório	Chave secreta	seu_client_secret
`nome`obrigatório	Nome do pagador	João da Silva
`cpf`obrigatório	CPF do pagador (só números)	12345678901
`valor`obrigatório	Valor da cobrança	100.00
`descricao`	Descrição do pagamento	Pagamento de serviços
`urlnoty`	URL que receberá o webhook de confirmação	https://seusite.com/callback

Exemplo — PHP / cURL

<?php
$apiUrl = 'https://bankpix.dexcheck.online/v3/pix/qrcode';
$postData = [
  'client_id'     => 'seu_client_id',
  'client_secret' => 'seu_client_secret',
  'nome'          => 'João da Silva',
  'cpf'           => '12345678901',
  'valor'         => 100.00,
  'descricao'     => 'Pagamento de serviços',
  'urlnoty'       => 'https://seusite.com/callback',
];
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
echo curl_exec($ch);

Resposta 200 OK

{
  "transactionId": "4392d1d7e408d3cec04fm1zf3gv7vkq1",
  "status": "PENDING",
  "amount": 100.00,
  "qrcode": "00020126580014br.gov.bcb.pix..."
}

O campo qrcode é o PIX copia e cola. Gere o QR Code visual a partir dele. Quando o pagamento for confirmado, você receberá um webhook na urlnoty.

Transferência PIX (saque / cash-out)

Envia um pagamento PIX para uma chave de destino.

POSThttps://bankpix.dexcheck.online/v3/pix/payment

Parâmetros

Parâmetro	Descrição	Exemplo
`client_id`obrigatório	Identificação da integração	seu_client_id
`client_secret`obrigatório	Chave secreta	seu_client_secret
`nome`obrigatório	Nome do recebedor	Maria Souza
`cpf`obrigatório	CPF do recebedor	98765432100
`valor`obrigatório	Valor da transferência	50.00
`chave_pix`obrigatório	Chave PIX de destino (CPF, e-mail, telefone ou aleatória)	maria@email.com
`urlnoty`	URL do webhook de confirmação	https://seusite.com/callback

Exemplo — PHP / cURL

<?php
$apiUrl = 'https://bankpix.dexcheck.online/v3/pix/payment';
$postData = [
  'client_id'     => 'seu_client_id',
  'client_secret' => 'seu_client_secret',
  'nome'          => 'Maria Souza',
  'cpf'           => '98765432100',
  'valor'         => 50.00,
  'chave_pix'     => 'maria@email.com',
  'urlnoty'       => 'https://seusite.com/callback',
];
$ch = curl_init($apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData));
echo curl_exec($ch);

Webhook · Evento de Pagamento

Quando uma cobrança é paga, enviamos um POST em JSON para a urlnoty informada. Responda com HTTP 200 para confirmar o recebimento.

{
  "transactionId": "4392d1d7e408d3cec04fm1zf3gv7vkq1",
  "external_id": "...",
  "transactionType": "RECEIVEPIX",
  "status": "PAID",
  "amount": 100.00
}

Credite somente quando transactionType = "RECEIVEPIX" e status = "PAID". Trate o evento de forma idempotente (não credite duas vezes o mesmo transactionId).

Webhook · Evento de Transferência

Ao concluir uma transferência (saque), enviamos a confirmação:

{
  "transactionId": "e76e996f57849498d0ddm4ebrz4y5g55",
  "transactionType": "PAYMENT",
  "status": "PAID",
  "amount": 50.00
}

Precisa de ajuda com a integração? Fale com o suporte pelo painel. · BANKPIX