{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","results":{"codes":[]},"settings":"","params":[]},"next":{"description":"","pages":[]},"title":"Introdução","type":"basic","slug":"instalacao-da-api","excerpt":"Você encontra aqui as nossas SDK's para integração com a API Pix e API Boletos (Bolix) da Gerencianet e um tutorial de como instalar cada uma.","body":"Aqui você encontra a lista de comandos/endpoints disponíveis em nossas SDKs. \n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Os nomes das funções são os mesmos independente da SDK/linguagem utilizada.\",\n  \"title\": \"Atenção!\"\n}\n[/block]\nSumário:\n1. [Cobranças via Boleto ou Cartão](#section-cobran-as-via-boleto-ou-cart-o-)\n2. [Cobranças via Carnê](#section-cobran-as-via-carn-)\n3. [Cobranças via Assinaturas (Cobrança Recorrente)](#section-cobran-as-via-assinaturas-cobran-a-recorrente-)\n4. [Recebimento de Notificações e Parcelamento](#section-recebimento-de-notifica-es-e-parcelamento-)\n5. [Cobranças via Pix](#section-cobran-as-via-pix-)\n6. [Endpoints Exclusivos Gerencianet](#section-endpoints-exclusivos-gerencianet-)\n\nVeja como é fácil instalar nossa SDK e integrar em seu site ou sistema. Disponibilizamos em 10 (dez) linguagens:\n\n### Nossas SDKs\n\n- [PHP](https://dev.gerencianet.com.br/docs/instalacao-sdk-php)\n- [NodeJS](https://dev.gerencianet.com.br/docs/instalacao-sdk-nodejs)\n- [Ruby](https://dev.gerencianet.com.br/docs/instalacao-sdk-ruby)\n- [Python](https://dev.gerencianet.com.br/docs/instalacao-sdk-python)\n- [.NET](https://dev.gerencianet.com.br/docs/instalacao-sdk-dotnet)\n- [.NET Core](https://dev.gerencianet.com.br/docs/net-core)\n- [Java](https://dev.gerencianet.com.br/docs/instalacao-sdk-java)\n- [Delphi](https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi)\n- [Go](https://dev.gerencianet.com.br/docs/instalacao-sdk-go)\n- [TypeScript](https://dev.gerencianet.com.br/docs/typescript)\n- [Dart](https://dev.gerencianet.com.br/docs/dart)\n- [Flutter](https://dev.gerencianet.com.br/docs/flutter)\n- [Android](https://dev.gerencianet.com.br/docs/android)\n\n### Cobranças via Boleto ou Cartão\n##### Comandos disponíveis:\nClique no comando desejado para acessar sua documentação.\n\n| Comando | Descrição |\n|------------------------|--------------------------------------------------------------------------------------|\n| [createCharge](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-2-1-criar-transa-o) | Criar nova cobrança|\n| [detailCharge](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-6-retornar-informa-es-sobre-transa-o) | Retornar informações de cobrança existente|\n| [updateChargeMetadata](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) | Incluir informações como \"notification_url\" e \"custom_id\" em uma cobrança existente |\n| [updateBillet](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-1-alterar-data-de-vencimento-de-boleto-banc-rio) | Alterar data de vencimento de uma cobrança existente|\n| [cancelCharge](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-2-cancelar-determinada-transa-o) | Cancelar uma cobrança existente |\n| payCharge [Boleto](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-2-2-associar-forma-de-pagamento-via-boleto) ou [Cartão](https://dev.gerencianet.com.br/docs/pagamento-com-cartao#section-2-2-associe-forma-de-pagamento-via-cart-o) | Associa método de pagamento (boleto ou cartão) à uma cobrança já criada |\n| [resendBillet](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-4-reenviar-boleto-banc-rio-por-e-mail) | Reenvio do boleto bancário para o e-mail desejado|\n| [createChargeHistory](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-5-acrescentar-informa-es-ao-hist-rico-da-transa-o) | Acrescentar descrição ao histórico de uma cobrança|\n| [linkCharge](https://dev.gerencianet.com.br/docs/link-pagamento-criando#section-2-criando-um-link-de-pagamento) | Retorna um link para uma tela de pagamento da Gerencianet|\n| [updateChargeLink](https://dev.gerencianet.com.br/docs/link-outros-endpoints#section-1-alterar-determinados-par-metros-atributos-de-um-link-de-pagamento-existente) | Alterar determinados parâmetros/atributos de um link de pagamento existente|\n| [createChargeBalanceSheet]() | Define que a cobrança será do tipo boleto balancete |\n| [settleCharge](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-1-marcar-como-pago-determinada-transa-o) | Permite marcar como pago (baixa manual) uma determinada cobrança|\n| oneStep [Boleto](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-1-cria-o-de-boleto-em-one-step-um-passo-) ou [Cartão](https://dev.gerencianet.com.br/docs/pagamento-com-cartao#section-1-cria-o-de-transa-o-por-cart-o-de-cr-dito-em-one-step-um-passo-) | Criar nova cobrança com pagador atribuido (boleto ou cartão)|\n\n### Cobranças via Carnê\n##### Comandos disponíveis:\nClique no comando desejado para acessar sua documentação.\n\n|Comando| Descrição |\n|----------------------|---------------------------------------------------------------------------------|\n| [createCarnet](https://dev.gerencianet.com.br/docs/carnes-criando) | Cria um carnê |\n| [detailCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-1-retornar-informa-es-sobre-um-carn-) | Retorna informações de carnê existente|\n| [updateCarnetMetadata](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) | Incluir informações como \"notification_url\" e \"custom_id\" em um carnê existente |\n| [updateParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-3-alterar-data-de-vencimento-de-parcela-do-carn-) | Alterar data de vencimento de parcela específica de um carnê|\n| [cancelCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-4-cancelar-um-carn-) | Cancela um determinado carnê|\n| [cancelParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-5-cancelar-parcela-espec-fica-de-carn-) | Cancelamento de parcela específica de um carnê existente|\n| [resendCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-6-reenviar-carn-por-e-mail) | Reenviar carnê por e-mail |\n| [resendParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-7-reenviar-parcela-espec-fica-de-carn-por-e-mail) | Reenviar por e-mail determinada parcela de um carnê |\n| [createCarnetHistory](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-8-acrescentar-informa-es-ao-hist-rico-do-carn-)| Acrescentar informações ao histórico de um carnê|\n| [settleCarnet] | Permite marcar como pago (baixa manual) em um determinado carnê |\n| [settleCarnetParcel](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-2-marcar-como-pago-determinada-parcela-de-carn-) | Permite marcar como pago (baixa manual) uma determinada parcela de um carnê |\n\n### Cobranças via Assinaturas (Cobrança Recorrente)\n##### Comandos disponíveis:\nClique no comando desejado para acessar sua documentação.\n\n| Comando | Descrição |\n|----------------------------|----------------------------------------------------------------------------------------------|\n| [createPlan](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-1-crie-o-plano-de-assinatura)| Cria o plano de assinatura |\n| [getPlans](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-1-listar-os-planos-de-assinatura-existentes) | Retorna informações de um plano|\n| [updatePlan](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-8-editar-nome-do-plano-de-assinatura) | Permite a alteração (edição) do nome de um plano de assinatura pré-existente |\n| [deletePlan](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-2-cancelar-plano-de-assinatura) | Cancela um plano de assinatura |\n| [createSubscription](https://dev.gerencianet.com.br/v1/docs/criando-assinaturas#section-2-crie-inscri-es-assinaturas-para-vincular-ao-plano) | Cria assinaturas para vincular a planos|\n| [detailSubscription](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-3-retornar-informa-es-de-assinatura-vinculada-a-um-plano) | Retorna informações de uma assinatura vinculada a um plano |\n| [cancelSubscription](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-4-cancelar-assinaturas-ativas-em-um-plano) | Cancelar inscrições ativas em um plano de assinaturas|\n| [updateSubscriptionMetadata](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-5-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-assinaturas) | Alterar URL de notificação (\"notification_url\") e/ou \"custom_id\" em uma assinatura existente |\n| [paySubscription](https://dev.gerencianet.com.br/v1/docs/criando-assinaturas#section-3-defina-a-forma-de-pagamento-da-assinatura-e-os-dados-do-cliente)| Associa método de pagamento à uma assinatura já criada |\n| [createSubscriptionHistory](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-7-acrescentar-informa-es-ao-hist-rico-da-assinatura)| Acrescenta descrição ao histórico de uma assinatura|\n\n### Recebimento de Notificações e Parcelamento\n##### Comandos disponíveis:\nClique no comando desejado para acessar sua documentação.\n\n| Comando| Descrição |\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------|\n| [getNotification](https://dev.gerencianet.com.br/docs/notificacoes-recebendo) | Retorna o histórico de notificações enviadas a uma determinada transação                                                                |\n| [getInstallments](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) | Listar parcelas, de acordo com a bandeira do cartão de crédito. Bandeiras disponíveis: visa, mastercard, amex, elo e hipercard. |\n\n### Cobranças via Pix\n##### Comandos disponíveis:\nClique no comando desejado para acessar sua documentação.\n\n| Comando | Descrição |\n|--------------------------|----------------------------------------|\n| [pixCreateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-cobran-a-imediata-com-txid-) | Criar cobrança |\n| [pixUpdateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-revisar-cobran-a) | Revisar cobrança |\n| [pixCreateImmediateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-cobran-a-imediata-sem-txid-) | Criar cobrança imediata |\n| [pixDetailCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-cobran-a) | Consultar cobrança |\n| [pixListCharges](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-lista-de-cobran-as) | Consultar lista de cobranças |\n| [pixDetail](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-pix) | Consultar Pix |\n| [pixListReceived](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-pix-recebidos) | Consultar Pix recebidos |\n| [pixSend](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-requisitar-envio-de-pix) | Requisitar envio de Pix. |\n| [pixDevolution](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-solicitar-devolu-o) | Solicitar devolução. |\n| [pixDetailDevolution](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-devolu-o) | Consultar devolução |\n| [pixConfigWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-configurar-o-webhook-pix) | Configurar o Webhook Pix |\n| [pixGetWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-exibir-informa-es-do-wehook-pix) | Exibir informações do Wehook Pix |\n| [pixListWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-lista-de-webhooks) | Consultar lista de webhooks |\n| [pixDeleteWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-cancelar-o-webhook-pix) | Cancelar o webhook Pix |\n| [pixCreateLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-location-do-payload) | Criar location do payload |\n| [pixListLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-locations-cadastradas) | Consultar locations cadastradas |\n| [pixDetailLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-recuperar-location-do-payload) | Recuperar location do payload |\n| [pixGenerateQRCode](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-gerar-qrcode-de-um-location) | Gerar QRCode de um location |\n| [pixUnsetTxid](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-desvincular-um-txid-de-uma-location) | Desvincular um txid de uma location |\n\n### Endpoints Exclusivos Gerencianet:\nClique no comando desejado para acessar sua documentação.\n\n| Comando | Descrição |\n|--------------------------|----------------------------------------|\n| [gnCreateEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-chave-evp) | Criar chave evp |\n| [gnListEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-listar-chaves-evp) | Listar chaves evp |\n| [gnDeleteEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-remover-chave-evp) | Remover chave evp |\n| [gnDetailBalance](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-buscar-o-saldo-da-conta) | Buscar o saldo da conta |\n| [gnUpdateSettings](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-modificar-configura-es-da-conta) | Criar/modificar configurações da conta |\n| [gnDetailSettings](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-listar-configura-es-da-conta) | Listar configurações da conta |","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"606f2ca7c5ba9100787834b2","project":"575aeffae12cf20e002f306c","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","61473375119247002a9c14d7"],"_id":"606f2ca7c5ba9100787834c6","project":"575aeffae12cf20e002f306c","createdAt":"2016-06-10T16:51:06.080Z","releaseDate":"2016-06-10T16:51:06.080Z","__v":3,"forked_from":"575aeffae12cf20e002f306f"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Instalação da API (SDK's)","slug":"instalação-da-api-sdks","order":7,"from_sync":false,"reference":false,"_id":"606f2ca6c5ba91007878343d","createdAt":"2017-03-10T12:37:05.075Z","project":"575aeffae12cf20e002f306c","version":"606f2ca7c5ba9100787834c6","__v":0},"user":"5cd2cff826c124005d237439","createdAt":"2019-06-24T12:08:32.872Z","__v":0,"parentDoc":null}

Introdução

Você encontra aqui as nossas SDK's para integração com a API Pix e API Boletos (Bolix) da Gerencianet e um tutorial de como instalar cada uma.

Aqui você encontra a lista de comandos/endpoints disponíveis em nossas SDKs. [block:callout] { "type": "info", "body": "Os nomes das funções são os mesmos independente da SDK/linguagem utilizada.", "title": "Atenção!" } [/block] Sumário: 1. [Cobranças via Boleto ou Cartão](#section-cobran-as-via-boleto-ou-cart-o-) 2. [Cobranças via Carnê](#section-cobran-as-via-carn-) 3. [Cobranças via Assinaturas (Cobrança Recorrente)](#section-cobran-as-via-assinaturas-cobran-a-recorrente-) 4. [Recebimento de Notificações e Parcelamento](#section-recebimento-de-notifica-es-e-parcelamento-) 5. [Cobranças via Pix](#section-cobran-as-via-pix-) 6. [Endpoints Exclusivos Gerencianet](#section-endpoints-exclusivos-gerencianet-) Veja como é fácil instalar nossa SDK e integrar em seu site ou sistema. Disponibilizamos em 10 (dez) linguagens: ### Nossas SDKs - [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) - [.NET Core](https://dev.gerencianet.com.br/docs/net-core) - [Java](https://dev.gerencianet.com.br/docs/instalacao-sdk-java) - [Delphi](https://dev.gerencianet.com.br/docs/instalacao-sdk-delphi) - [Go](https://dev.gerencianet.com.br/docs/instalacao-sdk-go) - [TypeScript](https://dev.gerencianet.com.br/docs/typescript) - [Dart](https://dev.gerencianet.com.br/docs/dart) - [Flutter](https://dev.gerencianet.com.br/docs/flutter) - [Android](https://dev.gerencianet.com.br/docs/android) ### Cobranças via Boleto ou Cartão ##### Comandos disponíveis: Clique no comando desejado para acessar sua documentação. | Comando | Descrição | |------------------------|--------------------------------------------------------------------------------------| | [createCharge](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-2-1-criar-transa-o) | Criar nova cobrança| | [detailCharge](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-6-retornar-informa-es-sobre-transa-o) | Retornar informações de cobrança existente| | [updateChargeMetadata](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) | Incluir informações como "notification_url" e "custom_id" em uma cobrança existente | | [updateBillet](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-1-alterar-data-de-vencimento-de-boleto-banc-rio) | Alterar data de vencimento de uma cobrança existente| | [cancelCharge](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-2-cancelar-determinada-transa-o) | Cancelar uma cobrança existente | | payCharge [Boleto](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-2-2-associar-forma-de-pagamento-via-boleto) ou [Cartão](https://dev.gerencianet.com.br/docs/pagamento-com-cartao#section-2-2-associe-forma-de-pagamento-via-cart-o) | Associa método de pagamento (boleto ou cartão) à uma cobrança já criada | | [resendBillet](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-4-reenviar-boleto-banc-rio-por-e-mail) | Reenvio do boleto bancário para o e-mail desejado| | [createChargeHistory](https://dev.gerencianet.com.br/docs/pagar-boleto-outros-endpoints#section-5-acrescentar-informa-es-ao-hist-rico-da-transa-o) | Acrescentar descrição ao histórico de uma cobrança| | [linkCharge](https://dev.gerencianet.com.br/docs/link-pagamento-criando#section-2-criando-um-link-de-pagamento) | Retorna um link para uma tela de pagamento da Gerencianet| | [updateChargeLink](https://dev.gerencianet.com.br/docs/link-outros-endpoints#section-1-alterar-determinados-par-metros-atributos-de-um-link-de-pagamento-existente) | Alterar determinados parâmetros/atributos de um link de pagamento existente| | [createChargeBalanceSheet]() | Define que a cobrança será do tipo boleto balancete | | [settleCharge](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-1-marcar-como-pago-determinada-transa-o) | Permite marcar como pago (baixa manual) uma determinada cobrança| | oneStep [Boleto](https://dev.gerencianet.com.br/docs/gerar-boleto-bancario#section-1-cria-o-de-boleto-em-one-step-um-passo-) ou [Cartão](https://dev.gerencianet.com.br/docs/pagamento-com-cartao#section-1-cria-o-de-transa-o-por-cart-o-de-cr-dito-em-one-step-um-passo-) | Criar nova cobrança com pagador atribuido (boleto ou cartão)| ### Cobranças via Carnê ##### Comandos disponíveis: Clique no comando desejado para acessar sua documentação. |Comando| Descrição | |----------------------|---------------------------------------------------------------------------------| | [createCarnet](https://dev.gerencianet.com.br/docs/carnes-criando) | Cria um carnê | | [detailCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-1-retornar-informa-es-sobre-um-carn-) | Retorna informações de carnê existente| | [updateCarnetMetadata](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) | Incluir informações como "notification_url" e "custom_id" em um carnê existente | | [updateParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-3-alterar-data-de-vencimento-de-parcela-do-carn-) | Alterar data de vencimento de parcela específica de um carnê| | [cancelCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-4-cancelar-um-carn-) | Cancela um determinado carnê| | [cancelParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-5-cancelar-parcela-espec-fica-de-carn-) | Cancelamento de parcela específica de um carnê existente| | [resendCarnet](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-6-reenviar-carn-por-e-mail) | Reenviar carnê por e-mail | | [resendParcel](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-7-reenviar-parcela-espec-fica-de-carn-por-e-mail) | Reenviar por e-mail determinada parcela de um carnê | | [createCarnetHistory](https://dev.gerencianet.com.br/docs/carnes-outros-endpoints#section-8-acrescentar-informa-es-ao-hist-rico-do-carn-)| Acrescentar informações ao histórico de um carnê| | [settleCarnet] | Permite marcar como pago (baixa manual) em um determinado carnê | | [settleCarnetParcel](https://dev.gerencianet.com.br/docs/marcar-como-pago#section-2-2-marcar-como-pago-determinada-parcela-de-carn-) | Permite marcar como pago (baixa manual) uma determinada parcela de um carnê | ### Cobranças via Assinaturas (Cobrança Recorrente) ##### Comandos disponíveis: Clique no comando desejado para acessar sua documentação. | Comando | Descrição | |----------------------------|----------------------------------------------------------------------------------------------| | [createPlan](https://dev.gerencianet.com.br/docs/criando-assinaturas#section-1-crie-o-plano-de-assinatura)| Cria o plano de assinatura | | [getPlans](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-1-listar-os-planos-de-assinatura-existentes) | Retorna informações de um plano| | [updatePlan](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-8-editar-nome-do-plano-de-assinatura) | Permite a alteração (edição) do nome de um plano de assinatura pré-existente | | [deletePlan](https://dev.gerencianet.com.br/v1/docs/assinaturas-outros-endpoints#section-2-cancelar-plano-de-assinatura) | Cancela um plano de assinatura | | [createSubscription](https://dev.gerencianet.com.br/v1/docs/criando-assinaturas#section-2-crie-inscri-es-assinaturas-para-vincular-ao-plano) | Cria assinaturas para vincular a planos| | [detailSubscription](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-3-retornar-informa-es-de-assinatura-vinculada-a-um-plano) | Retorna informações de uma assinatura vinculada a um plano | | [cancelSubscription](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-4-cancelar-assinaturas-ativas-em-um-plano) | Cancelar inscrições ativas em um plano de assinaturas| | [updateSubscriptionMetadata](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-5-alterar-url-de-notifica-o-notification_url-e-ou-custom_id-de-assinaturas) | Alterar URL de notificação ("notification_url") e/ou "custom_id" em uma assinatura existente | | [paySubscription](https://dev.gerencianet.com.br/v1/docs/criando-assinaturas#section-3-defina-a-forma-de-pagamento-da-assinatura-e-os-dados-do-cliente)| Associa método de pagamento à uma assinatura já criada | | [createSubscriptionHistory](https://dev.gerencianet.com.br/docs/assinaturas-outros-endpoints#section-7-acrescentar-informa-es-ao-hist-rico-da-assinatura)| Acrescenta descrição ao histórico de uma assinatura| ### Recebimento de Notificações e Parcelamento ##### Comandos disponíveis: Clique no comando desejado para acessar sua documentação. | Comando| Descrição | |-----------------|-----------------------------------------------------------------------------------------------------------------------------------------| | [getNotification](https://dev.gerencianet.com.br/docs/notificacoes-recebendo) | Retorna o histórico de notificações enviadas a uma determinada transação | | [getInstallments](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) | Listar parcelas, de acordo com a bandeira do cartão de crédito. Bandeiras disponíveis: visa, mastercard, amex, elo e hipercard. | ### Cobranças via Pix ##### Comandos disponíveis: Clique no comando desejado para acessar sua documentação. | Comando | Descrição | |--------------------------|----------------------------------------| | [pixCreateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-cobran-a-imediata-com-txid-) | Criar cobrança | | [pixUpdateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-revisar-cobran-a) | Revisar cobrança | | [pixCreateImmediateCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-cobran-a-imediata-sem-txid-) | Criar cobrança imediata | | [pixDetailCharge](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-cobran-a) | Consultar cobrança | | [pixListCharges](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-lista-de-cobran-as) | Consultar lista de cobranças | | [pixDetail](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-pix) | Consultar Pix | | [pixListReceived](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-pix-recebidos) | Consultar Pix recebidos | | [pixSend](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-requisitar-envio-de-pix) | Requisitar envio de Pix. | | [pixDevolution](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-solicitar-devolu-o) | Solicitar devolução. | | [pixDetailDevolution](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-devolu-o) | Consultar devolução | | [pixConfigWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-configurar-o-webhook-pix) | Configurar o Webhook Pix | | [pixGetWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-exibir-informa-es-do-wehook-pix) | Exibir informações do Wehook Pix | | [pixListWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-lista-de-webhooks) | Consultar lista de webhooks | | [pixDeleteWebhook](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-cancelar-o-webhook-pix) | Cancelar o webhook Pix | | [pixCreateLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-location-do-payload) | Criar location do payload | | [pixListLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-consultar-locations-cadastradas) | Consultar locations cadastradas | | [pixDetailLocation](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-recuperar-location-do-payload) | Recuperar location do payload | | [pixGenerateQRCode](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-gerar-qrcode-de-um-location) | Gerar QRCode de um location | | [pixUnsetTxid](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-desvincular-um-txid-de-uma-location) | Desvincular um txid de uma location | ### Endpoints Exclusivos Gerencianet: Clique no comando desejado para acessar sua documentação. | Comando | Descrição | |--------------------------|----------------------------------------| | [gnCreateEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-chave-evp) | Criar chave evp | | [gnListEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-listar-chaves-evp) | Listar chaves evp | | [gnDeleteEvp](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-remover-chave-evp) | Remover chave evp | | [gnDetailBalance](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-buscar-o-saldo-da-conta) | Buscar o saldo da conta | | [gnUpdateSettings](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-criar-modificar-configura-es-da-conta) | Criar/modificar configurações da conta | | [gnDetailSettings](https://dev.gerencianet.com.br/docs/api-pix-endpoints#section-listar-configura-es-da-conta) | Listar configurações da conta |