A API Pix está detalhada no formato OpenAPI 3.077 e o formato de dados utilizados é o JSON.
A automação do usuário recebedor interage com a API utilizando web services baseados em REST sobre HTTPS.
O modelo empregado na integração das APIs é simples. Para executar uma operação:
- Combine a base da URL do ambiente com o endpoint da operação desejada.
- Envie a requisição para a URL utilizando o método HTTP adequado à operação.
| Método HTTP | Descrição |
|---|---|
| GET | Retorna recursos já existentes, ex.: consulta de cobrança. |
| POST | Cria um novo recurso, ex.: criação de cobrança. |
| PUT | Atualiza um recurso existente, ex.: realizar devolução. |
| DELETE | Exclui um recurso, ex.: exclui um webhook. |
| PATCH | Revisa um recurso, ex.: revisa uma cobrança. |
Cada envio de requisição irá retornar um código de Status HTTP, indicando se ela foi realizada com sucesso ou não.