{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"settings":"","results":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Endpoints","type":"basic","slug":"endpoints","excerpt":"Encontre aqui os endpoints de cada funcionalidade para integrar com a  API Gerencianet","body":"Este conteúdo tem como objetivo auxiliar desenvolvedores no que tange a integração com outras linguagens nas quais não oferecemos ainda biblioteca, ou aqueles que desejam integrar com nossa API sem utilizar nenhuma de nossas SDKs disponibilizadas, para isso fornecemos a [Collection Postman Gerencainet API Cobranças](https://documenter.getpostman.com/view/13574984/TW71kRme).\n\nCaso opte por utilizar nossa SDK, confira como instalar, de acordo com a linguagem que você deseja: [PHP](https://dev.gerencianet.com.br/docs/instalacao-sdk-php), [NodeJS](https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs), [Ruby](https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby), [Python](https://dev.gerencianet.com.br/docs/instalacao-sdk-python), [.NET](https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet), [Java](https://dev.gerencianet.com.br/docs/instalacao-sdk-java), [Delphi](https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi) e [Go](https://dev.gerencianet.com.br/docs/instalacao-sdk-go).\n\nVá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa:\n\n- [Endpoints: Transações](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-transa-es)\n\n- [Endpoints: Carnês](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-carn-s)\n\n- [Endpoints: Notificações](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-notifica-es)\n\n- [Endpoints: Assinaturas](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-assinaturas)\n\n- [Endpoints: Outros](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-outros)\n\n- [Relação entre os endpoints (Playground) com o nome das funções utilizadas pelas SDKs](https://dev.gerencianet.com.br/docs/endpoints#section-rela-o-entre-os-endpoints-playground-com-o-nome-das-fun-es-utilizadas-pelas-sdks)\n\n# Endpoints: Transações\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Método\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Descrição\",\n    \"1-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"2-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"3-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"4-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"5-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"6-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"7-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"8-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"1-1\": \"<div class=\\\"\\\">/v1/charge</div>\",\n    \"2-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code></div>\",\n    \"3-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/metadata</div>\",\n    \"4-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/billet</div>\",\n    \"5-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/cancel</div>\",\n    \"6-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/pay</div>\",\n    \"7-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/billet/resend</div>\",\n    \"8-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/history</div>\",\n    \"1-2\": \"<div class=\\\"\\\">Criar nova transação</div>\",\n    \"2-2\": \"<div class=\\\"\\\">Retornar informações de transação existente</div>\",\n    \"3-2\": \"<div class=\\\"\\\">Incluir informações como \\\"notification_url\\\" e \\\"custom_id\\\" em uma transação existente</div>\",\n    \"4-2\": \"<div class=\\\"\\\">Alterar data de vencimento de uma transação existente</div>\",\n    \"5-2\": \"<div class=\\\"\\\">Cancelar uma transação existente</div>\",\n    \"6-2\": \"<div class=\\\"\\\">Associa método de pagamento à uma transação já criada</div>\",\n    \"7-2\": \"<div class=\\\"\\\">Reenvio do boleto bancário para o e-mail desejado</div>\",\n    \"8-2\": \"<div class=\\\"\\\">Acrescentar descrição ao histórico de uma transação</div>\",\n    \"9-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"9-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/link</div>\",\n    \"9-2\": \"<div class=\\\"\\\">Retorna um link para uma tela de pagamento da Gerencianet</div>\",\n    \"11-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"11-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/balance-sheet</div>\",\n    \"11-2\": \"<div class=\\\"\\\">Define que a transação será do tipo boleto balancete</div>\",\n    \"10-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"10-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/link</div>\",\n    \"10-2\": \"<div class=\\\"\\\">Alterar determinados parâmetros/atributos de um link de pagamento existente</div>\",\n    \"12-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"12-1\": \"<div class=\\\"\\\">/v1/charge/<code>:id</code>/settle</div>\",\n    \"12-2\": \"<div class=\\\"\\\">Permite marcar como pago (baixa manual) uma determinada transação</div>\",\n    \"h-3\": \"Detalhes\",\n    \"1-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto#section-1-criar-transa-o)\",\n    \"2-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-6-retornar-informa-es-sobre-transa-o)\",\n    \"3-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-3-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-transa-o)\",\n    \"4-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-1-alterar-data-de-vencimento-de-boleto-banc-rio)\",\n    \"5-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-2-cancelar-determinada-transa-o)\",\n    \"6-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto#section-2-associar-forma-de-pagamento-via-boleto)\",\n    \"7-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-4-reenviar-boleto-banc-rio-por-e-mail)\",\n    \"8-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-5-acrescentar-informa-es-ao-hist-rico-da-transa-o)\",\n    \"9-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/link-pagamento-criando#section-2-criando-um-link-de-pagamento)\",\n    \"10-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/link-outros-endpoints#section-1-alterar-determinados-par-metros-atributos-de-um-link-de-pagamento-existente)\",\n    \"11-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/boleto-balancete#section-2-defina-que-a-transa-o-gerada-ser-do-tipo-boleto-balancete)\",\n    \"12-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-1-marcar-como-pago-determinada-transa-o)\",\n    \"0-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"0-1\": \"<div class=\\\"\\\">/v1/charge/one-step</div>\",\n    \"0-2\": \"<div class=\\\"\\\">Criar nova transação com pagador atribuido</div>\",\n    \"0-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-1-cria-o-de-boleto-em-one-step-um-passo-)\"\n  },\n  \"cols\": 4,\n  \"rows\": 13\n}\n[/block]\n# Endpoints: Carnês\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Método\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Descrição\",\n    \"0-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"1-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"2-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"3-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"4-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"5-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"6-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"7-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"8-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"0-1\": \"<div class=\\\"\\\">/v1/carnet</div>\",\n    \"1-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code></div>\",\n    \"2-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/metadata</div>\",\n    \"3-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code></div>\",\n    \"4-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/cancel</div>\",\n    \"5-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/cancel</div>\",\n    \"6-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/resend</div>\",\n    \"7-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/resend</div>\",\n    \"8-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/history</div>\",\n    \"0-2\": \"<div class=\\\"\\\">Cria um carnê</div>\",\n    \"1-2\": \"<div class=\\\"\\\">Retorna informações de carnê existente</div>\",\n    \"2-2\": \"<div class=\\\"\\\">Incluir informações como \\\"notification_url\\\" e \\\"custom_id\\\" em um carnê existente</div>\",\n    \"3-2\": \"<div class=\\\"\\\">Alterar data de vencimento de parcela específica de um carnê</div>\",\n    \"4-2\": \"<div class=\\\"\\\">Cancela um determinado carnê</div>\",\n    \"5-2\": \"<div class=\\\"\\\">Cancelamento de parcela específica de um carnê existente</div>\",\n    \"6-2\": \"<div class=\\\"\\\">Reenviar carnê por e-mail</div>\",\n    \"7-2\": \"<div class=\\\"\\\">Reenviar por e-mail determinada parcela de um carnê</div>\",\n    \"8-2\": \"<div class=\\\"\\\">Acrescentar informações ao histórico de um carnê</div>\",\n    \"9-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"9-1\": \"<div class=\\\"\\\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/settle</div>\",\n    \"9-2\": \"<div class=\\\"\\\">Permite marcar como pago (baixa manual) uma determinada parcela de um carnê</div>\",\n    \"h-3\": \"Detalhes\",\n    \"0-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-criando)\",\n    \"1-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-1-retornar-informa-es-sobre-um-carn-)\",\n    \"2-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-2-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-carn-s)\",\n    \"3-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-3-alterar-data-de-vencimento-de-parcela-do-carn-)\",\n    \"4-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-4-cancelar-um-carn-)\",\n    \"5-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-5-cancelar-parcela-espec-fica-de-carn-)\",\n    \"6-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-6-reenviar-carn-por-e-mail)\",\n    \"7-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-7-reenviar-parcela-espec-fica-de-carn-por-e-mail)\",\n    \"8-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-8-acrescentar-informa-es-ao-hist-rico-do-carn-)\",\n    \"9-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-2-marcar-como-pago-determinada-parcela-de-carn-)\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]\n# Endpoints: Notificações\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"0-1\": \"<div class=\\\"\\\">/v1/notification/<code>:token</code></div>\",\n    \"0-2\": \"<div class=\\\"\\\">Retorna o histórico de notificações enviadas a uma determinada transação</div>\",\n    \"h-0\": \"Método\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Descrição\",\n    \"h-3\": \"Descrição\",\n    \"0-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/notificacoes-recebendo)\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n# Endpoints: Assinaturas\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Método\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Descrição\",\n    \"0-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"1-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"3-0\": \"<div class=\\\"\\\"><span class=\\\"delete\\\">DELETE</span></div>\",\n    \"4-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"5-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"6-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"7-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"8-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"0-1\": \"<div class=\\\"\\\">/v1/plan</div>\",\n    \"1-1\": \"<div class=\\\"\\\">/v1/plans</div>\",\n    \"3-1\": \"<div class=\\\"\\\">/v1/plan/<code>:id</code></div>\",\n    \"4-1\": \"<div class=\\\"\\\">/v1/plan/<code>:id</code>/subscription</div>\",\n    \"5-1\": \"<div class=\\\"\\\">/v1/subscription/<code>:id</code></div>\",\n    \"6-1\": \"<div class=\\\"\\\">/v1/subscription/<code>:id</code>/cancel</div>\",\n    \"7-1\": \"<div class=\\\"\\\">/v1/subscription/<code>:id</code>/metadata</div>\",\n    \"8-1\": \"<div class=\\\"\\\">/v1/subscription/<code>:id</code>/pay</div>\",\n    \"0-2\": \"<div class=\\\"\\\">Cria o plano de assinatura</div>\",\n    \"1-2\": \"<div class=\\\"\\\">Retorna informações de um ou mais planos</div>\",\n    \"3-2\": \"<div class=\\\"\\\">Cancela um plano de assinatura</div>\",\n    \"4-2\": \"<div class=\\\"\\\">Cria assinaturas para vincular a planos</div>\",\n    \"5-2\": \"<div class=\\\"\\\">Retorna informações de uma assinatura vinculada a um plano</div>\",\n    \"6-2\": \"<div class=\\\"\\\">Cancelar inscrições ativas em um plano de assinaturas</div>\",\n    \"7-2\": \"<div class=\\\"\\\">Alterar URL de notificação (\\\"notification_url\\\") e/ou \\\"custom_id\\\" em uma assinatura existente</div>\",\n    \"8-2\": \"<div class=\\\"\\\">Associa método de pagamento à uma assinatura já criada</div>\",\n    \"2-0\": \"<div class=\\\"\\\"><span class=\\\"put\\\">PUT</span></div>\",\n    \"2-1\": \"<div class=\\\"\\\">/v1/plan/<code>:id</code></div>\",\n    \"2-2\": \"<div class=\\\"\\\">Permite a alteração (edição) do nome de um plano de assinatura pré-existente</div>\",\n    \"9-0\": \"<div class=\\\"\\\"><span class=\\\"post\\\">POST</span></div>\",\n    \"9-1\": \"<div class=\\\"\\\">/v1/subscription/<code>:id</code>/history\",\n    \"9-2\": \"<div class=\\\"\\\">Acrescenta descrição ao histórico de uma assinatura</div>\",\n    \"h-3\": \"Descrição\",\n    \"0-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-1-crie-o-plano-de-assinatura)\",\n    \"1-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-1-listar-os-planos-de-assinatura-existentes)\",\n    \"2-3\": \"[Vide link](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-8-editar-nome-do-plano-de-assinatura)\",\n    \"3-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-2-cancelar-plano-de-assinatura)\",\n    \"4-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-2-crie-inscri-es-assinaturas-para-vincular-ao-plano)\",\n    \"5-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-3-retornar-informa-es-de-assinatura-vinculada-a-um-plano)\",\n    \"6-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-4-cancelar-assinaturas-ativas-em-um-plano)\",\n    \"7-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-5-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-assinaturas)\",\n    \"8-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-3-defina-a-forma-de-pagamento-da-assinatura-e-os-dados-do-cliente)\",\n    \"9-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-7-acrescentar-informa-es-ao-hist-rico-da-assinatura)\"\n  },\n  \"cols\": 4,\n  \"rows\": 10\n}\n[/block]\n# Endpoints: Outros\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"<div class=\\\"\\\"><span class=\\\"get\\\">GET</span></div>\",\n    \"0-1\": \"<div class=\\\"\\\">/v1/installments</div>\",\n    \"0-2\": \"<div class=\\\"\\\">Listar parcelas, de acordo com a bandeira do cartão de crédito. Bandeiras disponíveis: <code>visa</code>, <code>mastercard</code>, <code>amex</code>, <code>diners</code>, <code>elo</code> e <code>hipercard</code>.\",\n    \"h-0\": \"Método\",\n    \"h-1\": \"Endpoint\",\n    \"h-2\": \"Descrição\",\n    \"h-3\": \"Detalhes\",\n    \"0-3\": \"[Vide link](https://dev.gerencianet.com.br/docs/pagar-cartao-outros-endpoints#section-5-listar-parcelas-de-acordo-com-a-bandeira-do-cart-o-de-cr-dito)\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n# Relação entre os endpoints (Playground) com o nome das funções utilizadas pelas SDKs\n\nA seguir, são disponibilizados a relação entre os endpoints (Playground) com o nome das funções utilizadas por nossas SDKs nas linguagens PHP, NodeJS, Ruby, Python, .NET e Java.\n\nOs arquivos disponibilizados estão em formato .pdf e tem como objetivo permitir que você identifique o nome das funções utilizadas por nossa SDK, de acordo com os endpoints que você utilizou e conheceu no ambiente de teste.\n\nAssim, após você ter explorado bem o nosso Playground e ter conhecido o mecanismo e o fluxo de pagamento, ficará mais fácil para prosseguir com suas atividades de integração. Confira, de acordo com sua linguagem:\n[block:html]\n{\n  \"html\": \"<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-php.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">PHP</button></a>\\n\\n<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-nodejs.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">NodeJS</button></a>\\n\\n<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-ruby.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Ruby on Rails</button></a>\\n\\n<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-python.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Python</button></a>\\n\\n<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-dotnet.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">.NET</button></a>\\n\\n<a href=\\\"https://gerencianet.com.br/material/api/relacionamentos-java.pdf\\\" target=\\\"_blank\\\" title=\\\"Link Externo\\\"><button type=\\\"button\\\" class=\\\"btn btn-default navbar-btn\\\">Java</button></a>\"\n}\n[/block]","updates":[],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"606f2ca7c5ba91007878348a","version":{"version":"1.1.0","version_clean":"1.1.0","codename":"2021","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["606f2ca6c5ba91007878342b","575af039a083950e004487f7","575af5c7ba4ed70e000ca288","606f2ca6c5ba91007878342c","606f2ca6c5ba91007878342d","606f2ca6c5ba91007878342e","606f2ca6c5ba91007878342f","5761a63d207db7170022fc14","5761b9a2b65324200072d79e","576832939f0bf4190014ffdf","576832c09f0bf4190014ffe1","576832cba151c10e004316f0","576832d5bb15f40e00a288ec","576832e107b1f30e0039c645","606f2ca6c5ba910078783430","606f2ca6c5ba910078783431","5783f78c5cbce30e0074e2b7","606f2ca6c5ba910078783432","606f2ca6c5ba910078783433","606f2ca6c5ba910078783434","606f2ca6c5ba910078783435","606f2ca6c5ba910078783436","606f2ca6c5ba910078783437","578529f887c9280e0090394b","606f2ca6c5ba910078783438","606f2ca6c5ba910078783439","606f2ca6c5ba91007878343a","606f2ca6c5ba91007878343b","606f2ca6c5ba91007878343c","606f2ca6c5ba91007878343d","606f2ca6c5ba91007878343e","606f2ca6c5ba91007878343f","606f2ca6c5ba910078783440","606f2ca6c5ba910078783441","60d61f026ddc3901a32ee5f1","60ec37c637005f015e54174e"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":2,"forked_from":"575aeffae12cf20e002f306f"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Autenticação e Endpoints","slug":"endpoints","order":21,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba910078783430","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6","__v":0,"createdAt":"2016-07-01T14:39:59.801Z"},"createdAt":"2017-05-04T12:32:18.277Z","parentDoc":null,"project":"575aeffae12cf20e002f306c","user":"57601a13af3e090e00108059","__v":0,"githubsync":""}

Endpoints

Encontre aqui os endpoints de cada funcionalidade para integrar com a API Gerencianet

Este conteúdo tem como objetivo auxiliar desenvolvedores no que tange a integração com outras linguagens nas quais não oferecemos ainda biblioteca, ou aqueles que desejam integrar com nossa API sem utilizar nenhuma de nossas SDKs disponibilizadas, para isso fornecemos a [Collection Postman Gerencainet API Cobranças](https://documenter.getpostman.com/view/13574984/TW71kRme). Caso opte por utilizar nossa SDK, confira como instalar, de acordo com a linguagem que você deseja: [PHP](https://dev.gerencianet.com.br/docs/instalacao-sdk-php), [NodeJS](https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs), [Ruby](https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby), [Python](https://dev.gerencianet.com.br/docs/instalacao-sdk-python), [.NET](https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet), [Java](https://dev.gerencianet.com.br/docs/instalacao-sdk-java), [Delphi](https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi) e [Go](https://dev.gerencianet.com.br/docs/instalacao-sdk-go). Vá direto ao ponto ­- utilize o índice abaixo e veja diretamente o que você precisa: - [Endpoints: Transações](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-transa-es) - [Endpoints: Carnês](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-carn-s) - [Endpoints: Notificações](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-notifica-es) - [Endpoints: Assinaturas](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-assinaturas) - [Endpoints: Outros](https://dev.gerencianet.com.br/docs/endpoints#section-endpoints-outros) - [Relação entre os endpoints (Playground) com o nome das funções utilizadas pelas SDKs](https://dev.gerencianet.com.br/docs/endpoints#section-rela-o-entre-os-endpoints-playground-com-o-nome-das-fun-es-utilizadas-pelas-sdks) # Endpoints: Transações [block:parameters] { "data": { "h-0": "Método", "h-1": "Endpoint", "h-2": "Descrição", "1-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "2-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "3-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "4-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "5-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "6-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "7-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "8-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "1-1": "<div class=\"\">/v1/charge</div>", "2-1": "<div class=\"\">/v1/charge/<code>:id</code></div>", "3-1": "<div class=\"\">/v1/charge/<code>:id</code>/metadata</div>", "4-1": "<div class=\"\">/v1/charge/<code>:id</code>/billet</div>", "5-1": "<div class=\"\">/v1/charge/<code>:id</code>/cancel</div>", "6-1": "<div class=\"\">/v1/charge/<code>:id</code>/pay</div>", "7-1": "<div class=\"\">/v1/charge/<code>:id</code>/billet/resend</div>", "8-1": "<div class=\"\">/v1/charge/<code>:id</code>/history</div>", "1-2": "<div class=\"\">Criar nova transação</div>", "2-2": "<div class=\"\">Retornar informações de transação existente</div>", "3-2": "<div class=\"\">Incluir informações como \"notification_url\" e \"custom_id\" em uma transação existente</div>", "4-2": "<div class=\"\">Alterar data de vencimento de uma transação existente</div>", "5-2": "<div class=\"\">Cancelar uma transação existente</div>", "6-2": "<div class=\"\">Associa método de pagamento à uma transação já criada</div>", "7-2": "<div class=\"\">Reenvio do boleto bancário para o e-mail desejado</div>", "8-2": "<div class=\"\">Acrescentar descrição ao histórico de uma transação</div>", "9-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "9-1": "<div class=\"\">/v1/charge/<code>:id</code>/link</div>", "9-2": "<div class=\"\">Retorna um link para uma tela de pagamento da Gerencianet</div>", "11-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "11-1": "<div class=\"\">/v1/charge/<code>:id</code>/balance-sheet</div>", "11-2": "<div class=\"\">Define que a transação será do tipo boleto balancete</div>", "10-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "10-1": "<div class=\"\">/v1/charge/<code>:id</code>/link</div>", "10-2": "<div class=\"\">Alterar determinados parâmetros/atributos de um link de pagamento existente</div>", "12-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "12-1": "<div class=\"\">/v1/charge/<code>:id</code>/settle</div>", "12-2": "<div class=\"\">Permite marcar como pago (baixa manual) uma determinada transação</div>", "h-3": "Detalhes", "1-3": "[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto#section-1-criar-transa-o)", "2-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-6-retornar-informa-es-sobre-transa-o)", "3-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-3-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-transa-o)", "4-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-1-alterar-data-de-vencimento-de-boleto-banc-rio)", "5-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-2-cancelar-determinada-transa-o)", "6-3": "[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto#section-2-associar-forma-de-pagamento-via-boleto)", "7-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-4-reenviar-boleto-banc-rio-por-e-mail)", "8-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-5-acrescentar-informa-es-ao-hist-rico-da-transa-o)", "9-3": "[Vide link](https://dev.gerencianet.com.br/docs/link-pagamento-criando#section-2-criando-um-link-de-pagamento)", "10-3": "[Vide link](https://dev.gerencianet.com.br/docs/link-outros-endpoints#section-1-alterar-determinados-par-metros-atributos-de-um-link-de-pagamento-existente)", "11-3": "[Vide link](https://dev.gerencianet.com.br/docs/boleto-balancete#section-2-defina-que-a-transa-o-gerada-ser-do-tipo-boleto-balancete)", "12-3": "[Vide link](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-1-marcar-como-pago-determinada-transa-o)", "0-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "0-1": "<div class=\"\">/v1/charge/one-step</div>", "0-2": "<div class=\"\">Criar nova transação com pagador atribuido</div>", "0-3": "[Vide link](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-1-cria-o-de-boleto-em-one-step-um-passo-)" }, "cols": 4, "rows": 13 } [/block] # Endpoints: Carnês [block:parameters] { "data": { "h-0": "Método", "h-1": "Endpoint", "h-2": "Descrição", "0-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "1-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "2-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "3-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "4-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "5-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "6-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "7-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "8-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "0-1": "<div class=\"\">/v1/carnet</div>", "1-1": "<div class=\"\">/v1/carnet/<code>:id</code></div>", "2-1": "<div class=\"\">/v1/carnet/<code>:id</code>/metadata</div>", "3-1": "<div class=\"\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code></div>", "4-1": "<div class=\"\">/v1/carnet/<code>:id</code>/cancel</div>", "5-1": "<div class=\"\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/cancel</div>", "6-1": "<div class=\"\">/v1/carnet/<code>:id</code>/resend</div>", "7-1": "<div class=\"\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/resend</div>", "8-1": "<div class=\"\">/v1/carnet/<code>:id</code>/history</div>", "0-2": "<div class=\"\">Cria um carnê</div>", "1-2": "<div class=\"\">Retorna informações de carnê existente</div>", "2-2": "<div class=\"\">Incluir informações como \"notification_url\" e \"custom_id\" em um carnê existente</div>", "3-2": "<div class=\"\">Alterar data de vencimento de parcela específica de um carnê</div>", "4-2": "<div class=\"\">Cancela um determinado carnê</div>", "5-2": "<div class=\"\">Cancelamento de parcela específica de um carnê existente</div>", "6-2": "<div class=\"\">Reenviar carnê por e-mail</div>", "7-2": "<div class=\"\">Reenviar por e-mail determinada parcela de um carnê</div>", "8-2": "<div class=\"\">Acrescentar informações ao histórico de um carnê</div>", "9-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "9-1": "<div class=\"\">/v1/carnet/<code>:id</code>/parcel/<code>:parcel</code>/settle</div>", "9-2": "<div class=\"\">Permite marcar como pago (baixa manual) uma determinada parcela de um carnê</div>", "h-3": "Detalhes", "0-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-criando)", "1-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-1-retornar-informa-es-sobre-um-carn-)", "2-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-2-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-carn-s)", "3-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-3-alterar-data-de-vencimento-de-parcela-do-carn-)", "4-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-4-cancelar-um-carn-)", "5-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-5-cancelar-parcela-espec-fica-de-carn-)", "6-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-6-reenviar-carn-por-e-mail)", "7-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-7-reenviar-parcela-espec-fica-de-carn-por-e-mail)", "8-3": "[Vide link](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-8-acrescentar-informa-es-ao-hist-rico-do-carn-)", "9-3": "[Vide link](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-2-marcar-como-pago-determinada-parcela-de-carn-)" }, "cols": 4, "rows": 10 } [/block] # Endpoints: Notificações [block:parameters] { "data": { "0-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "0-1": "<div class=\"\">/v1/notification/<code>:token</code></div>", "0-2": "<div class=\"\">Retorna o histórico de notificações enviadas a uma determinada transação</div>", "h-0": "Método", "h-1": "Endpoint", "h-2": "Descrição", "h-3": "Descrição", "0-3": "[Vide link](https://dev.gerencianet.com.br/docs/notificacoes-recebendo)" }, "cols": 4, "rows": 1 } [/block] # Endpoints: Assinaturas [block:parameters] { "data": { "h-0": "Método", "h-1": "Endpoint", "h-2": "Descrição", "0-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "1-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "3-0": "<div class=\"\"><span class=\"delete\">DELETE</span></div>", "4-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "5-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "6-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "7-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "8-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "0-1": "<div class=\"\">/v1/plan</div>", "1-1": "<div class=\"\">/v1/plans</div>", "3-1": "<div class=\"\">/v1/plan/<code>:id</code></div>", "4-1": "<div class=\"\">/v1/plan/<code>:id</code>/subscription</div>", "5-1": "<div class=\"\">/v1/subscription/<code>:id</code></div>", "6-1": "<div class=\"\">/v1/subscription/<code>:id</code>/cancel</div>", "7-1": "<div class=\"\">/v1/subscription/<code>:id</code>/metadata</div>", "8-1": "<div class=\"\">/v1/subscription/<code>:id</code>/pay</div>", "0-2": "<div class=\"\">Cria o plano de assinatura</div>", "1-2": "<div class=\"\">Retorna informações de um ou mais planos</div>", "3-2": "<div class=\"\">Cancela um plano de assinatura</div>", "4-2": "<div class=\"\">Cria assinaturas para vincular a planos</div>", "5-2": "<div class=\"\">Retorna informações de uma assinatura vinculada a um plano</div>", "6-2": "<div class=\"\">Cancelar inscrições ativas em um plano de assinaturas</div>", "7-2": "<div class=\"\">Alterar URL de notificação (\"notification_url\") e/ou \"custom_id\" em uma assinatura existente</div>", "8-2": "<div class=\"\">Associa método de pagamento à uma assinatura já criada</div>", "2-0": "<div class=\"\"><span class=\"put\">PUT</span></div>", "2-1": "<div class=\"\">/v1/plan/<code>:id</code></div>", "2-2": "<div class=\"\">Permite a alteração (edição) do nome de um plano de assinatura pré-existente</div>", "9-0": "<div class=\"\"><span class=\"post\">POST</span></div>", "9-1": "<div class=\"\">/v1/subscription/<code>:id</code>/history", "9-2": "<div class=\"\">Acrescenta descrição ao histórico de uma assinatura</div>", "h-3": "Descrição", "0-3": "[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-1-crie-o-plano-de-assinatura)", "1-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-1-listar-os-planos-de-assinatura-existentes)", "2-3": "[Vide link](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-8-editar-nome-do-plano-de-assinatura)", "3-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-2-cancelar-plano-de-assinatura)", "4-3": "[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-2-crie-inscri-es-assinaturas-para-vincular-ao-plano)", "5-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-3-retornar-informa-es-de-assinatura-vinculada-a-um-plano)", "6-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-4-cancelar-assinaturas-ativas-em-um-plano)", "7-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-5-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-assinaturas)", "8-3": "[Vide link](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-3-defina-a-forma-de-pagamento-da-assinatura-e-os-dados-do-cliente)", "9-3": "[Vide link](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-7-acrescentar-informa-es-ao-hist-rico-da-assinatura)" }, "cols": 4, "rows": 10 } [/block] # Endpoints: Outros [block:parameters] { "data": { "0-0": "<div class=\"\"><span class=\"get\">GET</span></div>", "0-1": "<div class=\"\">/v1/installments</div>", "0-2": "<div class=\"\">Listar parcelas, de acordo com a bandeira do cartão de crédito. Bandeiras disponíveis: <code>visa</code>, <code>mastercard</code>, <code>amex</code>, <code>diners</code>, <code>elo</code> e <code>hipercard</code>.", "h-0": "Método", "h-1": "Endpoint", "h-2": "Descrição", "h-3": "Detalhes", "0-3": "[Vide link](https://dev.gerencianet.com.br/docs/pagar-cartao-outros-endpoints#section-5-listar-parcelas-de-acordo-com-a-bandeira-do-cart-o-de-cr-dito)" }, "cols": 4, "rows": 1 } [/block] # Relação entre os endpoints (Playground) com o nome das funções utilizadas pelas SDKs A seguir, são disponibilizados a relação entre os endpoints (Playground) com o nome das funções utilizadas por nossas SDKs nas linguagens PHP, NodeJS, Ruby, Python, .NET e Java. Os arquivos disponibilizados estão em formato .pdf e tem como objetivo permitir que você identifique o nome das funções utilizadas por nossa SDK, de acordo com os endpoints que você utilizou e conheceu no ambiente de teste. Assim, após você ter explorado bem o nosso Playground e ter conhecido o mecanismo e o fluxo de pagamento, ficará mais fácil para prosseguir com suas atividades de integração. Confira, de acordo com sua linguagem: [block:html] { "html": "<a href=\"https://gerencianet.com.br/material/api/relacionamentos-php.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">PHP</button></a>\n\n<a href=\"https://gerencianet.com.br/material/api/relacionamentos-nodejs.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">NodeJS</button></a>\n\n<a href=\"https://gerencianet.com.br/material/api/relacionamentos-ruby.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Ruby on Rails</button></a>\n\n<a href=\"https://gerencianet.com.br/material/api/relacionamentos-python.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Python</button></a>\n\n<a href=\"https://gerencianet.com.br/material/api/relacionamentos-dotnet.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">.NET</button></a>\n\n<a href=\"https://gerencianet.com.br/material/api/relacionamentos-java.pdf\" target=\"_blank\" title=\"Link Externo\"><button type=\"button\" class=\"btn btn-default navbar-btn\">Java</button></a>" } [/block]