{"id":37056541,"url":"https://github.com/boletofacil/boletofacil-sdk-net","last_synced_at":"2026-01-14T06:23:16.786Z","repository":{"id":30565714,"uuid":"125386029","full_name":"boletofacil/boletofacil-sdk-net","owner":"boletofacil","description":"SDK .NET para integração com a API do Boleto Fácil.","archived":false,"fork":false,"pushed_at":"2022-12-07T21:24:50.000Z","size":4439,"stargazers_count":3,"open_issues_count":5,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-10-03T17:39:31.125Z","etag":null,"topics":["boleto","boletobancario","boletofacil","boletofacilsdk","boletos","csharp","dotnet"],"latest_commit_sha":null,"homepage":null,"language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boletofacil.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}},"created_at":"2018-03-15T15:15:48.000Z","updated_at":"2021-04-05T14:53:28.000Z","dependencies_parsed_at":"2023-01-14T17:15:29.765Z","dependency_job_id":null,"html_url":"https://github.com/boletofacil/boletofacil-sdk-net","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/boletofacil/boletofacil-sdk-net","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boletofacil%2Fboletofacil-sdk-net","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boletofacil%2Fboletofacil-sdk-net/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boletofacil%2Fboletofacil-sdk-net/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boletofacil%2Fboletofacil-sdk-net/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boletofacil","download_url":"https://codeload.github.com/boletofacil/boletofacil-sdk-net/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boletofacil%2Fboletofacil-sdk-net/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28412211,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T05:26:33.345Z","status":"ssl_error","status_checked_at":"2026-01-14T05:21:57.251Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["boleto","boletobancario","boletofacil","boletofacilsdk","boletos","csharp","dotnet"],"created_at":"2026-01-14T06:23:16.263Z","updated_at":"2026-01-14T06:23:16.779Z","avatar_url":"https://github.com/boletofacil.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"## SDK .NET para integra��o com o Boleto F�cil\n\nEste SDK (Software Development Kit) para o Boleto F�cil tem como objetivo abstrair, para desenvolvedores de aplica��es na plataforma .NET, os detalhes de comunica��o com a [API do Boleto F�cil](https://www.boletobancario.com/boletofacil/integration/integration.html), tanto com o servidor de [produ��o](https://www.boletobancario.com/boletofacil/) como com o servidor de testes ([sandbox](https://sandbox.boletobancario.com/boletofacil/)), de modo que o desenvolvedor possa se concentrar na l�gica de neg�cio de sua aplica��o.\n\n## Requisitos\n\n* Portable Class Library (.NETFramework 4.5, Windows 8.0)\n\n## Integra��o\n\n#### NuGet\n\nO SDK .NET do Boleto F�cil est� dispon�vel no NuGet: https://www.nuget.org/packages/boletofacilsdk\n\n## Limita��es\n\nO �nico item da API do Boleto F�cil que essa SDK n�o contempla � a [notifica��o de pagamentos](https://www.boletobancario.com/boletofacil/integration/integration.html#notificacao) para aplica��es Web, atrav�s da URL de notifica��o. Nesse caso, tanto a l�gica de captura das requisi��es POST enviadas pelo Boleto F�cil com os dados dos pagamentos como a l�gica da baixa das cobran�as pagas ficam a cargo do sistema integrado com o Boleto F�cil.\n\n## Guia de uso\n\nPara usar o SDK do Boleto F�cil � necess�rio definir dois itens:\n\n1. O ambiente: produ��o (`PRODUCTION`) ou testes (`SANDBOX`)\n2. O token do favorecido, o qual deve ser definido na �rea de **integra��o** do ambiente escolhido ([aqui](https://www.boletobancario.com/boletofacil/integration/integration.html#token) para produ��o ou [aqui](https://sandbox.boletobancario.com/boletofacil/integration/integration.html#token) para sandbox)\n\nExemplo:\n```c#\n// Cria uma inst�ncia do SDK que ir� enviar requisi��es ao ambiente de testes do Boleto F�cil (Sandbox)\nBoletoFacil boletoFacil = new BoletoFacil(BoletoFacilEnvironment.Sandbox, \"XYZ12345\"); // XYZ12345 is the API key\n```\n\n### Gerando uma cobran�a\n\n`Charge` � a classe que representa uma cobran�a do Boleto F�cil e que cont�m os atributos relacionados a ela, que \ns�o exatamente os atributos disponibilizados pela API do Boleto F�cil e podem ser conferidos [aqui](https://www.boletobancario.com/boletofacil/integration/integration.html#cobrancas). \n\nDentre os atributos da cobran�a est�o os dados do pagador, que s�o definidos na classe `Payer`.\n\n```c#\nPayer payer = new Payer();\npayer.Name = \"Pagador teste - SDK .NET\";\npayer.CpfCnpj = \"11122233300\";\n\nCharge charge = new Charge();\ncharge.Description = \"Cobran�a teste gerada pelo SDK .NET\";\ncharge.Amount = 176.45m;\ncharge.Payer = payer;\n\nChargeResponse response = boletoFacil.IssueCharge(charge);\nforeach (Charge c in response.Data.Charges)\n{\n    Console.WriteLine(c);\n}\n```\n\nA classe `ChargeResponse` indica se a requisi��o foi bem sucedida ou n�o (da mesma forma que todas as classes que herdam da superclasse `Response` no SDK) e, al�m disso, cont�m a lista de cobran�as que foram geradas pela requisi��o, em uma lista de objetos do tipo `Charge`.\n\n\n### Consulta de saldo\n\nPor padr�o, as requisi��es feitas pelo SDK desserializam o retorno em **JSON** para popular os objetos com as informa��es das requisi��es, mas o SDK tamb�m prov� a possibilidade de alterar a formata��o do retorno da API para **XML**, conforme pode ser visto no exemplo abaixo:\n\n```c#\nFetchBalanceResponse response = boletoFacil.FetchBalance(ResponseType.XML);\nConsole.WriteLine(response.Data);\n```\n\n\n### Solicita��o de transfer�ncia\n\nMesmo que se deseje solicitar uma transfer�ncia com o saldo total, � necess�rio passar um par�metro da classe `Transfer`, sem o atributo `amount` definido, no caso.\n\n```c#\nTransfer transfer = new Transfer();\nTransferResponse response = boletoFacil.RequestTransfer(transfer);\nConsole.WriteLine(response);\n```\n\nComo a resposta de solicita��o transfer�ncia cont�m apenas se a requisi��o foi bem sucedida ou n�o, n�o se aplica o m�todo `getData()` para ela.\n\n\n### Consulta de pagamentos e cobran�as\n\nPara esta requisi��o, � usado um objeto da classe `ListChargesDates` para definir as datas usadas no filtro da consulta. No exemplo abaixo, s�o usadas apenas as datas de vencimento das cobran�as desejadas.\n\n```c#\nListChargesDates dates = new ListChargesDates();\ndates.BeginDueDate = DateTime.Today.AddDays(1);\ndates.EndDueDate = DateTime.Today.AddDays(5);\n\nListChargesResponse response = boletoFacil.listCharges(dates);\nforeach (Charge c in response.Data.Charges)\n{\n    Console.WriteLine(c);\n}\n```\n\n\n### Cria��o de favorecido (API Avan�ada)\n\nA API avan�ada tamb�m est� dispon�vel no SDK. Segue abaixo um exemplo de cria��o de favorecido, com os principais atributos (e objetos) relacionados.\n\n```c#\nPerson person = new Person();\npayee.Name = \"Favorecido do SDK .NET\";\npayee.CpfCnpj = \"11122233300\";\npayee.Email = \"email@teste.com\";\npayee.Password = \"senha\";\npayee.BirthDate = DateTime.Today.AddYears(-18);\npayee.Phone = \"(41) 91234-4321\";\npayee.LinesOfBusiness = \"Linha de neg�cio\";\npayee.AccountHolder = new Person \n{ \n\tName = \"Favorecido do SDK .NET\", \n\tCpfCnpj = \"11122233300\" \n};\npayee.BankAccount = new BankAccount\n{\n\tBankAccountType = BankAccountType.CHECKING,\n    BankNumber = \"237\",\n    AgencyNumber = \"123\",\n    AccountNumber = \"4567\",\n    AccountComplementNumber = 0\n};\npayee.Category = Category.OTHER;\npayee.Address = new Address\n{\n    Street = \"Rua Teste\",\n    Number = \"123\",\n    City = \"4106902\",\n    State = \"PR\",\n    Postcode = \"12345000\"\n};\npayee.BusinessAreaId = 1000;\n\nPayeeResponse response = boletoFacil.createPayee(payee);\nif (response.isSuccess()) {\n\tSystem.out.println(response.getData());\n}\n```\n\nA tabela com os c�digos de munic�pio do IBGE pode ser consultada [aqui](http://www.ibge.gov.br/home/geociencias/areaterritorial/area.shtm).\n\n### Tokeniza��o do cart�o de cr�dito (API Avan�ada)\n\nA tokeniza��o permite que o salvamento do cart�o de cr�dito para compras futuras no padr�o PCI. Segue abaixo um exemplo de tokeniza��o. \n\n```c#\nCharge charge = new Charge\n{\n    CreditCardHash = \"d6f15405-5870-4e30-8eee-db0f42bf74ce\"\n};\n\nTokenizationResponse response = boletoFacil.CardTokenization(charge);\nConsole.WriteLine(response);\n```\n\n\n\n## Aplica��o cliente de exemplo\n\nJuntamente com o projeto do SDK h� um outro projeto de um cliente de exemplo (aplica��o console) que cont�m exemplos de todas as chamadas disponibilizadas pelo SDK.\n\n\n## Suporte\n\nEm caso de d�vidas, problemas ou sugest�es, n�o hesite em contatar nossa [equipe de implanta��o](mailto:implantacao@juno.com.br).\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboletofacil%2Fboletofacil-sdk-net","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboletofacil%2Fboletofacil-sdk-net","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboletofacil%2Fboletofacil-sdk-net/lists"}