PayZuPayZu Docs

Postman

A collection oficial PayZu Pix está publicada em dev.payzu.com.br (Postman) com 29 endpoints organizados em 7 folders, Bearer Auth via {{token}} e 3 ambientes prontos (Mock, Sandbox, Production).

Importar a collection

Run in Postman

Ou via URL no Postman: Import → Link:

https://docs.payzu.com.br/payzu-pix.postman_collection.json

Setup em 3 passos

Importar no seu workspace

Clica em Run in Postman acima. A collection é forkada pro seu workspace pessoal, com toda a estrutura: folders, autenticação, exemplos.

Configurar o token

Na collection PayZu Pix → aba Variables:

VariávelValor
baseUrlhttps://api.payzu.processamento.com/v1 (padrão)
tokenSeu Bearer token PayZu

Token aparece automaticamente no header Authorization: Bearer {{token}} de todas as 29 requisições.

Testar uma chamada

Abre Cobranças Pix → POST /pixSend. O exemplo já vem preenchido com amount, clientReference, callbackUrl. Volta o qrCodeText pra testar com qualquer banco que suporte Pix.

Mock Server

Pra desenvolvimento sem precisar do token real, a collection tem um mock server público que responde com os exemplos do OpenAPI. Útil também pra contornar CORS em ferramentas web.

https://a8aa4f94-6b53-4994-bc60-7b2347f008e1.mock.pstmn.io

Use no lugar de https://api.payzu.processamento.com/v1 enquanto desenvolve o front-end.

RequestResposta mock
POST /pix{ id, qrCodeText, status: "PENDING", ... }
GET /pix?clientReference=order-1{ status: "COMPLETED", ... }
GET /user/balance{ available: 12450.75, blocked: 0, ... }

O mock responde com base nos examples do OpenAPI. Não persiste estado entre chamadas, mas o formato é idêntico ao da API real.

Boas práticas

  • Crie um fork da collection oficial em vez de editar a original. Forks recebem updates upstream.
  • Use environments pra trocar baseUrl entre dev/prod (api.payzu.processamento.com/v1 vs mock).
  • Snippets de código: clica em </> no canto direito de qualquer request pra exportar em curl, Node, Python, Go, PHP, etc.
  • Monitor: ative Postman Monitor pra testar a API a cada 5 min e receber alerta se cair.

Comparação com outros visualizadores

RecursoPostmanScalarSwagger
Try-it com CORSSim (sem browser)Não (CORS bloqueia)Não (CORS bloqueia)
Mock server públicoSimNãoNão
EnvironmentsSimNãoNão
Monitor agendadoSimNãoNão
Code snippetsSimSimSim
Try-it no browserNão (Postman Web sim)SimSim
Sem instalaçãoPostman WebSimSim

On this page