{"id":37037939,"url":"https://github.com/rkdcoder/pix","last_synced_at":"2026-01-14T04:30:55.438Z","repository":{"id":310803027,"uuid":"1021523774","full_name":"rkdcoder/pix","owner":"rkdcoder","description":"Gerador do texto do QrCode do Pix","archived":false,"fork":false,"pushed_at":"2025-07-17T20:02:13.000Z","size":90,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-21T22:48:18.504Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rkdcoder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-17T14:23:40.000Z","updated_at":"2025-09-03T19:59:51.000Z","dependencies_parsed_at":"2025-08-20T11:07:41.237Z","dependency_job_id":null,"html_url":"https://github.com/rkdcoder/pix","commit_stats":null,"previous_names":["rkdcoder/pix"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rkdcoder/pix","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkdcoder%2Fpix","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkdcoder%2Fpix/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkdcoder%2Fpix/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkdcoder%2Fpix/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rkdcoder","download_url":"https://codeload.github.com/rkdcoder/pix/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rkdcoder%2Fpix/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28409495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-14T04:30:54.780Z","updated_at":"2026-01-14T04:30:55.428Z","avatar_url":"https://github.com/rkdcoder.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pix\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/rkdcoder/pix/main/src/Pix/icon.png\" width=\"128\" alt=\"Pix logo\" /\u003e\n\u003c/p\u003e\n\n## Pix Nuget: Gerador de Payload para QrCode Pix (Copia e Cola) – .NET 6+\n\n[![NuGet](https://img.shields.io/nuget/v/Rkd.Pix.svg)](https://www.nuget.org/packages/Rkd.Pix)\n[![Build \u0026 Publish](https://github.com/rkdcoder/Pix/actions/workflows/main.yml/badge.svg)](https://github.com/rkdcoder/Pix/actions/workflows/main.yml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n\n\u003e **Gere payloads Pix “Copia e Cola” de forma segura, validada e simples em aplicações .NET. Não gera imagens, apenas o texto pronto para pagamento!**\n\n---\n\n## Índice\n\n- [Visão Geral](#visão-geral)\n- [Instalação](#instalação)\n- [Exemplo de Uso](#exemplo-de-uso)\n- [API](#api)\n- [Resposta Padrão](#resposta-padrão)\n- [Validações](#validações)\n- [Internacionalização](#internacionalização)\n- [Testes e Cobertura](#testes-e-cobertura)\n- [Limitações](#limitações)\n- [Roadmap](#roadmap)\n- [Licença](#licença)\n\n---\n\n## Visão Geral\n\nO **Rkd.Pix** é um pacote Nuget para geração do payload textual do Pix (“Copia e Cola”), seguindo o padrão do Banco Central do Brasil. Desenvolvido para ser simples, validado, direto, e seguro.\n\n- Compatível com .NET 6 ou superior.\n- Gera somente o texto do payload Pix, pronto para colar no app do banco ou gerar QR Code.\n- **Não gera imagens**.\n- Validação automática conforme Bacen.\n- API enxuta e fácil de integrar.\n\n---\n\n## Instalação\n\nVia Nuget Package Manager:\n\n```\nInstall-Package Rkd.Pix\n```\n\nOu via .NET CLI:\n\n```\ndotnet add package Rkd.Pix\n```\n\n---\n\n## Exemplo de Uso\n\n```csharp\nusing Pix;\n\nvar result = PixGenerator.GeneratePayload(\n    \"abc@pix.com.br\",\n    \"JOAO DA SILVA\",\n    123.45m,\n    \"SAO PAULO\",\n    \"PEDIDO123\",\n    \"Obrigado!\"\n);\n\nif (result.Success)\n{\n    Console.WriteLine(result.Payload); // \"00020126...\"\n}\nelse\n{\n    Console.WriteLine(\"Erro: \" + result.Message);\n}\n```\n\n---\n\n## API\n\nMétodo principal:\n\n```csharp\nPixPayloadResult PixGenerator.GeneratePayload(\n    string chavePix,\n    string nomeFavorecido,\n    decimal valor,\n    string cidade,\n    string identificador,\n    string? mensagem = null,\n    string moeda = \"986\",\n    string pais = \"BR\"\n)\n```\n\n- Parâmetros obrigatórios: `chavePix`, `nomeFavorecido`, `valor`, `cidade`, `identificador`\n- Parâmetros opcionais: `mensagem`, `moeda` (padrão 986), `pais` (padrão BR)\n\n---\n\n## Resposta Padrão\n\n```json\n{\n  \"success\": true,\n  \"message\": \"Payload do Pix gerado com sucesso\",\n  \"payload\": \"00020126...\"\n}\n```\n\nEm caso de erro de validação:\n\n```json\n{\n  \"success\": false,\n  \"message\": \"Descrição detalhada do erro\",\n  \"payload\": null\n}\n```\n\n---\n\n## Validações\n\nValidações automáticas conforme especificação Bacen:\n\n- Chave Pix: obrigatória, até 77 caracteres\n- Nome: obrigatório, até 25 caracteres\n- Valor: maior que zero\n- Cidade: obrigatória, até 15 caracteres\n- Identificador (TxId): obrigatório, até 25 caracteres, sem acentos/especiais\n- Mensagem: opcional, até 35 caracteres\n- Moeda: padrão ISO 4217 (3 dígitos), default 986\n- País: padrão ISO 3166-1 alpha-2 (2 letras), default BR\n\nQualquer violação resulta em erro amigável na propriedade `message` da resposta.\n\n---\n\n## Internacionalização\n\nAs mensagens de erro e resposta padrão estão em português. O design permite futura internacionalização (ex: inglês).\n\n---\n\n## Testes e Cobertura\n\nO projeto conta com testes unitários completos para todos os fluxos principais, cobrindo:\n\n- Casos de sucesso e borda\n- Todos os campos obrigatórios e limites de tamanho\n- Cenários inválidos\n- Concorrência\n\n**Cobertura mínima recomendada: 90%.**\n\nPara rodar os testes:\n\n```\ndotnet test\n```\n\n---\n\n## Limitações\n\n- **Não** gera imagem QR Code, apenas o texto Copia e Cola.\n- Extensões futuras (Pix com vencimento, cobrança) podem ser adicionadas mantendo o padrão de validação.\n- Caso queira personalizações além do padrão Bacen, sugira via Issues.\n\n---\n\n## Roadmap\n\n- Suporte a Pix Cobrança (com vencimento)\n- Internacionalização completa (pt-BR, en-US)\n- Plugins de validação customizada\n- Exemplo de integração com APIs de bancos\n\nContribuições são bem-vindas!\n\n---\n\n## Licença\n\nMIT. Veja o arquivo LICENSE para detalhes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frkdcoder%2Fpix","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frkdcoder%2Fpix","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frkdcoder%2Fpix/lists"}