{
  "info": {
    "name": "Mepagg API v1",
    "_postman_id": "c30de1d7-6fb7-4d30-9994-0f9a0fa3d001",
    "description": "Colecao publica principal da API Mepagg, alinhada com a documentacao humana e com a OpenAPI. Use os exemplos como ponto de partida para clientes, faturas, assinaturas, planos, carnes, consultas de transferencias, extrato, SMS, dados da conta e webhooks.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://app.mepagg.com"
    },
    {
      "key": "api_key",
      "value": "SUA_CHAVE_DE_API"
    },
    {
      "key": "idempotency_key",
      "value": "operacao-unica-001"
    },
    {
      "key": "customer_reference_id",
      "value": "CUST_EXAMPLE_001"
    },
    {
      "key": "invoice_reference_id",
      "value": "GLZOX8K19Q40NVLJ6WJ2PRYD7EV653"
    },
    {
      "key": "subscription_reference_id",
      "value": "SUB_A1B2C3"
    },
    {
      "key": "carne_reference_id",
      "value": "CAR_01JABCXYZ"
    },
    {
      "key": "transfer_reference_id",
      "value": "TRF_EXAMPLE_001"
    },
    {
      "key": "webhook_endpoint_id",
      "value": "12"
    },
    {
      "key": "subscription_plan_reference_id",
      "value": "PLAN_01JABCXYZ"
    }
  ],
  "item": [
    {
      "name": "Clientes",
      "description": "Cadastro, consulta, atualizacao e remocao de clientes.",
      "item": [
        {
          "name": "Listar clientes",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/customers/?limit=20&offset=0"
          }
        },
        {
          "name": "Criar cliente",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Cliente Exemplo Integracoes LTDA\",\n  \"document\": \"12345678000195\",\n  \"email_primary\": \"financeiro@clienteexemplo.com.br\",\n  \"email_secondary\": \"cobranca@clienteexemplo.com.br\",\n  \"phone_number\": \"11987654321\",\n  \"street\": \"Avenida Exemplo\",\n  \"neighborhood\": \"Jardim Modelo\",\n  \"number\": \"100\",\n  \"zipcode\": \"01311000\",\n  \"city\": \"Sao Paulo\",\n  \"state\": \"SP\",\n  \"observation\": \"Cliente criado pela integracao.\"\n}"
            },
            "url": "{{base_url}}/api/v1/customers/"
          }
        },
        {
          "name": "Detalhar cliente",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/customers/{{customer_reference_id}}/"
          }
        },
        {
          "name": "Atualizar parcialmente cliente",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"email_primary\": \"financeiro.atualizado@clienteexemplo.com.br\",\n  \"phone_number\": \"11999990000\",\n  \"observation\": \"Cadastro atualizado pelo ERP.\"\n}"
            },
            "url": "{{base_url}}/api/v1/customers/{{customer_reference_id}}/"
          }
        },
        {
          "name": "Substituir cliente",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Cliente Exemplo Integracoes LTDA\",\n  \"document\": \"12345678000195\",\n  \"email_primary\": \"financeiro@clienteexemplo.com.br\",\n  \"email_secondary\": \"cobranca@clienteexemplo.com.br\",\n  \"phone_number\": \"11987654321\",\n  \"street\": \"Avenida Exemplo\",\n  \"neighborhood\": \"Jardim Modelo\",\n  \"number\": \"100\",\n  \"zipcode\": \"01311000\",\n  \"city\": \"Sao Paulo\",\n  \"state\": \"SP\",\n  \"observation\": \"Cadastro substituido integralmente pela integracao.\"\n}"
            },
            "url": "{{base_url}}/api/v1/customers/{{customer_reference_id}}/"
          }
        },
        {
          "name": "Remover cliente",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/customers/{{customer_reference_id}}/"
          }
        }
      ]
    },
    {
      "name": "Faturas",
      "description": "Cobrancas avulsas com boleto, Pix ou ambos.",
      "item": [
        {
          "name": "Listar faturas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/invoices/?limit=20&offset=0&customer_reference_id={{customer_reference_id}}"
          }
        },
        {
          "name": "Criar fatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer_reference_id\": \"{{customer_reference_id}}\",\n  \"due_date\": \"2026-06-30\",\n  \"payment_methods\": [\"boleto\", \"pix\"],\n  \"fees\": \"1.50\",\n  \"fines\": \"2.00\",\n  \"discount_type\": \"FIXED_VALUE\",\n  \"discount\": \"10.00\",\n  \"inter_boleto_num_dias_agenda\": 3,\n  \"items\": [\n    {\n      \"description\": \"Mensalidade da plataforma\",\n      \"quantity\": 1,\n      \"price\": \"120.00\"\n    },\n    {\n      \"description\": \"Implantacao inicial\",\n      \"qty\": 2,\n      \"price\": \"35.00\"\n    }\n  ]\n}"
            },
            "url": "{{base_url}}/api/v1/invoices/"
          }
        },
        {
          "name": "Detalhar fatura",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/"
          }
        },
        {
          "name": "Cancelar fatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"cancelled_reason\": \"Cobranca substituida por nova emissao.\"\n}"
            },
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/cancel/"
          }
        },
        {
          "name": "Solicitar estorno",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"refund_reason\": \"Pagamento recebido em duplicidade.\"\n}"
            },
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/refund/"
          }
        },
        {
          "name": "Consultar segunda via",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/second-copy/"
          }
        },
        {
          "name": "Reenviar e-mail da fatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/resend-email/"
          }
        },
        {
          "name": "Reenviar SMS da fatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/invoices/{{invoice_reference_id}}/resend-sms/"
          }
        }
      ]
    },
    {
      "name": "Assinaturas",
      "description": "Recorrencias da conta autenticada.",
      "item": [
        {
          "name": "Listar assinaturas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/subscriptions/?limit=20&offset=0"
          }
        },
        {
          "name": "Criar assinatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer_reference_id\": \"{{customer_reference_id}}\",\n  \"interval\": \"MONTHLY\",\n  \"cycles\": 12,\n  \"last_due_date\": \"2027-06-10\",\n  \"status\": \"ACTIVE\",\n  \"payment_methods\": [\"boleto\", \"pix\"],\n  \"fees\": \"1.00\",\n  \"fines\": \"2.00\",\n  \"discount_type\": \"FIXED_VALUE\",\n  \"discount\": \"10.00\",\n  \"items\": [\n    {\n      \"description\": \"Licenca principal\",\n      \"qty\": 1,\n      \"price\": \"49.90\"\n    },\n    {\n      \"description\": \"Usuario adicional\",\n      \"quantity\": 2,\n      \"price\": \"15.00\"\n    }\n  ]\n}"
            },
            "url": "{{base_url}}/api/v1/subscriptions/"
          }
        },
        {
          "name": "Detalhar assinatura",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/subscriptions/{{subscription_reference_id}}/"
          }
        },
        {
          "name": "Alterar status da assinatura",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"status\": \"SUSPENDED\"\n}"
            },
            "url": "{{base_url}}/api/v1/subscriptions/{{subscription_reference_id}}/status/"
          }
        }
      ]
    },
    {
      "name": "Planos",
      "description": "Planos de assinatura reutilizaveis da conta autenticada.",
      "item": [
        {
          "name": "Listar planos",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/subscription-plans/?limit=20&offset=0"
          }
        },
        {
          "name": "Criar plano",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Mensalidade hospedagem\",\n  \"amount\": \"85.00\",\n  \"interval\": \"MONTHLY\",\n  \"fees\": \"1.00\",\n  \"fines\": \"2.00\",\n  \"discount_type\": \"FIXED_VALUE\",\n  \"discount\": \"5.00\",\n  \"inter_boleto_num_dias_agenda\": 3,\n  \"payment_method_ids\": [1, 2],\n  \"is_active\": true\n}"
            },
            "url": "{{base_url}}/api/v1/subscription-plans/"
          }
        },
        {
          "name": "Detalhar plano",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/subscription-plans/{{subscription_plan_reference_id}}/"
          }
        },
        {
          "name": "Atualizar plano",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Mensalidade hospedagem Premium\",\n  \"amount\": \"95.00\",\n  \"interval\": \"MONTHLY\",\n  \"fees\": \"1.00\",\n  \"fines\": \"2.00\",\n  \"discount_type\": \"FIXED_VALUE\",\n  \"discount\": \"5.00\",\n  \"inter_boleto_num_dias_agenda\": 3,\n  \"payment_method_ids\": [1, 2],\n  \"is_active\": true\n}"
            },
            "url": "{{base_url}}/api/v1/subscription-plans/{{subscription_plan_reference_id}}/"
          }
        },
        {
          "name": "Atualizar parcialmente plano",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"amount\": \"95.00\",\n  \"is_active\": true\n}"
            },
            "url": "{{base_url}}/api/v1/subscription-plans/{{subscription_plan_reference_id}}/"
          }
        },
        {
          "name": "Remover plano",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/subscription-plans/{{subscription_plan_reference_id}}/"
          }
        }
      ]
    },
    {
      "name": "Carnes",
      "description": "Carnes com parcelas retornadas como faturas detalhadas.",
      "item": [
        {
          "name": "Listar carnes",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/carnes/?limit=20&offset=0"
          }
        },
        {
          "name": "Criar carne",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"customer_reference_id\": \"{{customer_reference_id}}\",\n  \"description\": \"Carne de implantacao e licenca\",\n  \"installments\": 3,\n  \"due_date\": \"2026-07-10\",\n  \"payment_methods\": [\"boleto\", \"pix\"],\n  \"fees\": \"1.00\",\n  \"fines\": \"2.00\",\n  \"discount_type\": \"PERCENTAGE\",\n  \"discount\": \"5.00\",\n  \"items\": [\n    {\n      \"description\": \"Implantacao inicial\",\n      \"quantity\": 1,\n      \"price\": \"120.00\"\n    }\n  ]\n}"
            },
            "url": "{{base_url}}/api/v1/carnes/"
          }
        },
        {
          "name": "Detalhar carne",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/carnes/{{carne_reference_id}}/"
          }
        },
        {
          "name": "Cancelar carne",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"cancelled_reason\": \"Solicitado pelo cliente.\"\n}"
            },
            "url": "{{base_url}}/api/v1/carnes/{{carne_reference_id}}/cancel/"
          }
        },
        {
          "name": "Enviar carne por e-mail",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/carnes/{{carne_reference_id}}/send-email/"
          }
        }
      ]
    },
    {
      "name": "Links de pagamentos",
      "description": "Criacao e consulta de links de pagamento com checkout publico Mepagg.",
      "item": [
        {
          "name": "Listar links de pagamento",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/payment-links/?status=active&limit=20&offset=0"
          }
        },
        {
          "name": "Criar link de pagamento",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"description\": \"Link sem vencimento para adesao\",\n  \"link_type\": \"fixed\",\n  \"amount\": \"249.90\",\n  \"due_option\": \"none\",\n  \"invoice_due_option\": \"20_days\",\n  \"usage_limit_mode\": \"limited\",\n  \"usage_limit\": 3,\n  \"payment_methods\": [\"pix\"]\n}"
            },
            "url": "{{base_url}}/api/v1/payment-links/"
          }
        },
        {
          "name": "Detalhar link de pagamento",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/payment-links/{{payment_link_public_token}}/"
          }
        }
      ]
    },
    {
      "name": "Transferencias",
      "description": "Transferencias Pix da conta autenticada.",
      "item": [
        {
          "name": "Listar transferencias",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/transfers/?limit=20&offset=0"
          }
        },
        {
          "name": "Consultar tarifacao de transferencias",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/transfers/pricing/"
          }
        },
        {
          "name": "Listar chaves Pix disponiveis",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/transfers/pix-keys/"
          }
        },
        {
          "name": "Detalhar transferencia",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/transfers/{{transfer_reference_id}}/"
          }
        },
        {
          "name": "Consultar recibo",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/transfers/{{transfer_reference_id}}/receipt/"
          }
        }
      ]
    },
    {
      "name": "Extrato e Dashboard",
      "description": "Consultas financeiras e operacionais da conta.",
      "item": [
        {
          "name": "Consultar extrato",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/statement/?start_date=2026-06-01&end_date=2026-06-30&limit=20&offset=0"
          }
        },
        {
          "name": "Consultar resumo financeiro",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/statement/summary/?start_date=2026-06-01&end_date=2026-06-30"
          }
        },
        {
          "name": "Consultar dashboard overview",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/overview/?overview_month=2026-06"
          }
        },
        {
          "name": "Consultar widgets do dashboard",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/widgets/"
          }
        },
        {
          "name": "Consultar saldos",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/balances/"
          }
        },
        {
          "name": "Consultar previsao de recebimentos",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/income-preview/"
          }
        },
        {
          "name": "Consultar progresso das faturas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/invoice-progress/"
          }
        },
        {
          "name": "Consultar ultimas faturas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/latest-invoices/"
          }
        },
        {
          "name": "Consultar grafico por forma de pagamento",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/payment-method-chart/"
          }
        },
        {
          "name": "Consultar grafico por tipo de fatura",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/invoice-type-chart/"
          }
        },
        {
          "name": "Consultar calendario de recebimentos",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/received-calendar/"
          }
        },
        {
          "name": "Consultar serie mensal de recebimentos",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/monthly-received-chart/"
          }
        },
        {
          "name": "Consultar indicadores de clientes do dashboard",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/dashboard/customers/"
          }
        }
      ]
    },
    {
      "name": "SMS",
      "description": "Envio manual, compra de creditos e consulta de historico.",
      "item": [
        {
          "name": "Enviar SMS",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Idempotency-Key",
                "value": "{{idempotency_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"phone\": \"11987654321\",\n  \"content\": \"Sua cobranca Mepagg vence em 30/06/2026. Acesse o link enviado por e-mail para pagar por boleto ou Pix.\"\n}"
            },
            "url": "{{base_url}}/api/v1/sms/send/"
          }
        },
        {
          "name": "Comprar creditos de SMS",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"sms_credit_package\": \"500\",\n  \"sms_purchase_method\": \"mepagg_balance\"\n}"
            },
            "url": "{{base_url}}/api/v1/sms/buy-credits/"
          }
        },
        {
          "name": "Consultar historico de SMS",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/sms/usages/?limit=20&offset=0"
          }
        }
      ]
    },
    {
      "name": "E-mails e Conta",
      "description": "Consultas operacionais auxiliares da conta autenticada.",
      "item": [
        {
          "name": "Consultar e-mails enviados",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/emails/dispatches/"
          }
        },
        {
          "name": "Consultar dados da conta",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/settings/account/"
          }
        }
      ]
    },
    {
      "name": "Webhooks",
      "description": "Configuracao de endpoints e historico de entregas.",
      "item": [
        {
          "name": "Listar endpoints de webhook",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/settings/webhooks/"
          }
        },
        {
          "name": "Criar endpoint de webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"ERP principal\",\n  \"target_url\": \"https://erp.exemplo.com/webhooks/mepagg\",\n  \"subscribed_events\": [\n    \"customer.created\",\n    \"customer.updated\",\n    \"customer.deleted\",\n    \"invoice.created\",\n    \"invoice.updated\",\n    \"invoice.paid\",\n    \"invoice.cancelled\",\n    \"invoice.refunded\",\n    \"payment_link.status_changed\",\n    \"subscription.created\",\n    \"subscription.updated\",\n    \"subscription.renewed\",\n    \"plan.created\",\n    \"plan.updated\",\n    \"plan.deleted\",\n    \"carne.cancelled\",\n    \"transfer.created\",\n    \"transfer.completed\",\n    \"sms.credits_purchased\",\n    \"sms.sent\",\n    \"email.sent\"\n  ],\n  \"is_enabled\": true\n}"
            },
            "url": "{{base_url}}/api/v1/settings/webhooks/"
          }
        },
        {
          "name": "Atualizar endpoint de webhook",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              },
              {
                "key": "Content-Type",
                "value": "application/json"
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"subscribed_events\": [\n    \"invoice.paid\",\n    \"invoice.cancelled\",\n    \"invoice.refunded\",\n    \"payment_link.status_changed\",\n    \"transfer.completed\",\n    \"sms.credits_purchased\"\n  ],\n  \"is_enabled\": true\n}"
            },
            "url": "{{base_url}}/api/v1/settings/webhooks/{{webhook_endpoint_id}}/"
          }
        },
        {
          "name": "Rotacionar segredo do webhook",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/settings/webhooks/{{webhook_endpoint_id}}/rotate-secret/"
          }
        },
        {
          "name": "Consultar historico de entregas",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/settings/webhooks/deliveries/?limit=20&endpoint_id={{webhook_endpoint_id}}"
          }
        },
        {
          "name": "Excluir endpoint de webhook",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "X-API-KEY",
                "value": "{{api_key}}"
              }
            ],
            "url": "{{base_url}}/api/v1/settings/webhooks/{{webhook_endpoint_id}}/"
          }
        }
      ]
    }
  ]
}
