Menu
Documentation

PIX

Modulo tecnico: pix

  • Endpoints HTTP: 16
  • MessagePattern/mensageria: nao incluido nesta pagina.

Funcoes

FuncaoMetodoRota
Cadastrar favorecido PIXPOST/hb/pix/contacts
Consultar chave PIX no DICTGET/hb/pix/dict
Listar chaves PIXGET/hb/pix/keys
Criar chave PIXPOST/hb/pix/keys
Excluir chave PIXDELETE/hb/pix/keys/:key
Solicitar MFA para chave PIXPOST/hb/pix/mfa
Responder portabilidade PIXPUT/hb/pix/portabilities
Consultar portabilidade PIXGET/hb/pix/portabilities/:id
Consultar QR Code PIXGET/hb/pix/qrcodes
Criar QR Code de cobranca PIXPOST/hb/pix/qrcodes/billing
Criar QR Code dinamico PIXPOST/hb/pix/qrcodes/dynamic
Criar QR Code estatico PIXPOST/hb/pix/qrcodes/static
Solicitar devolucao PIXPOST/hb/pix/refunds
Consultar status da devolucao PIXGET/hb/pix/refunds/:transaction_code/status
Transferir via PIXPOST/hb/pix/transactions
Consultar status da transacao PIXGET/hb/pix/transactions/:transaction_id/status

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}