{ "info": { "_postman_id": "2b92b558-92cd-43b3-ac60-dd1762fa858f", "name": "Pix COBRANÇA (banestes)", "description": "Esta API padroniza serviços oferecidos pelo Banestes no contexto do arranjo Pix, como criação de cobrança, verificação de Pix recebidos, devolução, consultas e geração de QR Code. Os serviços expostos pelo Banestes permitem ao Parceiro recebedor estabelecer integração de sua automação com os serviços Pix do Banestes.\n\n ### Evolução da API Pix\nA API Pix acompanhará as funcionalidades previstas pela [API de referência](https://bacen.github.io/pix-api/index.html \"API Pix - BACEN\"), e todos os serviços contidos nela serão disponibilizados e atualizados.\n\nAlém disso, necessidades advindas de parceiros do Banestes, com intuito de otimizar os serviços e integrações também, mas não necessariamente, podem ser adicionados de forma a tornar mais o serviço mais competitivo e de melhor usabilidade ao usuário final.\n\nNo entanto, alterações podem ocorrer a qualquer momento, desde que não alterem o contrato de interface e/ou detalhamentos adicionais às especificações. Deste modo, os parceiros deverão estar preparados para lidar com essas mudanças.\n\nAs seguintes mudanças são esperadas e consideradas retrocompatíveis:\n\n - Adição de novos recursos na API Pix\n - Adição de novos parâmetros opcionais a cobranças\n - Adição de novos campos em respostas da API Pix\n - Alteração da ordem de campos\n - Adição de novos elementos em enumerações\n\n[Documentação de Referência](https://bacen.github.io/pix-api/index.html \"API Pix - BACEN\")", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "67200" }, "item": [ { "name": "Access token", "item": [ { "name": "Access token (client-credentials )", "event": [ { "listen": "test", "script": { "exec": [ "//GET 'access_token' = 'client-id:access-token' (base64)", "const body = JSON.parse(responseBody);", "var accessTokenBase64 = body.access_token;", "postman.setEnvironmentVariable(\"access_token\", accessTokenBase64);", "", "//GET only 'access_token' (no base64)", "var decodeBase64 = atob(accessTokenBase64);", "const accessTokenDecode = decodeBase64.split(':')[1];", "postman.setEnvironmentVariable(\"access_token_decode\", accessTokenDecode);", "", "//tests[\"client-id:access-token Base64 => \" + accessTokenBase64] = true;", "tests[\" access-token decode => \" + accessTokenDecode] = true;" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/x-www-form-urlencoded", "type": "text" }, { "key": "Authorization", "value": "Basic {{Authorization}}" } ], "body": { "mode": "urlencoded", "urlencoded": [ { "key": "grant_type", "value": "client_credentials", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/oauth/v1/access-token", "host": [ "{{baseUrl}}" ], "path": [ "oauth", "v1", "access-token" ] } }, "response": [] }, { "name": "Test mockup", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/mockup", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "mockup" ] } }, "response": [] } ] }, { "name": "webhook ", "item": [ { "name": "{chave}", "item": [ { "name": "Exibir informações acerca do Webhook Pix", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para recuperação de informações sobre o Webhook Pix" }, "response": [ { "name": "Dados do webhook", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"chave\": \"dolor nisi dolore in\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"http://pCBxOZ.qoameewyJheFaa8Kcb\"\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Configurar o Webhook Pix", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para configuração do serviço de notificações acerca de Pix recebidos. Somente Pix associados a um txid serão notificados" }, "response": [ { "name": "Webhook para notificações acerca de Pix recebidos associados a um txid", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"webhookUrl\": \"https://pix.example.com/api/webhook/\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Cancelar o Webhook Pix", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para cancelamento do webhook. Não é a única forma pela qual um webhook pode ser removido.\n\nO Banestes está livre para remover unilateralmente um webhook que esteja associado a uma chave que não pertence mais a este usuário recebedor" }, "response": [ { "name": "Webhook para notificações Pix foi cancelado", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "text/plain" } ], "cookie": [], "body": "" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "Consultar webhooks cadastrados", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] }, "description": "Endpoint para consultar Webhooks cadastrados" }, "response": [ { "name": "Lista dos locations cadastrados de acordo com o critério de busca", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parametros\": {\n \"fim\": \"2020-04-01T17:00:00Z\",\n \"inicio\": \"2020-04-01T00:00:00Z\",\n \"paginacao\": {\n \"itensPorPagina\": 73962240,\n \"paginaAtual\": 67569899,\n \"quantidadeDePaginas\": 11561886,\n \"quantidadeTotalDeItens\": 93635193\n }\n },\n \"webhooks\": [\n {\n \"chave\": \"minim quis exercitation\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"https://TbFScykVJUddKgziOPvPFWo.akyWOVBSjfoZ7DOv8oz5amYjg4iw0wJWJPVFt,CmNt7vUkur9CI\"\n },\n {\n \"chave\": \"cillum sed mollit aliqua\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"http://eYlwCdKTHLvPuKvaoGwOigFqiQDJ.qpjyi0KKBiZSG\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "cob", "item": [ { "name": "{txid}", "item": [ { "name": "Consultar cobrança", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para consultar uma cobrança através de um determinado txid" }, "response": [ { "name": "Dados da cobrança", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"adipisicing ea in elit molli\",\n \"revisao\": -71388313,\n \"status\": \"ATIVA\",\n \"txid\": \"rFQ75ByAjtgozp6owk3Eaq8oCGUN\",\n \"valor\": {\n \"original\": \"8965.05\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"93315120074\",\n \"nome\": \"ex adipisicing\"\n },\n \"loc\": {\n \"criacao\": \"1953-09-14T01:35:08.997Z\",\n \"id\": -29489040,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cobv\"\n },\n \"solicitacaoPagador\": \"Ut commodo eu laborum\",\n \"infoAdicionais\": [\n {\n \"nome\": \"anim do\",\n \"valor\": \"id\"\n },\n {\n \"nome\": \"Duis ad ullamco\",\n \"valor\": \"fugiat\"\n }\n ],\n \"location\": \"sint cupidatat do\",\n \"pix\": [\n {\n \"endToEndId\": \"eKFVZgJoST8ZZpNsc5qt2D31fIF22F2W\",\n \"horario\": \"1959-11-23T17:26:35.586Z\",\n \"valor\": \"0.64\",\n \"txid\": \"6QrBPKCT1MyxEZmSi\",\n \"chave\": \"sint fugiat non in\",\n \"infoPagador\": \"labor\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"24911565962\",\n \"rtrId\": \"9RMQSMkIMqg9FbMOOMj55lXptGzdX3w4\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"70.57\",\n \"motivo\": \"sit dolor ut eiusmod\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"44416593239\",\n \"rtrId\": \"SlH20HDMW7pWiZ5KF492K7is8bf5kSA5\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"6.89\",\n \"motivo\": \"laborum exercitation Ut\"\n }\n ]\n },\n {\n \"endToEndId\": \"zUixNHduomM4y1W3dOURy1wJE4WhJDX1\",\n \"horario\": \"1946-01-09T07:46:38.801Z\",\n \"valor\": \"7897715.27\",\n \"txid\": \"UBjUmmUSbpdLIKLhiNn\",\n \"chave\": \"ex ut\",\n \"infoPagador\": \"anim est minim esse\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"37618252876\",\n \"rtrId\": \"MukpWzSjAAd1UbmNilYJeDFf6ImdzTQA\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"54986.93\",\n \"motivo\": \"labore id eu nulla dolore\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"33867805782\",\n \"rtrId\": \"0rHWrPhETbhxd7CIv7pO3wk7HQP777Xc\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"716.94\",\n \"motivo\": \"ea nisi\"\n }\n ]\n }\n ]\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": " Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob/:txid?revisao=57689485", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "query": [ { "key": "revisao", "value": "57689485" } ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Criar uma cobrança", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para criar uma cobrança" }, "response": [ { "name": "Cobrança criada", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"in labore ex aute\",\n \"revisao\": 29777232,\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"txid\": \"XqAku0ZeWCfF33L3L1KVtwMiXE\",\n \"valor\": {\n \"original\": \"035963.40\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"63218595890\",\n \"nome\": \"sint veniam exercitation\"\n },\n \"loc\": {\n \"criacao\": \"1997-05-28T10:25:04.695Z\",\n \"id\": -77998108,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"est quis\",\n \"infoAdicionais\": [\n {\n \"nome\": \"in \",\n \"valor\": \"adipisicing est\"\n },\n {\n \"nome\": \"sit consequat in aute\",\n \"valor\": \"ea dolore\"\n }\n ],\n \"location\": \"ad aliquip consequat\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": " Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Revisar cobrança", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para revisar cobrança" }, "response": [ { "name": "Cobrança revisada. A revisão deve ser incrementada em 1", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"in labore ex aute\",\n \"revisao\": 29777232,\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"txid\": \"XqAku0ZeWCfF33L3L1KVtwMiXE\",\n \"valor\": {\n \"original\": \"035963.40\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"63218595890\",\n \"nome\": \"sint veniam exercitation\"\n },\n \"loc\": {\n \"criacao\": \"1997-05-28T10:25:04.695Z\",\n \"id\": -77998108,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"est quis\",\n \"infoAdicionais\": [\n {\n \"nome\": \"in \",\n \"valor\": \"adipisicing est\"\n },\n {\n \"nome\": \"sit consequat in aute\",\n \"valor\": \"ea dolore\"\n }\n ],\n \"location\": \"ad aliquip consequat\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": " Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "PATCH", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"chave\": \"7d9f0335-bbbb-4054-8af4-0dbd61d36906\",\n \"solicitacaoPagador\": \"Serviço realizado\",\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob", ":txid" ], "variable": [ { "key": "txid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "Consultar lista de cobranças", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] }, "description": "Endpoint para consultar cobranças através de parâmetros como início, fim, cpf, cnpj e status" }, "response": [ { "name": "Lista de cobranças", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"cobs\": [\n {\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"qui in\",\n \"revisao\": 71671835,\n \"status\": \"CONCLUIDA\",\n \"txid\": \"WiiPsvqZhbmYGwi1vBmdqKVTlbGk0n75\",\n \"valor\": {\n \"original\": \"64.66\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"49322736484\",\n \"nome\": \"ipsum Duis mollit\"\n },\n \"loc\": {\n \"criacao\": \"2003-07-31T23:14:25.397Z\",\n \"id\": -68672162,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"enim in aliquip magna\",\n \"infoAdicionais\": [\n {\n \"nome\": \"sit ea mollit in\",\n \"valor\": \"ipsum ea consequat quis\"\n },\n {\n \"nome\": \"enim Ut\",\n \"valor\": \"irure consectetur Duis\"\n }\n ],\n \"location\": \"eu culpa nulla\",\n \"pix\": [\n {\n \"endToEndId\": \"89eK4tzTz1HEBXaTn7XMg2JusAHJIYVY\",\n \"horario\": \"1996-03-17T05:40:00.262Z\",\n \"valor\": \"5.11\",\n \"txid\": \"Rxpf\",\n \"chave\": \"ipsum adipisicing exercitation\",\n \"infoPagador\": \"anim\",\n \"devolucoes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"endToEndId\": \"2lLmPSw3xEgHcpB8du641yNZdqgxCgRx\",\n \"horario\": \"2013-06-13T07:35:09.431Z\",\n \"valor\": \"53979667.53\",\n \"txid\": \"BiUq8r\",\n \"chave\": \"dolore ip\",\n \"infoPagador\": \"labore anim\",\n \"devolucoes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"sunt officia ad\",\n \"revisao\": -71115557,\n \"status\": \"CONCLUIDA\",\n \"txid\": \"ANagwsP5jYIuVz69gLv2keVfusziTd\",\n \"valor\": {\n \"original\": \"0281.59\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"51567019936\",\n \"nome\": \"dolor sunt quis\"\n },\n \"loc\": {\n \"criacao\": \"1962-11-25T19:23:01.973Z\",\n \"id\": -1063498,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"Lorem sed\",\n \"infoAdicionais\": [\n {\n \"nome\": \"minim quis\",\n \"valor\": \"ut enim sint\"\n },\n {\n \"nome\": \"ea anim commodo ut\",\n \"valor\": \"sint aliqua\"\n }\n ],\n \"location\": \"Ut mollit pariatur\",\n \"pix\": [\n {\n \"endToEndId\": \"6DbF8cludc2QtPJnNCdL7iWRclJSATB6\",\n \"horario\": \"2003-10-28T21:04:41.612Z\",\n \"valor\": \"96954.98\",\n \"txid\": \"mVrH3L6TrL9jNCi5sxnbp5U0GA82j\",\n \"chave\": \"incididunt cillum\",\n \"infoPagador\": \"do nisi adipisicing sit\",\n \"devolucoes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n },\n {\n \"endToEndId\": \"c4BonHJcvnIABwd4n6VIdhCIaenceaiO\",\n \"horario\": \"1987-02-06T16:59:04.065Z\",\n \"valor\": \"081491576.03\",\n \"txid\": \"XXixaCh\",\n \"chave\": \"enim Lorem\",\n \"infoPagador\": \"dolore quis reprehenderit nulla\",\n \"devolucoes\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ]\n }\n ]\n }\n ],\n \"parametros\": {\n \"fim\": \"2020-04-01T17:00:00Z\",\n \"inicio\": \"2020-04-01T00:00:00Z\",\n \"paginacao\": {\n \"itensPorPagina\": 14753288,\n \"paginaAtual\": 86452148,\n \"quantidadeDePaginas\": 4766755,\n \"quantidadeTotalDeItens\": 51225294\n },\n \"cpf\": \"95523990152\",\n \"cnpj\": \"47185934825200\",\n \"locationPresente\": true,\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\"\n }\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": " Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob?cpf=sit anim&cnpj=sit anim&locationPresente=true&status=REMOVIDA_PELO_USUARIO_RECEBEDOR&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "cob" ], "query": [ { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "locationPresente", "value": "true" }, { "key": "status", "value": "REMOVIDA_PELO_USUARIO_RECEBEDOR" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Criar uma cobrança", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {\r", " pm.response.to.have.status(201);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/cob", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "cob" ] }, "description": "Endpoint para criar uma cobrança, neste caso, o txid será definido pelo BANESTES" }, "response": [ { "name": "Cobrança criada", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob", "host": [ "{{baseUrl}}" ], "path": [ "cob" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"calendario\": {\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"expiracao\": 3600\n },\n \"chave\": \"Ut pariatur officia mollit\",\n \"revisao\": 40365928,\n \"status\": \"CONCLUIDA\",\n \"txid\": \"eguDl3b8K3IFPOqZ0x8UAMb8rUDShwgr\",\n \"valor\": {\n \"original\": \"2013620560.93\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"58937737571\",\n \"nome\": \"dolor deserunt\"\n },\n \"loc\": {\n \"criacao\": \"1967-04-22T07:14:05.167Z\",\n \"id\": -30386675,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"id esse dolore\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Duis \",\n \"valor\": \"id magna sit aute\"\n },\n {\n \"nome\": \"labore\",\n \"valor\": \"quis\"\n }\n ],\n \"location\": \"eu occaecat\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob", "host": [ "{{baseUrl}}" ], "path": [ "cob" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob", "host": [ "{{baseUrl}}" ], "path": [ "cob" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob", "host": [ "{{baseUrl}}" ], "path": [ "cob" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": " Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"valor\": {\n \"original\": \"37.55\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"11122233344\",\n \"nome\": \"Joao\"\n },\n \"loc\": {\n \"id\": 1\n },\n \"solicitacaoPagador\": \"Informar a cor da camisa\",\n \"infoAdicionais\": [\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n },\n {\n \"nome\": \"Informação Adicional\",\n \"valor\": \"Valor da Informação Adicional\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob", "host": [ "{{baseUrl}}" ], "path": [ "cob" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "qr-code", "item": [ { "name": "Retorna dados do Pix", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {\r", " pm.response.to.have.status(201);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"qrCodeText\": \"00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/7ef845dbe32043eca92aee43146837225204000053039865802BR5903Pix6008BRASILIA62070503***63040D4C\",\n \"codMun\": \"3205309\",\n \"dpp\": \"yyyy-MM-dd\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/qr-code/ler", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "qr-code", "ler" ] }, "description": "Retorna dados para iniciação de Pix por meio de um QR Code" }, "response": [ { "name": "Dados para pagamento da cobrança associada ao QR Code", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"qrCodeText\": \"00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/7ef845dbe32043eca92aee43146837225204000053039865802BR5903Pix6008BRASILIA62070503***63040D4C\",\n \"codMun\": \"3205309\",\n \"dpp\": \"yyyy-MM-dd\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/ler", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "ler" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"chave\": \"quis\",\n \"tipoQR\": \"COBV\",\n \"txid\": \"duEKGl1jUlcb7jDSizQiWTWGgPj\",\n \"infoAdicionais\": [\n {\n \"nome\": \"pariat\",\n \"valor\": \"exercitation consequat eiusmod nostrud\"\n },\n {\n \"nome\": \"proident sit et venia\",\n \"valor\": \"officia nostrud ipsum\"\n }\n ],\n \"valor\": {\n \"original\": \"3039969.22\"\n }\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"qrCodeText\": \"00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/7ef845dbe32043eca92aee43146837225204000053039865802BR5903Pix6008BRASILIA62070503***63040D4C\",\n \"codMun\": \"3205309\",\n \"dpp\": \"yyyy-MM-dd\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/ler", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "ler" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": " Erro de validação de um elemento", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"qrCodeText\": \"00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/7ef845dbe32043eca92aee43146837225204000053039865802BR5903Pix6008BRASILIA62070503***63040D4C\",\n \"codMun\": \"3205309\",\n \"dpp\": \"yyyy-MM-dd\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/ler", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "ler" ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 422,\n \"title\": \"Entidade Não Processável\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/EntidadeNaoProcessavel\",\n \"detail\": \"A requisição não pôde ser processada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"qrCodeText\": \"00020126940014br.gov.bcb.pix2572qr-h.sandbox.pix.bcb.gov.br/rest/api/v2/7ef845dbe32043eca92aee43146837225204000053039865802BR5903Pix6008BRASILIA62070503***63040D4C\",\n \"codMun\": \"3205309\",\n \"dpp\": \"yyyy-MM-dd\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/ler", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "ler" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" } ] }, { "name": "Gerar QR Code", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {\r", " pm.response.to.have.status(201);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"merchantName\": \"Loja de Roupas SA\",\n \"transactionAmount\": \"55.55\",\n \"txId\": \"0123465789012346578912345\",\n \"infoAdicional\": \"Cor da camisa\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/qr-code/estatico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "qr-code", "estatico", "gerar" ] }, "description": "Retorna a representação em String de um QR Code" }, "response": [ { "name": "Representação em String do QR Code", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"merchantName\": \"Loja de Roupas SA\",\n \"transactionAmount\": \"55.55\",\n \"txId\": \"0123465789012346578912345\",\n \"infoAdicional\": \"Cor da camisa\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/estatico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "estatico", "gerar" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"qrCodeText\": \"voluptate Excepteur\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"merchantName\": \"Loja de Roupas SA\",\n \"transactionAmount\": \"55.55\",\n \"txId\": \"0123465789012346578912345\",\n \"infoAdicional\": \"Cor da camisa\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/estatico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "estatico", "gerar" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Erro interno", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"merchantName\": \"Loja de Roupas SA\",\n \"transactionAmount\": \"55.55\",\n \"txId\": \"0123465789012346578912345\",\n \"infoAdicional\": \"Cor da camisa\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/estatico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "estatico", "gerar" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" } ] }, { "name": "Gerar QR Code por cobrança", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {\r", " pm.response.to.have.status(201);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"txid\": \"V7MZmVAkHMRlXdqAq8dvW5Dq92Bs7OldHD\",\n \"idLocation\": 789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/qr-code/dinamico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "qr-code", "dinamico", "gerar" ] }, "description": "Retorna a representação em String de um QR Code a partir de uma cobrança" }, "response": [ { "name": "Representação em String do QR Code", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"txid\": \"V7MZmVAkHMRlXdqAq8dvW5Dq92Bs7OldHD\",\n \"idLocation\": 789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/dinamico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "dinamico", "gerar" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"qrCodeText\": \"voluptate Excepteur\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"txid\": \"V7MZmVAkHMRlXdqAq8dvW5Dq92Bs7OldHD\",\n \"idLocation\": 789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/dinamico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "dinamico", "gerar" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Erro interno", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"txid\": \"V7MZmVAkHMRlXdqAq8dvW5Dq92Bs7OldHD\",\n \"idLocation\": 789\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/qr-code/dinamico/gerar", "host": [ "{{baseUrl}}" ], "path": [ "qr-code", "dinamico", "gerar" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" } ] } ] }, { "name": "loc", "item": [ { "name": "{id}", "item": [ { "name": "Recupera a location do payload", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] }, "description": "Recupera a location do payload" }, "response": [ { "name": "Dados da location do Payload", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"criacao\": \"2009-04-22T07:40:22.231Z\",\n \"id\": 2905018,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\",\n \"txid\": \"jhe2I0LUSEtFMDqq84sxEYWowD8vuug3UBX\"\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Desvincular uma cobrança de uma location", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] }, "description": "Endpoint utilizado para desvincular uma cobrança de uma location.\n\nSe executado com sucesso, a entidade loc não apresentará mais um txid, se apresentava anteriormente à chamada. Adicionalmente, a entidade cob ou cobv associada ao txid desvinculado também passará a não mais apresentar um location. Esta operação não altera o status da cob ou cobv em questão." }, "response": [ { "name": "Cobrança representada pelo txid informado desvinculada com sucesso", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"criacao\": \"1944-06-14T04:40:27.459Z\",\n \"id\": 73330075,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cobv\"\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/loc/:id/txid", "host": [ "{{baseUrl}}" ], "path": [ "loc", ":id", "txid" ], "variable": [ { "key": "id", "value": "39874530", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "Consultar locations cadastradas", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] }, "description": "Endpoint para consultar locations cadastradas" }, "response": [ { "name": "Lista dos locations cadastrados de acordo com o critério de busca", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"loc\": [\n {\n \"criacao\": \"1943-03-31T07:14:09.084Z\",\n \"id\": -7218224,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\",\n \"txid\": \"TXjvZSGPhqyJuyc8cYrmjm6AYMv\"\n },\n {\n \"criacao\": \"2005-05-05T02:16:36.968Z\",\n \"id\": 4943320,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\",\n \"txid\": \"qydm1aHpvVBeCuPPoXW0MEcWy6ifoivW\"\n }\n ],\n \"parametros\": {\n \"fim\": \"2020-04-01T17:00:00Z\",\n \"inicio\": \"2020-04-01T00:00:00Z\",\n \"paginacao\": {\n \"itensPorPagina\": 69656467,\n \"paginaAtual\": 25315988,\n \"quantidadeDePaginas\": 90988448,\n \"quantidadeTotalDeItens\": 38936296\n },\n \"txIdPresente\": true,\n \"tipoCob\": \"cob\"\n }\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/loc?txidPresente=true&tipoCob=cobv&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "loc" ], "query": [ { "key": "txidPresente", "value": "true" }, { "key": "tipoCob", "value": "cobv" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Criar location do payload", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 201\", function () {\r", " pm.response.to.have.status(201);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/loc", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "loc" ] }, "description": "Criar location do payload" }, "response": [ { "name": "Dados da location do Payload", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loc", "host": [ "{{baseUrl}}" ], "path": [ "loc" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"criacao\": \"1944-06-14T04:40:27.459Z\",\n \"id\": 73330075,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cobv\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loc", "host": [ "{{baseUrl}}" ], "path": [ "loc" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 400,\n \"title\": \"Operação Inválida\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/OperacaoInvalida\",\n \"detail\": \"A requisição que busca alterar ou criar um registro não respeita o schema ou está semanticamente errada\",\n \"violacoes\": [\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n },\n {\n \"razao\": \"O valor para o campo não pode ser negativo\",\n \"propriedade\": \"Exemplo de propriedade do objeto\",\n \"valor\": \"-10\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loc", "host": [ "{{baseUrl}}" ], "path": [ "loc" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loc", "host": [ "{{baseUrl}}" ], "path": [ "loc" ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"tipoCob\": \"cob\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/loc", "host": [ "{{baseUrl}}" ], "path": [ "loc" ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] }, { "name": "pix", "item": [ { "name": "Consultar Pix recebidos", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/pix?txid=sit anim&txidPresente=true&devolucaoPresente=true&cpf=sit anim&cnpj=sit anim&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "pix" ], "query": [ { "key": "txid", "value": "sit anim" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'", "description": "(Required) " }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] }, "description": "Endpoint para consultar Pix recebidos" }, "response": [ { "name": "Lista dos Pix recebidos de acordo com o critério de busca", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix?txid=sit anim&txidPresente=true&devolucaoPresente=true&cpf=sit anim&cnpj=sit anim&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "txid", "value": "sit anim" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"parametros\": {\n \"fim\": \"2020-04-01T17:00:00Z\",\n \"inicio\": \"2020-04-01T00:00:00Z\",\n \"paginacao\": {\n \"itensPorPagina\": 25853880,\n \"paginaAtual\": 38966821,\n \"quantidadeDePaginas\": 99462534,\n \"quantidadeTotalDeItens\": 35552407\n },\n \"txid\": \"W5J25i2voV3YRWGsuEcXwFengWmQ9SUm\",\n \"txIdPresente\": true,\n \"devolucaoPresente\": true,\n \"cpf\": \"94486221061\",\n \"cnpj\": \"83619852592991\"\n },\n \"pix\": [\n {\n \"endToEndId\": \"7sdQA9NHoGK4oqIrLCXv1YHu6ZB1d6Ih\",\n \"horario\": \"1990-11-13T03:42:15.789Z\",\n \"valor\": \"3411542257.38\",\n \"txid\": \"BSzXLAq8zV9Jk1fKtzNBKBL\",\n \"chave\": \"commodo nostrud reprehenderit\",\n \"infoPagador\": \"nisi aliquip est\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"88665780353\",\n \"rtrId\": \"WTJ4Vlx66DAIKPzjT5C5pG0gh7ZR5re9\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"3366.90\",\n \"motivo\": \"cupidatat Duis ipsum labore\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"27049206404\",\n \"rtrId\": \"AM4sBxVbQVbVuBSWz4csmj2rAZOIqmOk\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"0626962.40\",\n \"motivo\": \"dolore eni\"\n }\n ]\n },\n {\n \"endToEndId\": \"ir5RrzlTJAtQm0uLVHlW8SgsGEW44btH\",\n \"horario\": \"1989-01-12T13:07:13.683Z\",\n \"valor\": \"292188.59\",\n \"txid\": \"fw65Ed2ns8IfC3nv6GBKVmMQfEteLTRP\",\n \"chave\": \"aliqua exe\",\n \"infoPagador\": \"velit dolore\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"94760737059\",\n \"rtrId\": \"METwGDbTSU8jwvrJLvj2fEVOcyTsL9A1\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"838079391.18\",\n \"motivo\": \"minim\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"04189882503\",\n \"rtrId\": \"XKZ6roEWxMXzralMRT7BDwECrOd27yaq\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"642707.25\",\n \"motivo\": \"commodo elit adipisicing aliqua consequat\"\n }\n ]\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix?txid=sit anim&txidPresente=true&devolucaoPresente=true&cpf=sit anim&cnpj=sit anim&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "txid", "value": "sit anim" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix?txid=sit anim&txidPresente=true&devolucaoPresente=true&cpf=sit anim&cnpj=sit anim&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "txid", "value": "sit anim" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix?txid=sit anim&txidPresente=true&devolucaoPresente=true&cpf=sit anim&cnpj=sit anim&inicio=yyyy-MM-dd'T'HH:mm:ss.'&fim=yyyy-MM-dd'T'HH:mm:ss.'&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "txid", "value": "sit anim" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "cpf", "value": "sit anim" }, { "key": "cnpj", "value": "sit anim" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.'" }, { "key": "paginacao.paginaAtual", "value": "0" }, { "key": "paginacao.itensPorPagina", "value": "100" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] }, { "name": "Consultar Pix por Identificação", "event": [ { "listen": "test", "script": { "exec": [ "pm.test(\"Status code is 200\", function () {\r", " pm.response.to.have.status(200);\r", "});" ], "type": "text/javascript" } } ], "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Authorization", "value": "Bearer {{access_token}}", "type": "text" } ], "url": { "raw": "{{baseUrl}}/pix-qrcode-cobranca/v1/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-cobranca", "v1", "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] }, "description": "Endpoint para consultar um Pix através de um e2eid" }, "response": [ { "name": "Dados do Pix recebido", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"endToEndId\": \"CZEHrvlxHcgRolwpMdgugsUty71Du4w6\",\n \"horario\": \"1946-09-01T08:40:04.972Z\",\n \"valor\": \"31074655.61\",\n \"txid\": \"VyTm\",\n \"chave\": \"amet labore Duis Lorem aliqua\",\n \"infoPagador\": \"ut dolor Exc\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": \"1973-06-03T08:59:55.915Z\",\n \"liquidacao\": \"2013-03-08T10:52:12.426Z\"\n },\n \"id\": \"34518420846\",\n \"rtrId\": \"7Nw03wqPpb6GqrW5fMb0LLxK4KSebbZC\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"74345936.48\",\n \"motivo\": \"consectetur\"\n },\n {\n \"horario\": {\n \"solicitacao\": \"1966-05-28T19:36:51.659Z\",\n \"liquidacao\": \"1969-10-29T05:06:11.666Z\"\n },\n \"id\": \"38461592749\",\n \"rtrId\": \"CLcBD31zSGPz1UsTAyVnP4ovZHhLeyCt\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"84531923.56\",\n \"motivo\": \"voluptate ipsum Ut\"\n }\n ]\n}" }, { "name": "Requisição de participante autenticado que viola alguma regra de autorização", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 403,\n \"title\": \"Acesso Negado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/AcessoNegado\",\n \"detail\": \"Requisição de participante autenticado que viola alguma regra de autorização\"\n}" }, { "name": "Recurso solicitado não foi encontrado", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 404,\n \"title\": \"Não Encontrado\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/NaoEncontrado\",\n \"detail\": \"Entidade não encontrada\"\n}" }, { "name": "Erro interno", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 500,\n \"title\": \"Erro Interno\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ErroInterno\",\n \"detail\": \"Erro inesperado\"\n}" }, { "name": "Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "sit anim", "description": "(Required) " } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": 503,\n \"title\": \"Serviço Indisponível\",\n \"type\": \"https://pix.bcb.gov.br/api/v2/error/ServicoIndisponivel\",\n \"detail\": \"Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento\"\n}" } ] } ] } ], "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "exec": [ "" ] } } ] }