# Postman (/docs/pix-processamento/postman)



<QuickLinks>
  <QuickLink href="https://dev.payzu.com.br" title="Postman docs" />

  <QuickLink href="/openapi.json" title="OpenAPI" />

  <QuickLink href="/api-scalar" title="Scalar" />

  <QuickLink href="/api-swagger" title="Swagger" />
</QuickLinks>

A collection oficial PayZu Pix está publicada em &#x2A;*[dev.payzu.com.br](https://dev.payzu.com.br)** (Postman) com **Bearer Auth** via `{{token}}` e **3 ambientes** prontos (Mock, Sandbox, Production).

## Importar a collection [#importar-a-collection]

<PostmanButton />

Ou via URL no Postman: **Import → Link**:

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

## Setup em 3 passos [#setup-em-3-passos]

<Steps>
  <Step>
    ### Importar no seu workspace [#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.
  </Step>

  <Step>
    ### Configurar o token [#configurar-o-token]

    Na collection PayZu Pix → aba **Variables**:

    | Variável  | Valor                                             |
    | --------- | ------------------------------------------------- |
    | `baseUrl` | `https://api.payzu.processamento.com/v1` (padrão) |
    | `token`   | Seu Bearer token PayZu                            |

    Token aparece **automaticamente** no header `Authorization: Bearer {{token}}` de todas as requisições.
  </Step>

  <Step>
    ### Testar uma chamada [#testar-uma-chamada]

    Abre **Cobranças Pix → POST /pix** → **Send**. O exemplo já vem preenchido com `amount`, `clientReference`, `callbackUrl`. Volta o `qrCodeText` pra testar com qualquer banco que suporte Pix.
  </Step>
</Steps>

## Mock Server [#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.

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

<Callout type="info">
  O mock responde com base nos `examples` do OpenAPI. Não persiste estado entre chamadas, mas o formato é idêntico ao da API real.
</Callout>

## Boas práticas [#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 [#comparação-com-outros-visualizadores]

| Recurso             | Postman               | [Scalar](/api-scalar) | [Swagger](/api-swagger) |
| ------------------- | --------------------- | --------------------- | ----------------------- |
| Try-it com CORS     | **Sim (sem browser)** | Não (CORS bloqueia)   | Não (CORS bloqueia)     |
| Mock server público | **Sim**               | Não                   | Não                     |
| Environments        | **Sim**               | Não                   | Não                     |
| Monitor agendado    | **Sim**               | Não                   | Não                     |
| Code snippets       | Sim                   | Sim                   | Sim                     |
| Try-it no browser   | Não (Postman Web sim) | Sim                   | Sim                     |
| Sem instalação      | Postman Web           | **Sim**               | **Sim**                 |