{ "info": { "_postman_id": "999ee546-cca6-4e0c-abd1-705ec2650d8e", "name": "Woofi - Webservice V2", "description": "Para liberar acesso como agência, primeiramente você deve criar um nome para seu app e ativar o webservice do Woofi, no apicativo WEB, basta ir até o seu perfil e a opção de Webservice estará lá.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "45817765", "_collection_link": "https://go.postman.co/collection/45817765-999ee546-cca6-4e0c-abd1-705ec2650d8e?source=collection_link" }, "item": [ { "name": "Auth", "item": [ { "name": "Login", "event": [ { "listen": "test", "script": { "exec": [ "const response = pm.response.json();", "", "if (response.token) {", " pm.environment.set(\"token\", response.token); ", "}", "" ], "type": "text/javascript", "packages": [], "requests": [] } } ], "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "noauth" }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"agencia@exemplo.com\",\n \"password\": \"sua-senha\",\n \"device_name\": \"meu-app\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/auth/login", "host": [ "{{url}}" ], "path": [ "auth", "login" ] }, "description": "Autentica a agência e retorna um token Bearer.\n\n### Parâmetros do Body\n\n| Campo | Tipo | Descrição | Obrigatório |\n| :--- | :--- | :--- | :--- |\n| email | String | E-mail da conta | Sim |\n| password | String | Senha da conta | Sim |\n| device_name | String | Nome/rótulo do dispositivo ou app (identifica o token) | Sim |" }, "response": [ { "name": "Login Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"example@email.com\",\n \"app_name\": \"example_app\",\n \"password\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "https://portal.woo-fi.com/api/webservice/v2/auth/login", "protocol": "http", "host": [ "127", "0", "0", "1" ], "port": "8000", "path": [ "api", "webservice", "v2", "auth", "login" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"token\": \"12|aBc...tokenDeExemplo\",\n \"user\": {\n \"id\": 42,\n \"name\": \"Agência Exemplo\",\n \"email\": \"agencia@exemplo.com\",\n \"photo\": \"/user-images/image.jpeg\",\n \"phone\": \"(18) 99999-9999\",\n \"document\": \"333.333.333-33\"\n }\n}" }, { "name": "Login Failed", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"email\": \"example@email.com\",\n \"app_name\": \"example_app\",\n \"password\": \"123456\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/auth/login", "host": [ "{{url}}" ], "path": [ "auth", "login" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"message\": \"Credenciais inválidas\"\n}" } ] }, { "name": "Check User", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/auth/check-user", "host": [ "{{url}}" ], "path": [ "auth", "check-user" ] }, "description": "Esse endpoit é válido para quando queremos validar se o usuário está com o seu token válido ou não, caso sim ele retornará um 200 code e caso não, retornará um 401. A sessão sempre durará uma hora." }, "response": [ { "name": "Valid Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/auth/check-user", "host": [ "{{url}}" ], "path": [ "auth", "check-user" ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"id\": 133,\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@example.com\",\n \"phone\": \"(11) 98765-4321\",\n \"photo\": \"/user-images/example.jpeg\"\n}", "code": 200 }, { "name": "Invalid Token", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/auth/check-user", "host": [ "{{url}}" ], "path": [ "auth", "check-user" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" } ] }, { "name": "User Info", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/auth/user-info", "host": [ "{{url}}" ], "path": [ "auth", "user-info" ] } }, "response": [ { "name": "User Info", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/auth/user-info", "host": [ "{{url}}" ], "path": [ "auth", "user-info" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": 133,\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@example.com\",\n \"phone\": \"(11) 98765-4321\",\n \"photo\": \"/user-images/example.jpeg\"\n}" } ] } ] }, { "name": "Catalog", "item": [ { "name": "Operators", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/operators", "host": [ "{{url}}" ], "path": [ "operators" ] } }, "response": [ { "name": "Operators", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/operators", "host": [ "{{url}}" ], "path": [ "operators" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"id\": 14,\n \"name\": \"T-Mobile\"\n },\n {\n \"id\": 15,\n \"name\": \"WOOFI\"\n }\n]" } ] }, { "name": "Products", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/:operatorId", "host": [ "{{url}}" ], "path": [ "products", ":operatorId" ], "variable": [ { "key": "operatorId", "value": "15", "description": "Operadora para filtrar os produtos." } ] } }, "response": [ { "name": "Products", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/:operatorId", "host": [ "{{url}}" ], "path": [ "products", ":operatorId" ], "variable": [ { "key": "operatorId", "value": "15", "description": "Operadora para filtrar os produtos." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"id\": 1,\n \"name\": \"Product 1\",\n \"operator_id\": 15\n },\n {\n \"id\": 2,\n \"name\": \"Product 2\",\n \"operator_id\": 15\n }\n]" } ] }, { "name": "Product Variations", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/:productId/variations", "host": [ "{{url}}" ], "path": [ "products", ":productId", "variations" ], "variable": [ { "key": "productId", "value": "43", "description": "ID do produto." } ] } }, "response": [ { "name": "Product Variations", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/:productId/variations", "host": [ "{{url}}" ], "path": [ "products", ":productId", "variations" ], "variable": [ { "key": "productId", "value": "43", "description": "ID do produto." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"id\": 60,\n \"product_id\": 49,\n \"description\": \"5 Dias 1GB\",\n \"price\": 26.98,\n \"duration\": \"5\",\n \"region\": null\n },\n {\n \"id\": 61,\n \"product_id\": 49,\n \"description\": \"6 Dias 1GB Suiça\",\n \"price\": 40.99,\n \"duration\": \"6\",\n \"region\": \"Suiça\"\n }\n]" } ] }, { "name": "Product Prices", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/prices?operator_id=15", "host": [ "{{url}}" ], "path": [ "products", "prices" ], "query": [ { "key": "operator_id", "value": "15", "description": "Filtra por operadora (opcional)" } ] }, "description": "Lista todos os produtos e variações acessíveis à agência com seus preços.\n\n### Parâmetros de Query\n\n| Parâmetro | Tipo | Formato / Máscara | Descrição | Obrigatório |\n| :--- | :--- | :--- | :--- | :--- |\n| operator_id | Number | | Filtra por operadora | Não |" }, "response": [ { "name": "Products", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/products/prices?operator_id=15", "host": [ "{{url}}" ], "path": [ "products", "prices" ], "query": [ { "key": "operator_id", "value": "15", "description": "Filtra por operadora (opcional)" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"idProduct\": 140,\n \"description\": \"USA - COM INTERNET E LIGAÇÕES ILIMITADAS\",\n \"sequence\": 590,\n \"price\": 20,\n \"itemName\": \"30 Dias 5GB EUA\"\n }\n]" } ] } ] }, { "name": "Activations", "item": [ { "name": "Create Activation", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "170601|IImwJNWMBdlN851Ylvl6lQ1KbMIpf8GphSghc1mce09edce7", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"product_id\": 63,\n \"variation_id\": 232,\n \"activation_type\": \"esim\",\n \"activation_date\": \"2026-05-20\",\n \"client\": {\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@example.com\",\n \"phone\": \"(11) 98765-4321\",\n \"document\": \"182.177.290-34\"\n },\n \"items\": [\n {\n \"icc\": \"\",\n \"imei\": \"\",\n \"eid\": \"\",\n \"pin\": \"\",\n \"line\": \"\"\n }\n ],\n \"external_id\": \"434\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/activations", "host": [ "{{url}}" ], "path": [ "activations" ] }, "description": "Cria uma ativação (eSIM ou chip físico). Valida o payload inteiro na entrada.\n\n### Parâmetros do Body\n\n| Campo | Tipo | Obrigatório | Descrição |\n| :--- | :--- | :--- | :--- |\n| product_id | Number | Sim | Produto escolhido no catálogo |\n| variation_id | Number | Sim | Variação (plano) escolhida |\n| activation_type | String | Sim | `esim` ou `chip` |\n| activation_date | String | Sim | Data de início do plano (AAAA-MM-DD) |\n| client | Object | Sim | Dados do cliente: `name`, `email`, `phone` (obrigatórios) e `document` (opcional) |\n| items | Array | Sim | Dados do chip por item: `icc`/`imei`/`eid`/`pin`/`line` |\n| external_id | String | Não | Seu identificador para consultar a ativação depois |" }, "response": [ { "name": "Create Activation", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "{\n \"product_id\": 48,\n \"variation_id\": 1070,\n \"activation_type\": \"esim\",\n \"activation_date\": \"2026-05-10\",\n \"client\": {\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@example.com\",\n \"phone\": \"(11) 98765-4321\",\n \"document\": \"182.177.290-34\"\n },\n \"items\": [\n {\n \"icc\": \"8955...\",\n \"imei\": \"3587...\",\n \"eid\": \"8904...\",\n \"pin\": \"1234\",\n \"line\": \"11988888888\"\n }\n ],\n \"external_id\": \"434\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/activations", "host": [ "{{url}}" ], "path": [ "activations" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"message\": \"Pedido realizado com sucesso!\",\n \"order\": {\n \"id\": 25360,\n \"status\": 2,\n \"total_price\": 33.25,\n \"external_id\": \"434\",\n \"items\": [\n {\n \"id\": 25869,\n \"product_name\": \"EUROPA ILIMITADO COM 2GB\",\n \"variation_description\": \"9 Dias 2GB\",\n \"unit_price\": 33.25,\n \"icc\": null,\n \"imei\": null,\n \"imei2\": null,\n \"eid\": \"8904000000000000000\",\n \"pin\": null,\n \"line\": null,\n \"qrcode_url\": \"https://portal.woo-fi.com/qr_codes/example.png\",\n \"qr_content\": \"LPA:1$rsp.example.com$QR-G-01-ABCDEF\"\n }\n ]\n }\n}", "code": 201, "status": "Created" } ] }, { "name": "List Activations", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations?page=1", "host": [ "{{url}}" ], "path": [ "activations" ], "query": [ { "key": "page", "value": "1" } ] } }, "response": [ { "name": "List Activations", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations", "host": [ "{{url}}" ], "path": [ "activations" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"current_page\": 1,\n \"data\": [\n {\n \"id\": 1,\n \"seller_name\": null,\n \"dealer_name\": \"Dealer 1\",\n \"product\": \"Product 1\",\n \"created_at\": \"2026-05-13 10:00:00\",\n \"total_price\": 24,\n \"status\": 2\n }\n ],\n \"per_page\": 15,\n \"total\": 1,\n \"last_page\": 1\n}" } ] }, { "name": "Get one activation", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/:id", "host": [ "{{url}}" ], "path": [ "activations", ":id" ], "variable": [ { "key": "id", "value": "6767", "description": "ID da ativação ou external_id." } ] } }, "response": [ { "name": "Get one activation", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/:id", "host": [ "{{url}}" ], "path": [ "activations", ":id" ], "variable": [ { "key": "id", "value": "6767", "description": "ID da ativação ou external_id." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"id\": 25360,\n \"status\": 2,\n \"total_price\": 66.5,\n \"activation_type\": \"esim\",\n \"external_id\": \"434\",\n \"created_at\": \"2026-05-18 15:30:00\",\n \"activated_at\": \"2026-05-20 00:00:00\",\n \"client\": {\n \"name\": \"João Silva\",\n \"email\": \"joao.silva@example.com\",\n \"phone\": \"(11) 98765-4321\",\n \"document\": \"182.177.290-34\"\n },\n \"items\": [\n {\n \"id\": 25869,\n \"product_name\": \"EUROPA ILIMITADO COM 2GB\",\n \"variation_description\": \"9 Dias 2GB\",\n \"unit_price\": 33.25,\n \"icc\": \"8955...\",\n \"imei\": \"3587...\",\n \"eid\": \"8904...\",\n \"pin\": \"1234\",\n \"line\": \"11988888888\",\n \"qrcode_url\": \"https://beta.woo-fi.com/storage/qrcodes/ex.png\",\n \"imei2\": null,\n \"qr_content\": \"LPA:1$rsp.example.com$QR-G-01-ABCDEF\"\n }\n ]\n}", "code": 200 } ] }, { "name": "Cancel Activation", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "170604|TQoyeCrCFFlhoXWaMGLtNdFVRWWohruGvWROHzig7daa621e", "type": "string" } ] }, "method": "POST", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/cancel/:id", "host": [ "{{url}}" ], "path": [ "activations", "cancel", ":id" ], "variable": [ { "key": "id", "value": "9431", "description": "ID da ativação a cancelar." } ] } }, "response": [ { "name": "Cancel Activation", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/cancel/:id", "host": [ "{{url}}" ], "path": [ "activations", "cancel", ":id" ], "variable": [ { "key": "id", "value": "9431", "description": "ID da ativação a cancelar." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"message\": \"Ativação cancelada com sucesso.\"\n}", "code": 200 } ] }, { "name": "Consumo por Pedido", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/order/:orderId", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "order", ":orderId" ], "variable": [ { "key": "orderId", "value": "434", "description": "ID interno ou external_id do pedido." } ] }, "description": "Consulta o consumo dos chips de um pedido. Todos os volumes vêm em **MB**. Em planos ilimitados, `unlimited=true` e franquia/saldo/percentual vêm `null`.\n\n> [!IMPORTANT]\n> Recurso restrito: a agência precisa ter a **consulta de consumo habilitada** (`allow_consumption_query`). Sem a permissão, a resposta é `403`.\n\nO `{orderId}` aceita o **id interno** ou o **external_id** do pedido.\n\n### Resposta\n\n| Campo | Tipo | Descrição |\n| :--- | :--- | :--- |\n| order_id | Number | ID interno do pedido |\n| external_id | String | Seu identificador do pedido (`external_id`) |\n| activation_type | String | `esim` ou `chip` |\n| chips | Array | Lista de chips do pedido com o consumo (campos abaixo) |\n| sequence | Number | ID do item (chip) no pedido |\n| identifier | String | ICC, EID ou IMEI2 usado na consulta (`null` se indisponível) |\n| available | Boolean | Indica se o consumo pôde ser consultado |\n| unlimited | Boolean | Plano ilimitado; quando `true`, `allowance_mb`, `remaining_mb` e `usage_percentage` vêm `null` |\n| total_used_mb | Number | Total consumido no ciclo, em MB |\n| allowance_mb | Number | Franquia do plano, em MB (`null` quando ilimitado) |\n| remaining_mb | Number | Saldo restante, em MB (`null` quando ilimitado) |\n| usage_percentage | Number | Percentual utilizado (`null` quando ilimitado) |\n| last_usage_at | String | Data do último consumo registrado (AAAA-MM-DD) |\n| fetched_at | String | Instante da consulta (ISO 8601) |\n| history | Array | Consumo diário do ciclo |\n| date | String | Dia do consumo no histórico (AAAA-MM-DD) |\n| used_mb | Number | Consumo do dia, em MB |\n| message | String | Presente apenas quando `available=false`; explica o motivo da indisponibilidade |\n" }, "response": [ { "name": "Consumo por Pedido", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/order/:orderId", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "order", ":orderId" ], "variable": [ { "key": "orderId", "value": "434", "description": "ID interno ou external_id do pedido." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"Consumo consultado com sucesso.\",\n \"data\": {\n \"order_id\": 25360,\n \"external_id\": \"434\",\n \"activation_type\": \"chip\",\n \"chips\": [\n {\n \"sequence\": 25869,\n \"identifier\": \"8955010012345678909\",\n \"available\": true,\n \"unlimited\": false,\n \"total_used_mb\": 3584,\n \"allowance_mb\": 5120,\n \"remaining_mb\": 1536,\n \"usage_percentage\": 70,\n \"last_usage_at\": \"2026-09-21\",\n \"fetched_at\": \"2026-09-22T13:40:05-03:00\",\n \"history\": [\n {\n \"date\": \"2026-09-21\",\n \"used_mb\": 820\n },\n {\n \"date\": \"2026-09-20\",\n \"used_mb\": 640\n }\n ]\n },\n {\n \"sequence\": 25870,\n \"identifier\": \"355000000000000\",\n \"available\": true,\n \"unlimited\": true,\n \"total_used_mb\": 12480,\n \"allowance_mb\": null,\n \"remaining_mb\": null,\n \"usage_percentage\": null,\n \"last_usage_at\": \"2026-09-22\",\n \"fetched_at\": \"2026-09-22T13:40:05-03:00\",\n \"history\": [\n {\n \"date\": \"2026-09-22\",\n \"used_mb\": 1500\n }\n ]\n }\n ]\n }\n}", "code": 200 }, { "name": "Sem permissão", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/order/:orderId", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "order", ":orderId" ], "variable": [ { "key": "orderId", "value": "434", "description": "ID interno ou external_id do pedido." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"error\",\n \"message\": \"Funcionalidade não habilitada para esta agência.\",\n \"data\": []\n}", "code": 403 } ] }, { "name": "Consumo por Chip", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/chip/:identifier", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "chip", ":identifier" ], "variable": [ { "key": "identifier", "value": "8955010012345678909", "description": "ICC, EID, IMEI2 ou número da linha." } ] }, "description": "Consulta o consumo de um único chip. Todos os volumes vêm em **MB**. Em planos ilimitados, `unlimited=true` e franquia/saldo/percentual vêm `null`.\n\n> [!IMPORTANT]\n> Recurso restrito: a agência precisa ter a **consulta de consumo habilitada** (`allow_consumption_query`). Sem a permissão, a resposta é `403`.\n\nO chip é resolvido pelo **ICC**, **EID**, **IMEI2** ou **número da linha**, sempre dentro do escopo da agência autenticada. Havendo mais de um item para o mesmo identificador, vence o mais recente.\n\n### Resposta\n\n| Campo | Tipo | Descrição |\n| :--- | :--- | :--- |\n| order_id | Number | ID interno do pedido |\n| external_id | String | Seu identificador do pedido (`external_id`) |\n| activation_type | String | `esim` ou `chip` |\n| chip | Object | Consumo do chip (campos abaixo) |\n| sequence | Number | ID do item (chip) no pedido |\n| identifier | String | ICC, EID ou IMEI2 usado na consulta (`null` se indisponível) |\n| available | Boolean | Indica se o consumo pôde ser consultado |\n| unlimited | Boolean | Plano ilimitado; quando `true`, `allowance_mb`, `remaining_mb` e `usage_percentage` vêm `null` |\n| total_used_mb | Number | Total consumido no ciclo, em MB |\n| allowance_mb | Number | Franquia do plano, em MB (`null` quando ilimitado) |\n| remaining_mb | Number | Saldo restante, em MB (`null` quando ilimitado) |\n| usage_percentage | Number | Percentual utilizado (`null` quando ilimitado) |\n| last_usage_at | String | Data do último consumo registrado (AAAA-MM-DD) |\n| fetched_at | String | Instante da consulta (ISO 8601) |\n| history | Array | Consumo diário do ciclo |\n| date | String | Dia do consumo no histórico (AAAA-MM-DD) |\n| used_mb | Number | Consumo do dia, em MB |\n| message | String | Presente apenas quando `available=false`; explica o motivo da indisponibilidade |\n" }, "response": [ { "name": "Consumo por Chip", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/chip/:identifier", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "chip", ":identifier" ], "variable": [ { "key": "identifier", "value": "8955010012345678909", "description": "ICC, EID ou IMEI2 do chip." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"success\",\n \"message\": \"Consumo consultado com sucesso.\",\n \"data\": {\n \"order_id\": 25360,\n \"external_id\": \"434\",\n \"activation_type\": \"chip\",\n \"chip\": {\n \"sequence\": 25869,\n \"identifier\": \"8955010012345678909\",\n \"available\": true,\n \"unlimited\": false,\n \"total_used_mb\": 3584,\n \"allowance_mb\": 5120,\n \"remaining_mb\": 1536,\n \"usage_percentage\": 70,\n \"last_usage_at\": \"2026-09-21\",\n \"fetched_at\": \"2026-09-22T13:40:05-03:00\",\n \"history\": [\n {\n \"date\": \"2026-09-21\",\n \"used_mb\": 820\n },\n {\n \"date\": \"2026-09-20\",\n \"used_mb\": 640\n }\n ]\n }\n }\n}", "code": 200 }, { "name": "Sem permissão", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/activations/consumption/chip/:identifier", "host": [ "{{url}}" ], "path": [ "activations", "consumption", "chip", ":identifier" ], "variable": [ { "key": "identifier", "value": "8955010012345678909", "description": "ICC, EID ou IMEI2 do chip." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": \"error\",\n \"message\": \"Funcionalidade não habilitada para esta agência.\",\n \"data\": []\n}", "code": 403 } ] }, { "name": "Get Tax", "protocolProfileBehavior": { "disableBodyPruning": true, "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/get-tax/:uf", "host": [ "{{url}}" ], "path": [ "get-tax", ":uf" ], "variable": [ { "key": "uf", "value": "sp", "description": "Sigla do estado (UF)." } ] } }, "response": [ { "name": "Get Tax", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/get-tax/:uf", "host": [ "{{url}}" ], "path": [ "get-tax", ":uf" ], "variable": [ { "key": "uf", "value": "sp", "description": "Sigla do estado (UF)." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"sedex\": 13,\n \"pac\": 5.9\n}" } ] }, { "name": "Check ICC", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{url}}/order/checkIcc/:icc", "host": [ "{{url}}" ], "path": [ "order", "checkIcc", ":icc" ], "variable": [ { "key": "icc", "value": "8955000000000000000", "description": "ICC do chip a verificar." } ] } }, "response": [ { "name": "check icc", "originalRequest": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{url}}/order/checkIcc/:icc", "host": [ "{{url}}" ], "path": [ "order", "checkIcc", ":icc" ], "variable": [ { "key": "icc", "value": "8955000000000000000", "description": "ICC do chip a verificar." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json", "type": "text" } ], "cookie": [], "body": "{\n \"exists\": true\n}" } ] } ] }, { "name": "Credit", "item": [ { "name": "Current Balance", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/current-balance", "host": [ "{{url}}" ], "path": [ "current-balance" ] } }, "response": [ { "name": "Current Balance", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/current-balance", "host": [ "{{url}}" ], "path": [ "current-balance" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"current_balance\": 8661.15\n}" } ] }, { "name": "Credit History", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/credit-history", "host": [ "{{url}}" ], "path": [ "credit-history" ] } }, "response": [ { "name": "Credit History", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/credit-history", "host": [ "{{url}}" ], "path": [ "credit-history" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"id\": 1201,\n \"created_at\": \"2026-07-16 18:21:00\",\n \"amount\": 5,\n \"status\": \"Aprovado\",\n \"gateway\": \"Stripe\"\n }\n]" } ] }, { "name": "Credit Statement", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/statement?initial_date=2026-07-01&final_date=2026-07-31", "host": [ "{{url}}" ], "path": [ "statement" ], "query": [ { "key": "initial_date", "value": "2026-07-01", "description": "Início do período (YYYY-MM-DD, opcional)" }, { "key": "final_date", "value": "2026-07-31", "description": "Fim do período (YYYY-MM-DD, opcional)" }, { "key": "status", "value": "Aprovado", "description": "Filtro de status (opcional)", "disabled": true }, { "key": "per_page", "value": "15", "description": "Itens por página (opcional)", "disabled": true } ] }, "description": "Retorna o extrato de vendas e débitos de ativações do período.\n\n### Parâmetros de Query\n\n| Parâmetro | Tipo | Formato / Máscara | Descrição | Obrigatório |\n| :--- | :--- | :--- | :--- | :--- |\n| initial_date | String | YYYY-MM-DD | Início do período (padrão: mês atual) | Não |\n| final_date | String | YYYY-MM-DD | Fim do período (padrão: mês atual) | Não |\n| status | String | | Filtro de status (ex.: Aprovado, all) | Não |\n| per_page | Number | | Itens por página (máx. 100, padrão 15) | Não |" }, "response": [ { "name": "Current Balance", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/statement?initial_date=2026-07-01&final_date=2026-07-31", "host": [ "{{url}}" ], "path": [ "statement" ], "query": [ { "key": "initial_date", "value": "2026-07-01", "description": "Início do período (YYYY-MM-DD, opcional)" }, { "key": "final_date", "value": "2026-07-31", "description": "Fim do período (YYYY-MM-DD, opcional)" }, { "key": "status", "value": "Aprovado", "description": "Filtro de status (opcional)", "disabled": true }, { "key": "per_page", "value": "15", "description": "Itens por página (opcional)", "disabled": true } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"summary\": {\n \"total_sales_count\": 2,\n \"total_sales_amount\": 135,\n \"period_start\": \"2026-07-01\",\n \"period_end\": \"2026-07-31\"\n },\n \"data\": [\n {\n \"id\": 1541,\n \"order_id\": 3021,\n \"date\": \"2026-07-26T10:15:00-03:00\",\n \"amount\": 45,\n \"description\": \"Débito ref. Ativação de Pedido #3021\",\n \"status\": \"Aprovado\"\n }\n ],\n \"meta\": {\n \"current_page\": 1,\n \"per_page\": 15,\n \"total\": 2,\n \"last_page\": 1\n }\n}" } ] }, { "name": "Create Charge", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"payment_type\": \"stripe\",\n \"amount\": 100,\n \"instalments\": 1\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/charge", "host": [ "{{url}}" ], "path": [ "charge" ] }, "description": "Gera uma cobrança para recarregar a carteira.\n\nPara **Stripe**, a resposta traz `stripe_url` (link de checkout). Para **Ebanx**, informe `method` e, em cartão, os campos `card_*`.\n\n### Parâmetros do Body\n\n| Campo | Tipo | Descrição | Obrigatório |\n| :--- | :--- | :--- | :--- |\n| payment_type | String | Gateway: `stripe` ou `ebanx` | Sim |\n| amount | Number | Valor da recarga (respeita o mínimo do gateway) | Sim |\n| instalments | Number | Parcelas (1 a 12) | Não |\n| method | String | Ebanx: `pix` ou `creditcard` | Não |\n| card_name | String | Nome no cartão (Ebanx creditcard) | Não |\n| card_number | String | Número do cartão (Ebanx creditcard) | Não |\n| card_expiry | String | Validade MM/AA (Ebanx creditcard) | Não |\n| card_cvv | String | CVV (Ebanx creditcard) | Não |" }, "response": [ { "name": "Stripe", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"price\": 98.90,\n \"finalPrice\": 100.98,\n \"typePayment\": \"stripe\",\n \"type\": \"\",\n \"name\": \"\",\n \"card_name\": \"\",\n \"card_number\": \"\",\n \"expiration\": \"\",\n \"card_cvv\": \"\",\n \"country\": \"\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/charge", "host": [ "{{url}}" ], "path": [ "charge" ] } }, "_postman_previewlanguage": "json", "header": [], "cookie": [], "body": "{\n \"stripe_url\": \"https://checkout.stripe.com/pay/cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX\"\n}", "code": 200 }, { "name": "PIX", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"price\": 98.90,\n \"finalPrice\": 100.98,\n \"typePayment\": \"ebanx\",\n \"type\": \"pix\",\n \"name\": \"People Name\",\n \"card_name\": \"\",\n \"card_number\": \"\",\n \"expiration\": \"\",\n \"card_cvv\": \"\",\n \"country\": \"Brasil\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/charge", "host": [ "{{url}}" ], "path": [ "charge" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Ebanx", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"price\": 98.90,\n \"finalPrice\": 100.98,\n \"typePayment\": \"ebanx\",\n \"type\": \"creditcard\",\n \"name\": \"People Name\",\n \"card_name\": \"People Name\",\n \"card_number\": \"4444 4444 4444 4444\",\n \"expiration\": \"01/34\",\n \"card_cvv\": \"111\",\n \"country\": \"México\"\n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/charge", "host": [ "{{url}}" ], "path": [ "charge" ] } }, "_postman_previewlanguage": "Text", "header": [], "cookie": [], "body": "" }, { "name": "Response", "originalRequest": { "method": "POST", "header": [], "body": { "mode": "raw", "raw": "{\n \"price\": 98.90,\n \"finalPrice\": 112.11,\n \"typePayment\": \"ebanx\",\n \"type\": \"pix\",\n \"name\": \"People Name\",\n \"card_name\": \"People Card Name\",\n \"card_number\": \"4444 4444 4444 4444\",\n \"expiration\": \"01/34\",\n \"card_cvv\": \"111\",\n \"country\": \"Brasil\" \n}", "options": { "raw": { "language": "json" } } }, "url": { "raw": "{{url}}/charge", "host": [ "{{url}}" ], "path": [ "charge" ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"message\": \"Pedido realizado com sucesso!\",\n \"status\": \"success\",\n \"data\": {\n \"resp\": {\n \"price\": \"98.9\",\n \"finalPrice\": 112.11,\n \"typePayment\": \"ebanx\",\n \"type\": \"pix\",\n \"name\": \"People Name\",\n \"card_name\": \"People Card Name\",\n \"card_number\": \"4444 4444 4444 4444\",\n \"expiration\": \"01/34\",\n \"card_cvv\": \"111\",\n \"country\": \"Brasil\",\n \"idUser\": 1,\n \"idDealer\": 1,\n \"people\": {\n \"idPeople\": 1,\n \"name\": \"People Name\",\n \"birthdate\": \"2023-06-14\",\n \"email\": \"example@email.com\",\n \"phone\": \"(22) 222222-2222\",\n \"cpfCnpj\": \"333.333.333-33\",\n \"zipCode\": \"111111-1111\",\n \"address\": \"Rua de exemplo\",\n \"number\": \"123\",\n \"neighborhood\": \"Bairro de exemplo\",\n \"photo\": \"\",\n \"active\": 1,\n \"juridical\": 1,\n \"created_at\": null,\n \"updated_at\": null,\n \"responsible\": \"Pessoa\",\n \"phone_responsible\": \"(11) 11111-1111\",\n \"userActive\": 1,\n \"idUf\": null,\n \"idCity\": null,\n \"city_name\": \"Catanduva\",\n \"uf_name\": \"SP\",\n \"ip\": null\n },\n \"payment_id\": \"818192839280192381231\",\n \"ebanx_status\": \"1\"\n },\n \"payment\": {\n \"status\": 200,\n \"phrase\": \"OK\",\n \"body\": {\n \"hash\": \"akhsdkjahdgakjhdgasdjkshadgkjahda\",\n \"country\": \"br\",\n \"merchant_payment_code\": \"1231231_121312\",\n \"order_number\": null,\n \"status\": \"11\",\n \"status_date\": null,\n \"open_date\": \"2024-05-20 17:03:08\",\n \"confirm_date\": null,\n \"transfer_date\": null,\n \"amount_br\": \"656.08\",\n \"amount_ext\": \"112.11\",\n \"amount_iof\": \"2.48\",\n \"currency_rate\": \"5.8300\",\n \"currency_ext\": \"USD\",\n \"due_date\": \"2024-05-20\",\n \"instalments\": \"1\",\n \"payment_type_code\": \"pix\",\n \"redirect_url\": \"\",\n \"pre_approved\": false,\n \"capture_available\": null,\n \"pix\": {\n \"qr_code_value\": \"\"\n }\n },\n \"body_status\": \"1\"\n }\n },\n \"redirect\": \"\",\n \"class\": \"alert-success\"\n}" } ] }, { "name": "Check Stripe success", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{url}}/charge/stripe/check-success?session_id=cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX", "host": [ "{{url}}" ], "path": [ "charge", "stripe", "check-success" ], "query": [ { "key": "session_id", "value": "cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX", "description": "ID da sessão de checkout da Stripe (o cs_... da URL retornada pelo charge)." } ] }, "description": "Confirma o resultado de um pagamento Stripe pela sessão de checkout.\n\n### Parâmetros de Query\n\n| Parâmetro | Tipo | Formato / Máscara | Descrição | Obrigatório |\n| :--- | :--- | :--- | :--- | :--- |\n| session_id | String | cs_... | ID da sessão de checkout retornada pelo `charge` | Sim |" }, "response": [ { "name": "Check Stripe success", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{url}}/charge/stripe/check-success?session_id=cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX", "host": [ "{{url}}" ], "path": [ "charge", "stripe", "check-success" ], "query": [ { "key": "session_id", "value": "cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX", "description": "ID da sessão de checkout da Stripe (o cs_... da URL retornada pelo charge)." } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"status\": true\n}" } ] }, { "name": "Last Stripe ID", "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [], "url": { "raw": "{{url}}/charge/stripe/last-id", "host": [ "{{url}}" ], "path": [ "charge", "stripe", "last-id" ] } }, "response": [ { "name": "Last Stripe ID", "originalRequest": { "method": "GET", "header": [], "url": { "raw": "{{url}}/charge/stripe/last-id", "host": [ "{{url}}" ], "path": [ "charge", "stripe", "last-id" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"payment_id\": \"cs_test_a1Zj2XFnQGzd0PaeXxtBcByyD16r9fi6vPaX22bwUVY0Tu5q8SUU2JliCX\"\n}" } ] } ] }, { "name": "Dashboard", "item": [ { "name": "Summary", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/summary?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "summary" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "response": [ { "name": "Info Values", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/summary?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "summary" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"current_balance\": 8661.15,\n \"total_activations\": 696.12\n}" } ] }, { "name": "Top Sellers", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/top-sellers?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "top-sellers" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "response": [ { "name": "Top Sellers", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/top-sellers?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "top-sellers" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"name\": \"Seller 1\",\n \"total_amount\": 380.64\n },\n {\n \"name\": \"Seller 2\",\n \"total_amount\": 200.64\n }\n]" } ] }, { "name": "Top Activations", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/top-activations?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "top-activations" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "response": [ { "name": "Top Activations", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/top-activations?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "top-activations" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"seller_name\": \"Seller 1\",\n \"dealer_name\": \"Dealer 1\",\n \"total_amount\": 356.64\n }\n]" } ] }, { "name": "Activations by Status", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/activations-by-status?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "activations-by-status" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "response": [ { "name": "Activations Month", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/activations-by-status?month=05&year=2026", "host": [ "{{url}}" ], "path": [ "dealer", "activations-by-status" ], "query": [ { "key": "month", "value": "05" }, { "key": "year", "value": "2026" } ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "[\n {\n \"status\": \"Aberto\",\n \"color\": \"#F87315\",\n \"total\": 3,\n \"percentage\": 75\n },\n {\n \"status\": \"Concluído\",\n \"color\": \"#069668\",\n \"total\": 1,\n \"percentage\": 25\n }\n]" } ] }, { "name": "Sellers", "protocolProfileBehavior": { "disabledSystemHeaders": { "accept": true } }, "request": { "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/sellers", "host": [ "{{url}}" ], "path": [ "dealer", "sellers" ] } }, "response": [ { "name": "Sellers", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json", "type": "text" } ], "url": { "raw": "{{url}}/dealer/sellers", "host": [ "{{url}}" ], "path": [ "dealer", "sellers" ] } }, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "name": "Content-Type", "value": "application/json", "description": "", "type": "text" } ], "cookie": [], "body": "{\n \"data\": [\n {\n \"name\": \"Seller 1\",\n \"email\": \"seller1@email.com\",\n \"total_sales_amount\": 421.64,\n \"estimated_commission\": 42.16\n }\n ],\n \"meta\": {\n \"total_active_sellers\": 2\n }\n}" } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{token}}", "type": "string" } ] }, "event": [ { "listen": "prerequest", "script": { "type": "text/javascript", "requests": [], "exec": [ "" ] } }, { "listen": "test", "script": { "type": "text/javascript", "requests": [], "exec": [ "" ] } } ], "variable": [ { "key": "token", "value": "" }, { "key": "url", "value": "" } ] }