Voltar à página inicial
Guias de Integração
Ref. de Webhooks Swagger OpenAPI
Developer Hub

Guias de Integração

Tudo o que a sua engenharia precisa para conectar o seu ERP ao motor PixSplit em minutos.

1. Autenticação Machine-to-Machine (Bearer API Key)

A API da PixSplit segue o padrão RESTful sobre HTTPS. Para chamadas originadas pelo servidor do seu ERP, gere uma credencial no menu API e Integrações do seu painel e envie no cabeçalho Authorization: Bearer sk_live_....

2. Emitindo um Pix com Regra de Split Híbrido

Após cadastrar os recebedores e criar uma regra de roteamento (/v1/split/rules), basta informar o regra_split_id ao gerar a cobrança:

Requisição HTTP — Criar Cobrança Pix com Split
http
POST https://api.pixsplitapi.com.br/v1/pix/generate
Authorization: Bearer sk_live_sua_chave_secreta_aqui
Content-Type: application/json

{
  "amount": 250.00,
  "description": "Mensalidade Sistema + Split Parceiro",
  "customer_name": "Comércio varejista LTDA",
  "customer_document": "12345678000199",
  "regra_split_id": "550e8400-e29b-41d4-a716-446655440000"
}
Resposta 201 Created — QR Code Pronto para o Checkout
json
{
  "transaction_id": "c9a646d3-9c61-4cb7-bfcd-922284e0d02a",
  "txid": "PXSP891234ABCDEF56789012345678",
  "amount": 250.00,
  "qrcode_text": "00020101021226830014BR.GOV.BCB.PIX2561...",
  "qrcode_image_url": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUg...",
  "status": "PROCESSING"
}

3. Boas Práticas de Produção

  • Conciliação pelo TXID: Armazene sempre o campo txid retornado na criação da cobrança; ele será a chave enviada no Webhook de confirmação.
  • Não exponha a API Key no Frontend: As chamadas para /v1/pix/*, /v1/payout/* e /v1/split/* devem partir exclusivamente do backend fechado do seu ERP.