{
    "info": {
        "name": "pixeway — documentação",
        "description": "## API v1 (Pix)\n\nDocumentação das rotas de **cobrança Pix** e **saques Pix**. Autenticação: `Authorization: Bearer` com token de integração (Sanctum).\n\nNo OpenAPI abaixo, as rotas aparecem em relação ao servidor **/api** (ex.: `GET /v1/payments` corresponde a `GET /api/v1/payments` na aplicação).\n\n### Ambiente sandbox\n\nPara integração e testes sem impacto em produção, use o host público de sandbox **`https://sandbox.pixeway.com`**: a API fica em `https://sandbox.pixeway.com/api` (mesmos caminhos que em produção). No seletor de servidor da documentação interativa, escolha a opção **Sandbox**.\n\n### Pagamentos\n\n- **POST** `/api/v1/payments` — criar cobrança\n- **GET** `/api/v1/payments` — listar (paginação; query `per_page`, máx. 100)\n- **GET** `/api/v1/payments/{payment}` — recuperar uma\n- **POST** `/api/v1/payments/{payment}/refund` — reembolsar cobrança paga\n\nPermissões: `payments.create`, `payments.view`, `payments.refund`.\n\n### Saques (conta)\n\n- **POST** `/api/v1/withdrawals` — solicitar saque\n- **GET** `/api/v1/withdrawals` — listar saques da conta (`per_page`, máx. 100)\n- **GET** `/api/v1/withdrawals/{withdrawal}` — detalhe de um saque\n- **POST** `/api/v1/withdrawals/{withdrawal}/cancel` — cancelar saque pendente\n\nPermissões: criação/cancelamento com `payments.create`; listagem/detalhe com `payments.view`.",
        "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
    },
    "auth": {
        "type": "bearer",
        "bearer": [
            {
                "key": "token",
                "value": "{{integrationToken}}",
                "type": "string"
            }
        ]
    },
    "variable": [
        {
            "key": "baseUrl",
            "value": "https://pix-gateway-kc6qnagy.on-forge.com/api"
        },
        {
            "key": "integrationToken",
            "value": ""
        }
    ],
    "item": [
        {
            "name": "Pagamentos",
            "item": [
                {
                    "name": "Listagem de pagamentos",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/payments"
                        }
                    }
                },
                {
                    "name": "Criação de pagamento",
                    "request": {
                        "method": "POST",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/payments"
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{}\n",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                },
                {
                    "name": "Recuperação de pagamento",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/payments/{payment}"
                        }
                    }
                },
                {
                    "name": "Reembolso de pagamento",
                    "request": {
                        "method": "POST",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/payments/{payment}/refund"
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{}\n",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                }
            ]
        },
        {
            "name": "Saques",
            "item": [
                {
                    "name": "Listagem de saques",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/withdrawals"
                        }
                    }
                },
                {
                    "name": "Solicitação de saque (Pix)",
                    "request": {
                        "method": "POST",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/withdrawals"
                        },
                        "body": {
                            "mode": "raw",
                            "raw": "{}\n",
                            "options": {
                                "raw": {
                                    "language": "json"
                                }
                            }
                        }
                    }
                },
                {
                    "name": "Recuperação de saque",
                    "request": {
                        "method": "GET",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/withdrawals/{withdrawal}"
                        }
                    }
                },
                {
                    "name": "Cancelamento de saque",
                    "request": {
                        "method": "POST",
                        "header": [],
                        "url": {
                            "raw": "{{baseUrl}}/v1/withdrawals/{withdrawal}/cancel"
                        }
                    }
                }
            ]
        }
    ]
}