Documentação · Pix

Confrapix

Cobranças Pix no sandbox Confrapix: criação, consulta de status e callbacks.

Base: https://sandbox.confrapix.com.br/api
Autenticação: Authorization: Bearer <token do seller EC gerado em Credenciais>

Particularidades só no sandbox

Nenhuma cobrança movimenta valor real (`environment: sandbox`, `allowsRealMovement: false`).
No portal, o resultado do Pix (aprovado, recusado, expirado, estorno) é simulado localmente e não altera o host Confrapix.
Callbacks (`callback_url`) são disparados pelo portal apenas quando informados na criação.

Criar cobrança Pix

Abre uma cobrança Pix e devolve txid, QR/código e status inicial processing.

Endpoint de teste

Criar cobrança Pix

POSThttps://sandbox.confrapix.com.br/api/transaction-ec/store

Authorization: Bearer <token>

Sandbox Confrapix. Bearer token do seller EC. O playground local simula o mesmo contrato.

Parâmetros

amount obrigatório · number
Valor em reais, maior que zero, até duas casas.
customer_name opcional · string
Nome do pagador. Obrigatório se informar documento.
customer_document opcional · string
CPF (11) ou CNPJ (14). Obrigatório se informar nome.
description opcional · string
Texto livre até 255 caracteres.
expiration_date opcional · string
Expiração no formato AAAA-MM-DD HH:MM:SS.
callback_url opcional · string
Webhook http(s) notificado em mudanças de status.

Respostas

status 201
Cobrança criada no sandbox.
environment "sandbox"
Sempre sandbox.
allowsRealMovement false
Nunca movimenta valor real.
transaction.status processing
Aguardando pagamento.
transaction.pix object
url, txid e code do Pix de teste.

Só no sandbox

A simulação de pagamento no playground é local; use o painel de cenário para mudar o status.
O host Confrapix real atualiza status via pagamento/webhook, não via UI do portal.

Exemplo de request

{
  "amount": 12,
  "customer_name": "Ana Souza",
  "customer_document": "12312312300",
  "description": "Pix de teste",
  "expiration_date": "2026-12-31 23:59:59",
  "callback_url": "https://example.com/callback"
}

Exemplo de response

{
  "status": 201,
  "success": true,
  "environment": "sandbox",
  "allowsRealMovement": false,
  "transaction": {
    "uuid": "…",
    "status": "processing",
    "payment_type": "pix",
    "pix": { "txid": "…", "code": "sandbox-…", "url": "sandbox://pix/…" }
  }
}

Consultar status Pix

Consulta o status da cobrança pelo uuid.

Endpoint de teste

Consultar status da transação

GEThttps://sandbox.confrapix.com.br/api/transaction-ec/show/{uuid}

Authorization: Bearer <token>

Use o uuid da cobrança. Pode ser usado em polling até a confirmação.

Parâmetros

uuid obrigatório · path
Identificador da cobrança retornado no store.

Respostas

transaction.status string
processing | succeeded | declined | expired | refunded.
transaction.confirmed boolean
true quando a cobrança foi finalizada.
transaction.payed_in string|null
Data/hora do pagamento quando succeeded.

Só no sandbox

No portal, use o EndpointPanel e o detalhe da cobrança; o show remoto exige token do seller EC.

Acompanhar Pix no sandbox

Referência de polling no host Confrapix enquanto o portal simula o resultado localmente.

Endpoint de teste

Acompanhar Pix no sandbox

GEThttps://sandbox.confrapix.com.br/api/transaction-ec/show/{uuid}

Authorization: Bearer <token>

No sandbox Confrapix o status muda via pagamento de teste ou webhook. No portal, a simulação de Pix é local e não chama este host.

Parâmetros

uuid obrigatório · path
Uuid da cobrança Pix.

Respostas

transaction.status string
Status atual no host sandbox.

Só no sandbox

Particularidade do portal: o botão de simular Pix não chama este host.

← Voltar à documentação