{ "info": { "_postman_id": "be1aa950-5119-4ff9-9b91-1a5c08a70b43", "name": "Pix ARRECADAÇÃO (banestes)", "description": "API para exposição de serviços para arrecadação com integração ao Pix", "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-arrecadacao/v1/mockup", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "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-arrecadacao/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "et", "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": "et", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"chave\": \"irure labore reprehenderit elit\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"https://BKOpMd.qnvdEw94nB1vhhIWQLlFHp\"\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": "et", "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": "et", "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": "et", "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": "et", "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-arrecadacao/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "et", "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": "et", "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": "et", "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": "et", "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": "et", "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": "et", "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": "et", "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-arrecadacao/v1/webhook/:chave", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "webhook", ":chave" ], "variable": [ { "key": "chave", "value": "et", "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": "et", "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": "et", "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": "et", "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": "et", "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": "et", "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-arrecadacao/v1/webhook?inicio=yyyy-MM-dd'T'HH:mm:ss.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z", "description": "(Required) " }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z", "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.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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\": 69726498,\n \"paginaAtual\": 28161621,\n \"quantidadeDePaginas\": 97500992,\n \"quantidadeTotalDeItens\": 28073242\n }\n },\n \"webhooks\": [\n {\n \"chave\": \"exercitation esse\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"http://rPwhEHACrDC.jyFyIu+0yHjpgebY8Zn4mGuJzIQIyNvgbjKlZ2aucaQJ.Xh7GOyzWx0yudlyANv8zNAmeblD\"\n },\n {\n \"chave\": \"exercitation enim reprehenderit\",\n \"criacao\": \"2020-04-01T00:00:00Z\",\n \"webhookUrl\": \"https://lmsZi.uniGK8Kf-fw.5BxFgXmTB\"\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.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "webhook" ], "query": [ { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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-arrecadacao", "item": [ { "name": "{txid}", "item": [ { "name": "Consultar cobrança de arrecadaçã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-arrecadacao/v1/cob-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "description": "(Required) " } ] }, "description": "Endpoint para consultar uma cobrança de arrecadação através de um determinado txid" }, "response": [ { "name": "Dados da cobrança", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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\": \"ut in cons\",\n \"codigoDeBarras\": \"deserunt in ut aliquip\",\n \"numeroConvenio\": \"0123\",\n \"revisao\": -46116655,\n \"status\": \"ATIVA\",\n \"txid\": \"3Ogd8S7KIdsDDKiPYZ6GOj01ZbRdl3AH\",\n \"valor\": {\n \"original\": \"3536663904.70\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"96311585642\",\n \"nome\": \"eiusmod cupidatat anim aliquip\"\n },\n \"loc\": {\n \"criacao\": \"2000-02-23T20:53:51.034Z\",\n \"id\": -92135492,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cobv\"\n },\n \"infoAdicionais\": [\n {\n \"nome\": \"proident laboris\",\n \"valor\": \"proident minim\"\n },\n {\n \"nome\": \"Excepteur aute Duis\",\n \"valor\": \"proident in ex dolore dolor\"\n }\n ],\n \"solicitacaoPagador\": \"dolor exercit\",\n \"location\": \"deserunt reprehenderit ex veniam\",\n \"pix\": [\n {\n \"endToEndId\": \"0iVJAiE9WxvXR1eALXmtSNua6AFiKmGN\",\n \"horario\": \"2008-10-27T14:53:04.362Z\",\n \"valor\": \"37.79\",\n \"txid\": \"u9BjlIlLZrxUCRw\",\n \"chave\": \"Lorem\",\n \"infoPagador\": \"ea quis\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"81983675498\",\n \"rtrId\": \"lMcuUEejBwWASq1kYmoZ5lAB76qviovr\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"2477514.11\",\n \"motivo\": \"irure laboris ad sunt\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"45996395881\",\n \"rtrId\": \"icqNh8DcIULq1msv8qimIHKUIzFKG6HZ\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"19.84\",\n \"motivo\": \"sunt aute in in sed\"\n }\n ]\n },\n {\n \"endToEndId\": \"cdkzbfqccIsfVoao6029K3iAu8FXvSSi\",\n \"horario\": \"1965-04-25T14:47:03.408Z\",\n \"valor\": \"2776.58\",\n \"txid\": \"vxXzZFddzH8XndGoa9e2zQPTMqe1ZSOZ\",\n \"chave\": \"cillum\",\n \"infoPagador\": \"non inci\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"49896141108\",\n \"rtrId\": \"WfmGh4XYmInBrW2dGyHRv06FrXkvWBQO\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"7147366471.33\",\n \"motivo\": \"laborum\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"40947916314\",\n \"rtrId\": \"AkMebOPLWUjUKmCdaIpKZtinVvWuiJ9Z\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"055.70\",\n \"motivo\": \"nulla\"\n }\n ]\n }\n ],\n \"qrCode\": \"dolore sit\"\n}" }, { "name": "Requisição com formato inválido", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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-arrecadacao/:txid?revisao=86287979", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "query": [ { "key": "revisao", "value": "86287979" } ], "variable": [ { "key": "txid", "value": "et", "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 de arrecadaçã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": "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/pix-qrcode-arrecadacao/v1/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "description": "(Required) " } ] }, "description": "Endpoint para revisar cobrança de arrecadação" }, "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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\": \"ea dolore\",\n \"codigoDeBarras\": \"ex\",\n \"numeroConvenio\": \"0123\",\n \"qrCode\": \"dolore sint deserunt ex labore\",\n \"revisao\": 31934119,\n \"status\": \"ATIVA\",\n \"txid\": \"manfTEfS3eXhjHGsybT6Ir06B1fbjlY1J0\",\n \"valor\": {\n \"original\": \"37.50\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"62988507326\",\n \"nome\": \"enim consectetur\"\n },\n \"loc\": {\n \"criacao\": \"1985-11-20T17:28:25.003Z\",\n \"id\": -61030741,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"laboris\",\n \"infoAdicionais\": [\n {\n \"nome\": \"ad Excepteur in fug\",\n \"valor\": \"volupt\"\n },\n {\n \"nome\": \"nisi sunt\",\n \"valor\": \"veniam pariatur officia deserunt\"\n }\n ],\n \"location\": \"qui consequat commodo\"\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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{baseUrl}}/cob-arrecadacao/:txid", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao", ":txid" ], "variable": [ { "key": "txid", "value": "et", "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 um registro de arrecadação", "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao/v1/cob-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "cob-arrecadacao" ] }, "description": "Endpoint para criar um registro de arrecadação. O txid correspondente será criado internamente e retornado como resultado da operação" }, "response": [ { "name": "Registro criado", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"calendario\": {\n \"expiracao\": 3600\n },\n \"chave\": \"7d9f0335-8dcc-4054-9bf9-0dbd61d36906\",\n \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao" ] } }, "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\": \"nostrud elit id\",\n \"codigoDeBarras\": \"et cupidatat\",\n \"numeroConvenio\": \"0123\",\n \"qrCode\": \"enim\",\n \"revisao\": 28305091,\n \"status\": \"REMOVIDA_PELO_USUARIO_RECEBEDOR\",\n \"txid\": \"5aWSbxSgwAXGIGKEoXtnXBsRiona\",\n \"valor\": {\n \"original\": \"97225.98\",\n \"modalidadeAlteracao\": 0\n },\n \"devedor\": {\n \"cpf\": \"00398924067\",\n \"nome\": \"qui nisi dolor minim\"\n },\n \"loc\": {\n \"criacao\": \"2006-03-17T20:44:52.390Z\",\n \"id\": 19043330,\n \"location\": \"pix.example.com/qr/v2/2353c790eefb11eaadc10242ac120002\",\n \"tipoCob\": \"cob\"\n },\n \"solicitacaoPagador\": \"eu ad\",\n \"infoAdicionais\": [\n {\n \"nome\": \"nostrud Lorem laboris\",\n \"valor\": \"qu\"\n },\n {\n \"nome\": \"ea exe\",\n \"valor\": \"magna ut voluptate dolore\"\n }\n ],\n \"location\": \"nisi commodo D\"\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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao" ] } }, "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao" ] } }, "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao" ] } }, "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 \"codigoDeBarras\": \"00000111112222233333444445555566666777778888\",\n \"numeroConvenio\": \"0123\",\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-arrecadacao", "host": [ "{{baseUrl}}" ], "path": [ "cob-arrecadacao" ] } }, "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-arrecadacao/v1/pix?cpf=97789186844&cnpj=23348010769473&txid=et&txidPresente=true&devolucaoPresente=true&inicio=2022-12-01'T'01:00:00.Z&fim=2022-12-16'T'01:00:00.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "pix" ], "query": [ { "key": "cpf", "value": "97789186844" }, { "key": "cnpj", "value": "23348010769473" }, { "key": "txid", "value": "et" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "inicio", "value": "2022-12-01'T'01:00:00.Z", "description": "(Required) " }, { "key": "fim", "value": "2022-12-16'T'01:00:00.Z", "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?cpf=97789186844&cnpj=23348010769473&txid=et&txidPresente=true&devolucaoPresente=true&inicio=yyyy-MM-dd'T'HH:mm:ss.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "cpf", "value": "97789186844" }, { "key": "cnpj", "value": "23348010769473" }, { "key": "txid", "value": "et" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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\": 28061546,\n \"paginaAtual\": 59194732,\n \"quantidadeDePaginas\": 30983165,\n \"quantidadeTotalDeItens\": 85742105\n },\n \"txid\": \"1fWnkoDgvG1QsBjz5wsm81ujoi\",\n \"txIdPresente\": true,\n \"devolucaoPresente\": true,\n \"cpf\": \"13060359805\",\n \"cnpj\": \"17143802465764\"\n },\n \"pix\": [\n {\n \"endToEndId\": \"Za6hDxOaX7notN6n581Rj43PcGaLBXCy\",\n \"horario\": \"2018-06-30T23:03:30.020Z\",\n \"valor\": \"92450.40\",\n \"txid\": \"KUT97KqVeqk8B2kkc8vGI\",\n \"chave\": \"irure deserunt esse adipis\",\n \"infoPagador\": \"aliqua commodo ad ut\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"44820661459\",\n \"rtrId\": \"FgkPd3L3dNr08eBJX85ELZaqWshPQtUn\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"504517.70\",\n \"motivo\": \"velit eu magna elit commodo\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"17136210861\",\n \"rtrId\": \"lIQaI26hDIBCjfjPDmBF8as9jGNtibyS\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"921200790.95\",\n \"motivo\": \"sed et laborum\"\n }\n ]\n },\n {\n \"endToEndId\": \"7cGYKwhtpV2rwRxGefc2wHgXmBm4nxZG\",\n \"horario\": \"1943-03-21T16:26:10.208Z\",\n \"valor\": \"19.85\",\n \"txid\": \"iYrTo2axv1FXEgEzcRkS\",\n \"chave\": \"o\",\n \"infoPagador\": \"Excepteur deserunt\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"83326783732\",\n \"rtrId\": \"f3IQXk3qZkj6m72hpsXdZ31XFuxy5AMK\",\n \"status\": \"DEVOLVIDO\",\n \"valor\": \"857.40\",\n \"motivo\": \"enim aliquip amet in\"\n },\n {\n \"horario\": {\n \"solicitacao\": {\n \"value\": \"\"\n },\n \"liquidacao\": {\n \"value\": \"\"\n }\n },\n \"id\": \"88987088170\",\n \"rtrId\": \"SGU8LhUY3kLceGJ23YgM6yXwdTCTFg8o\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"9990796076.25\",\n \"motivo\": \"enim aliquip ipsum ali\"\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?cpf=97789186844&cnpj=23348010769473&txid=et&txidPresente=true&devolucaoPresente=true&inicio=yyyy-MM-dd'T'HH:mm:ss.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "cpf", "value": "97789186844" }, { "key": "cnpj", "value": "23348010769473" }, { "key": "txid", "value": "et" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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?cpf=97789186844&cnpj=23348010769473&txid=et&txidPresente=true&devolucaoPresente=true&inicio=yyyy-MM-dd'T'HH:mm:ss.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "cpf", "value": "97789186844" }, { "key": "cnpj", "value": "23348010769473" }, { "key": "txid", "value": "et" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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?cpf=97789186844&cnpj=23348010769473&txid=et&txidPresente=true&devolucaoPresente=true&inicio=yyyy-MM-dd'T'HH:mm:ss.Z&fim=yyyy-MM-dd'T'HH:mm:ss.Z&paginacao.paginaAtual=0&paginacao.itensPorPagina=100", "host": [ "{{baseUrl}}" ], "path": [ "pix" ], "query": [ { "key": "cpf", "value": "97789186844" }, { "key": "cnpj", "value": "23348010769473" }, { "key": "txid", "value": "et" }, { "key": "txidPresente", "value": "true" }, { "key": "devolucaoPresente", "value": "true" }, { "key": "inicio", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "key": "fim", "value": "yyyy-MM-dd'T'HH:mm:ss.Z" }, { "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", "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-arrecadacao/v1/pix/:e2eid", "host": [ "{{baseUrl}}" ], "path": [ "pix-qrcode-arrecadacao", "v1", "pix", ":e2eid" ], "variable": [ { "key": "e2eid", "value": "et", "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": "et", "description": "(Required) " } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"endToEndId\": \"5XJ2SPoVRidCkP3KeA87s8vhUnZJADQ1\",\n \"horario\": \"1973-12-10T15:33:38.615Z\",\n \"valor\": \"00696.77\",\n \"txid\": \"b872tjXEGxZLqJDBHCU\",\n \"chave\": \"Excepteur do\",\n \"infoPagador\": \"qui\",\n \"devolucoes\": [\n {\n \"horario\": {\n \"solicitacao\": \"1982-11-04T23:21:36.636Z\",\n \"liquidacao\": \"1998-07-25T13:53:54.441Z\"\n },\n \"id\": \"60385524667\",\n \"rtrId\": \"dnaBTq58uzuZyzEiByrB3BNFlmfh9lZG\",\n \"status\": \"NAO_REALIZADO\",\n \"valor\": \"81394.94\",\n \"motivo\": \"veli\"\n },\n {\n \"horario\": {\n \"solicitacao\": \"2017-12-20T14:20:22.711Z\",\n \"liquidacao\": \"1992-06-28T21:45:43.284Z\"\n },\n \"id\": \"47852611439\",\n \"rtrId\": \"n5XkrQLEpFtfNT6FQ9jXAetDcdFSTpqU\",\n \"status\": \"EM_PROCESSAMENTO\",\n \"valor\": \"01.25\",\n \"motivo\": \"nostrud esse et elit\"\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": "et", "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": "et", "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": "et", "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": "et", "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}" } ] } ] } ], "variable": [ { "key": "baseUrl", "value": "https://pix-qrcode-arrecadacao-h.api.apps.banestes.b.br/api/v1", "type": "string" } ] }