# Mundipagg API Documentation

> Documentação da Mundipagg

## Guides
- [Bem-vindo à Mundipagg!](https://docs.mundipagg.com/docs/getting-started.md): Aqui, você transaciona de forma rápida, simples e segura.   Pensamos em cada passo para que você tenha uma experiência única e consiga transacionar com poucas linhas de código.  Nesta documentação você pode explorar todos os produtos e funcionalidades que a nossa API oferece e adaptá-los ao seu sistema, seja ele no browser, mobile ou sistema interno.
- [Cobrança](https://docs.mundipagg.com/docs/cobrança.md)
- [Pedido](https://docs.mundipagg.com/docs/pedido.md)
- [Multimeios](https://docs.mundipagg.com/docs/multimeios.md)
- [Multicompradores](https://docs.mundipagg.com/docs/multicompradores.md)
- [Split](https://docs.mundipagg.com/docs/pedidos-com-split.md)
- [Pedidos abertos](https://docs.mundipagg.com/docs/pedidos-abertos.md)
- [Meios de pagamento](https://docs.mundipagg.com/docs/meios-de-pagamento.md)
- [Cartão de crédito](https://docs.mundipagg.com/docs/cartão-de-crédito.md)
- [Cartão de débito](https://docs.mundipagg.com/docs/cartão-de-débito.md)
- [Voucher](https://docs.mundipagg.com/docs/voucher.md)
- [Boleto](https://docs.mundipagg.com/docs/boleto.md)
- [Transferência bancária](https://docs.mundipagg.com/docs/transferência-entre-contas.md)
- [SafetyPay](https://docs.mundipagg.com/docs/safetypay.md)
- [Google Pay ™](https://docs.mundipagg.com/docs/google-pay-tm.md)
- [Cash](https://docs.mundipagg.com/docs/cash-1.md)
- [Checkout](https://docs.mundipagg.com/docs/checkouts.md)
- [Pix](https://docs.mundipagg.com/docs/pix-1.md)
- [Planos](https://docs.mundipagg.com/docs/plano.md)
- [Assinaturas](https://docs.mundipagg.com/docs/assinatura.md)
- [Faturas](https://docs.mundipagg.com/docs/fatura.md)
- [Esquemas de precificação dos itens](https://docs.mundipagg.com/docs/price-scheme.md)
- [Mundi.js](https://docs.mundipagg.com/docs/mundijs.md)
- [Checkout](https://docs.mundipagg.com/docs/checkout-1.md)
- [Opção Lightbox](https://docs.mundipagg.com/docs/checkout-lightbox.md)
- [Envio de Checkout](https://docs.mundipagg.com/docs/checkout-por-e-mail.md)
- [Carteira de clientes](https://docs.mundipagg.com/docs/carteira-de-clientes.md)
- [Wallets](https://docs.mundipagg.com/docs/wallets.md)
- [Card Updater](https://docs.mundipagg.com/docs/card-updater.md)
- [Retentativa automática](https://docs.mundipagg.com/docs/retentativa-automática.md)
- [Retentativa offline](https://docs.mundipagg.com/docs/retentativa-offline.md)
- [Simulador de Cartão de Crédito](https://docs.mundipagg.com/docs/simulador-de-cartão-de-crédito.md)
- [Simulador de Boleto](https://docs.mundipagg.com/docs/simulador-de-boleto.md)
- [Simulador de Cartão de Débito](https://docs.mundipagg.com/docs/simulador-de-cartão-de-débito.md)
- [Simulador de Voucher](https://docs.mundipagg.com/docs/simulador-de-voucher.md)
- [Simulador de PIX](https://docs.mundipagg.com/docs/simulador-pix.md)
- [O que são?](https://docs.mundipagg.com/docs/dados-gerais.md)
- [O que são?](https://docs.mundipagg.com/docs/o-que-são.md)
- [IP Whitelist](https://docs.mundipagg.com/docs/ip-whitelist.md)
- [Cancelamento Garantido](https://docs.mundipagg.com/docs/cancelamento-garantido.md)
- [SDK C#](https://docs.mundipagg.com/docs/sdk-c.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK PHP](https://docs.mundipagg.com/docs/sdk-php.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK Ruby](https://docs.mundipagg.com/docs/sdk-ruby.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK Python](https://docs.mundipagg.com/docs/sdk-python.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK NodeJS](https://docs.mundipagg.com/docs/sdk-nodejs.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK Go](https://docs.mundipagg.com/docs/sdk-go.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [SDK Java](https://docs.mundipagg.com/docs/sdk-java.md): SDK(Software Development Kit) é um conjunto de ferramentas de desenvolvimento de software capazes de facilitar a integração de sistemas em diferentes linguagens com a API da Mundipagg.
- [API](https://docs.mundipagg.com/docs/tutoriais.md)
- [Criando um pedido](https://docs.mundipagg.com/docs/criando-um-pedido.md)
- [Criando uma assinatura](https://docs.mundipagg.com/docs/criando-uma-assinatura.md)
- [Gerenciando sua Wallet](https://docs.mundipagg.com/docs/gerenciando-sua-wallet.md)
- [Gerenciando sua carteira de clientes](https://docs.mundipagg.com/docs/gerenciando-sua-carteira-de-clientes.md)
- [Módulos](https://docs.mundipagg.com/docs/módulos.md)
- [Magento 1](https://docs.mundipagg.com/docs/magento-1.md)
- [Magento 2](https://docs.mundipagg.com/docs/magento-2.md)
- [Apps de Integração](https://docs.mundipagg.com/docs/apps-de-integração.md)
- [Oracle Commerce Cloud](https://docs.mundipagg.com/docs/oracle-commerce-cloud.md): _Produto em fase Beta_
- [Vtex](https://docs.mundipagg.com/docs/vtex.md): _Produto em fase Beta_
- [Shopify](https://docs.mundipagg.com/docs/shopify.md)
- [Visão Geral sobre Idempotência](https://docs.mundipagg.com/docs/o-que-é.md)
- [Hub](https://docs.mundipagg.com/docs/hub.md)
- [Desenvolvendo Aplicativos](https://docs.mundipagg.com/docs/hub-development.md): Desenvolvendo aplicativos e integrações com a Mundipagg através do Hub.
- [Ações e Eventos](https://docs.mundipagg.com/docs/acoes-e-eventos.md): Permissões possíveis para um aplicativo.
- [Instalação do App](https://docs.mundipagg.com/docs/instalacao-app.md): Entenda o fluxo de instalação de um app interno e externo.
- [Desinstalação do App](https://docs.mundipagg.com/docs/webhook-desinstalacao.md): Entenda o fluxo de desinstalação de um app.
- [Interagindo com a Mundipagg](https://docs.mundipagg.com/docs/interagindo-mundipagg.md): Executando ações e recebendo eventos através da sua integração.
- [Criando um App no Hub](https://docs.mundipagg.com/docs/criando-app.md): Para desenvolver um app no Hub, a primeira etapa é criar um app e configura-lo em nossa plataforma de desenvolvimento.
- [Configurando o App](https://docs.mundipagg.com/docs/configurando-app.md): Descreva e configure o seu app para que ele funcione corretamente.
- [Validando as Requisições do Hub](https://docs.mundipagg.com/docs/hub-signature.md): Garanta que a comunicação é segura entre o seu serviço e o Hub.
- [Criando Links Direto para o Dashboard da Mundipagg](https://docs.mundipagg.com/docs/link-dash.md): Crie links para a conta do lojista em nosso dashboard permitindo o redirecionamento para os detalhes dos itens.
- [Lista de Eventos](https://docs.mundipagg.com/docs/lista-eventos.md): Lista e definição de eventos no Hub comparados com a API Mundipagg.
- [Lista de Ações](https://docs.mundipagg.com/docs/lista-acoes.md): Lista e definição de ações no Hub comparados com a API Mundipagg.
- [Firewall](https://docs.mundipagg.com/docs/firewall.md): Permita a comunicação de nossa API com os seus serviços.
- [Botão de Instalação de App Externo](https://docs.mundipagg.com/docs/botao-instalacao.md): Coloque o nosso botão de integração no seu serviço para permitir a integração.

## API Reference
- [Introdução](https://docs.mundipagg.com/reference/introdução.md): Bem vindo a API Reference da Mundipagg !
- [Segurança](https://docs.mundipagg.com/reference/segurança.md): Normas PCI Compliance
- [Autenticação](https://docs.mundipagg.com/reference/autenticação.md): Obtendo sua Chave de API
- [Erros](https://docs.mundipagg.com/reference/erros.md): HTTP Status Codes
- [Paginação](https://docs.mundipagg.com/reference/paginação.md)
- [Metadata](https://docs.mundipagg.com/reference/metadata.md)
- [Telefones](https://docs.mundipagg.com/reference/telefones.md): O objeto `phones` possui os seguintes atributos:
- [Entregas](https://docs.mundipagg.com/reference/entregas.md): O objeto `shipping` contém informações referentes à **entrega do produto** ao comprador, e possui os seguintes atributos:
- [Facilitadores de pagamento (Dados de Subadquirente)](https://docs.mundipagg.com/reference/facilitadores-de-pagamento.md): Por determinação do **Banco Central e das bandeiras** os cliente de E-commerce que se enquadram na categoria de **Facilitadores de Pagamento**  deverão enviar dados referentes aos seus **sub credenciados**  em cada requisição transacional.
- [Visão Geral sobre Wallet](https://docs.mundipagg.com/reference/wallet-overview.md): A  API Mundipagg fornece o recurso **Wallet**, que permite o armazenamento de cartões associados a um comprador, viabilizando a realização de **compras com um clique**, por exemplo. [Saiba mais sobre Wallet vs. Carteira de Clientes](https://docs.mundipagg.com/docs/wallets).
- [Clientes](https://docs.mundipagg.com/reference/clientes.md): O objeto `customer` possibilita a criação e gerenciamento de uma [Carteira de Clientes](https://docs.mundipagg.com/docs/carteira-de-clientes). Um `customer` possui os seguintes atributos:
- [Criar cliente](https://docs.mundipagg.com/reference/criar-cliente.md): Este recurso cria um objeto `customer` que representa um cliente.
- [Obter cliente](https://docs.mundipagg.com/reference/obter-cliente.md): Através do identificador do cliente (`customer_id`) é possível recuperar seus dados.
- [Editar cliente](https://docs.mundipagg.com/reference/editar-cliente.md): Com o verbo _HTTP PUT_, através do identificador do cliente (`customer_id`) é possível atualizar informações referentes ao cliente.
- [Listar clientes](https://docs.mundipagg.com/reference/listar-clientes.md): Este recurso permite a obtenção da **carteira de clientes** do lojista. Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Cartões](https://docs.mundipagg.com/reference/cartões.md): O objeto `card` descreve um cartão (crédito, voucher ou private label) associado a um `customer`. Este recurso viabiliza a criação de uma **Wallet**, que representa todos os `card` associados a um `customer`.  [Saiba mais sobre Wallet](https://docs.mundipagg.com/docs/wallets).
- [Criar cartão](https://docs.mundipagg.com/reference/criar-cartao.md): Este recurso cria um `card` associado ao `customer` através do `customer_id` informado.
- [Obter cartão](https://docs.mundipagg.com/reference/obter-cartao.md): Possibilita a recuperação de um `card` através dos identificadores do cartão (`card_id`) e do cliente associado (`customer_id`), informados por parâmetro.
- [Editar cartão](https://docs.mundipagg.com/reference/editar-cartao.md): Com o verbo _HTTP PUT_, através do identificador do cartão (`card_id`) e do identificador do cliente ao qual o mesmo está associado (`customer_id`) é possível alterar dados do cartão informado.
- [Excluir cartão](https://docs.mundipagg.com/reference/excluir-cartao.md): Com o verbo _HTTP DELETE_, através do identificador do cartão (`card_id`) e do identificador do cliente (`customer_id`) ao qual o cartão está associado, é possível remover o cartão da **Wallet** do cliente.
- [Renovar cartão](https://docs.mundipagg.com/reference/renovar-cartão.md): Com o verbo _HTTP POST_, através do identificador do cartão (`card_id`) e do identificador do cliente (`customer_id`) ao qual o cartão está associado, é possível renovar o cartão da **Wallet** do cliente, utilizando a funcionalidade manual do Card Updater.
- [Listar cartões](https://docs.mundipagg.com/reference/listar-cartoes.md): Este recurso permite a recuperação da **Wallet** contendo todos os cartões do cliente através do seu identificador (`customer_id`).
- [Criar Token Cartao](https://docs.mundipagg.com/reference/criar-token-cartao.md)
- [Endereços](https://docs.mundipagg.com/reference/enderecos.md): O objeto `address`  representam endereços associados aos `customers`. Um `address` possui os seguintes atributos:
- [Criar endereço](https://docs.mundipagg.com/reference/criar-endereço.md): Para a criação de um `address` é necessário informar o `customer_id` do cliente ao qual será associado o endereço.
- [Obter endereço](https://docs.mundipagg.com/reference/obter-endereço.md): Através dos identificadores do cliente (`customer_id`) e do endereço (`address_id`) é possível obter o endereço do cliente.
- [Editar endereço](https://docs.mundipagg.com/reference/editar-endereço.md): Com o verbo _HTTP PUT_, através dos identificadores do cliente (`customer_id`) e do endereço (`address_id`) é possível atualizar informações complementares do endereço.
- [Listar endereços](https://docs.mundipagg.com/reference/listar-endereços.md): Este recurso permite a recuperação dos endereços de um determinado cliente através do seu identificador(`customer_id`). Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Excluir endereço](https://docs.mundipagg.com/reference/excluir-endereço.md): Com o verbo _HTTP DELETE_, através do identificador do endereço(`address_id`) e do identificador do cliente (`customer_id`) ao qual o endereço está associado, é possível remover o endereço da **Wallet** do cliente.
- [BIN](https://docs.mundipagg.com/reference/bins.md): Os seis primeiros dígitos de um número de cartão (incluindo o dígito **MII** inicial) são conhecidos como o **número de identificação do emissor** (**IIN**) ou **número de identificação do banco** (**BIN**). Estes números identificam a instituição que emitiu o cartão ao titular do cartão. O restante do número é alocado pelo emissor. O objeto `bin` contém os seguintes atributos:
- [Obter informações do BIN](https://docs.mundipagg.com/reference/obter-informações-bin.md)
- [Visão Geral sobre Pagamento](https://docs.mundipagg.com/reference/pagamento-overview.md): Em nossos [pedidos](https://docs.mundipagg.com/v1/reference#criar-pedido) e  [cobranças](https://docs.mundipagg.com/reference#cobran%C3%A7as), dentro possuímos o nó `payment` responsável pelas instruções de pagamento podendo comportar os meios de pagamento: `credit_card`, `voucher`, `boleto`, `bank_transfer` e `safetypay`. Especificamente para **pedidos** está disponível também o meio de pagamento `checkout`.
- [Cartão de crédito](https://docs.mundipagg.com/reference/meio-de-pagamento-cartão-de-crédito.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **cartão de crédito**, devemos incluir o objeto `credit_card` dentro do nó `payment`, assim como a propriedade `"payment_method": "credit_card"`. O objeto `credit_card` contêm os seguintes atributos:
- [Cartão de débito](https://docs.mundipagg.com/reference/cartão-de-débito-1.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **cartão de débito**, devemos incluir o objeto `debit_card` dentro do nó `payment`, assim como a propriedade `"payment_method": "debit_card"`. O objeto `debit_card` contêm os seguintes atributos:
- [Cartão private label](https://docs.mundipagg.com/reference/cartão-private-label.md): Para criar um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **cartão private label**, devemos incluir o objeto `private_label` dentro do nó `payment`, assim como a propriedade `"payment_method": "private_label"`. O objeto `private_label` contêm os seguintes atributos:
- [Voucher](https://docs.mundipagg.com/reference/meio-de-pagamento-voucher.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **voucher**, devemos incluir o objeto `voucher` dentro do nó `payment`, assim como a propriedade `"payment_method": "voucher"`. O objeto `voucher` contém as seguintes propriedades:
- [Boleto](https://docs.mundipagg.com/reference/meio-de-pagamento-boleto.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **boleto**, devemos incluir o objeto `boleto` dentro do nó `payment`, assim como a propriedade `"payment_method": "boleto"`. O objeto `boleto` contém as seguintes propriedades:
- [Transferência bancária](https://docs.mundipagg.com/reference/meio-de-pagamento-transferência-entre-contas.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **transferência bancária**, devemos incluir a propriedade `"payment_method": "bank_transfer"` dentro do nó `payment`, e caso necessário o objeto `bank_transfer`. O objeto `bank_transfer` tem as seguintes propriedades:
- [SafetyPay](https://docs.mundipagg.com/reference/meio-de-pagamento-safetypay.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **SafetyPay**, devemos incluir a propriedade `"payment_method": "safetypay"` dentro do nó `payment`.
- [Google Pay™](https://docs.mundipagg.com/reference/google-pay.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **google pay**, devemos incluir o objeto `credit_card` dentro do nó `payment`, assim como a propriedade `"payment_method": "credit_card"`. Além disso, o objeto `credit_card` deve conter os atributos de `token` e `google_pay`. O objeto `token` possui os seguintes atributos:
- [Cash](https://docs.mundipagg.com/reference/cash.md): Para criar uma [cobrança](https://docs.mundipagg.com/v1/reference#criar-cobranca) ou um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **cash**, devemos incluir o objeto `cash` dentro do nó `payment`, assim como a propriedade `"payment_method": "cash"`. O objeto `cash` contém as seguintes propriedades:
- [Checkout](https://docs.mundipagg.com/reference/checkout.md): Para criar um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **checkout**, devemos incluir o objeto `checkout` dentro do nó `payment`, assim como a propriedade `"payment_method": "checkout"`. O objeto `checkout` contêm as seguintes propriedades:
- [Pix](https://docs.mundipagg.com/reference/pix.md): Para criar um [pedido](https://docs.mundipagg.com/v1/reference#criar-pedido) com **Pix**, devemos incluir o objeto `Pix` dentro do nó `payment`, assim como a propriedade `"payment_method": "Pix"`.  O objeto `Pix` contém as seguintes propriedades:
- [Cobranças](https://docs.mundipagg.com/reference/cobranças.md): Para realizar cobranças de cartão de crédito ou boleto, você deve criar um objeto `charge`. Este objeto tem os seguintes atributos:
- [Capturar cobrança](https://docs.mundipagg.com/reference/capturar-cobrança.md)
- [Obter cobrança](https://docs.mundipagg.com/reference/obter-cobrança.md)
- [Editar metadados da cobrança](https://docs.mundipagg.com/reference/editar-metadados-da-cobrança.md)
- [Editar cartão de cobrança](https://docs.mundipagg.com/reference/editar-cartão-de-cobrança.md): Esse recurso só pode ser chamado quando o cartão a ser editado teve a transação não autorizada.
- [Editar data de vencimento da cobrança](https://docs.mundipagg.com/reference/editar-data-de-vencimento-da-cobrança.md)
- [Editar método de pagamento](https://docs.mundipagg.com/reference/editar-método-de-pagamento.md)
- [Cancelar cobrança](https://docs.mundipagg.com/reference/cancelar-cobranca.md)
- [Listar cobranças](https://docs.mundipagg.com/reference/listar-cobranças.md)
- [Retentar uma cobrança manualmente](https://docs.mundipagg.com/reference/rententar-uma-cobrança.md)
- [Confirmar cobrança (cash)](https://docs.mundipagg.com/reference/capturar-cobrança-2.md): Para a confirmação de cobranças com meio de pagamento `cash` com o status `pending`.
- [Pedidos](https://docs.mundipagg.com/reference/pedidos.md): Para realizar pedidos de cartão de crédito ou boleto, você deve criar um objeto `order`. Este objeto tem os seguintes atributos:
- [Criar pedido](https://docs.mundipagg.com/reference/criar-pedido.md)
- [Incluir cobrança no pedido](https://docs.mundipagg.com/reference/incluir-cobranca-no-pedido.md): Enquanto um pedido estiver **aberto**, é possível adicionar novas cobranças utilizando o `order_id` na criação de uma cobrança.
- [Criar pedido multimeios](https://docs.mundipagg.com/reference/criar-pedido-multimeios.md): Neste caso você inclui mais de um objeto na coleção de **payments**. Desta maneira você pode realizar pedido com diversos cartões ou combinando diferentes meios de pagamento.
- [Criar pedido multicompradores](https://docs.mundipagg.com/reference/criar-pedido-multicompradores.md): Neste caso você pode incluir um cliente (`customer`) dentro do nó de pagamento (`payment`). Caso um nó `payment` não possua um nó `customer` dentro, assumiremos que o pagador dele é o mesmo `customer` do pedido.
- [Obter pedido](https://docs.mundipagg.com/reference/obter-pedido.md)
- [Editar metadados do pedido](https://docs.mundipagg.com/reference/editar-metadados-do-pedido.md)
- [Fechar um pedido](https://docs.mundipagg.com/reference/fechar-um-pedido.md): Utilizado para fechar um pedido para que não seja mais possível adicionar cobranças.
- [Listar pedidos](https://docs.mundipagg.com/reference/listar-pedidos.md)
- [Criar pedido com meio de pagamento Checkout](https://docs.mundipagg.com/reference/criar-pedido-checkout.md)
- [Criar pedido com meio de pagamento Checkout multimeios](https://docs.mundipagg.com/reference/criar-pedido-com-meio-de-pagamento-checkout-multimeios.md): Neste caso, para habilitar o multimeios, você precisa incluir o array `accepted_multi_payment_methods` dentro do objeto `checkout`. Desta maneira você pode fornecer ao seu cliente final a possibilidade de pagar com dois cartões ou cartão mais boleto.
- [Item do pedido](https://docs.mundipagg.com/reference/item-do-pedido.md): Com a criação de um pedido **aberto**, é possível que itens sejam gerenciados. O objeto `item` do pedido tem os seguintes atributos:
- [Incluir item](https://docs.mundipagg.com/reference/incluir-item-pedido.md): Quando um pedido está **aberto**, você pode incluir itens nele.
- [Editar item do pedido](https://docs.mundipagg.com/reference/editar-item-do-pedido.md): Quando um pedido está **aberto**, você pode editar os itens dele.
- [Deletar item](https://docs.mundipagg.com/reference/deletar-item.md): Quando um pedido está **aberto**, você pode excluir itens dele.
- [Remover todos os itens](https://docs.mundipagg.com/reference/remover-todos-os-itens.md): Quando um pedido está **aberto**, você pode remover todos os itens dele.
- [Obter item do pedido](https://docs.mundipagg.com/reference/obter-item-do-pedido.md): Obter um item especifico dentro de um pedido especifico.
- [Visão Geral sobre Antifraude](https://docs.mundipagg.com/reference/visão-geral-sobre-antifraude.md): Para criar  [pedidos](https://docs.mundipagg.com/v1/reference#criar-pedido) alguns dados adicionais são obrigatórios para análise.
- [Criar pedido (com Antifraude)](https://docs.mundipagg.com/reference/criar-pedido-antifraude.md)
- [Visão Geral da Recorrência](https://docs.mundipagg.com/reference/recorrencia-overview.md): A API Mundipagg provê ferramentas para você gerenciar cobranças recorrentes de forma fácil.
- [Precificação](https://docs.mundipagg.com/reference/precificacao.md): O objeto `price_scheme` dá suporte para criação de diferentes formas de precificação de assinaturas, adequadas a serviços distintos, facilitando a criação de modelos de preços para o seu clientes. O objeto `price_scheme` pode conter ainda um objeto `price_brackets` que dá suporte para criação de faixas distintas de preço de acordo com o serviço prestado. [Saiba mais sobre os modelos de precificação acessando nossa documentação](https://docs.mundipagg.com/docs/price-scheme).   O objeto `price_scheme` contêm os seguintes atributos:
- [Unidade](https://docs.mundipagg.com/reference/unidade.md): No `scheme_type` : `unit`, preço final é baseado no consumo **direto** de unidades.
- [Pacote](https://docs.mundipagg.com/reference/pacote.md): No `scheme_type` : `package`, o preço final é baseado no consumo direto de um **bloco** de unidades.
- [Volume](https://docs.mundipagg.com/reference/volume.md): No `scheme_type` : `volume`, o preço final é baseado na **faixa de consumo final** de unidades.
- [Faixa](https://docs.mundipagg.com/reference/renque.md): No `scheme_type` : `tier`,  o preço final é baseado nas faixa de consumo de unidades, **de forma cumulativa**.
- [Planos](https://docs.mundipagg.com/reference/planos.md): O objeto `plan` representa um _template_ pré-definido de assinatura, isto é, um **plano**, que facilita a criação de uma nova assinatura para um cliente. Saiba mais sobre planos acessando nossa [documentação](https://docs.mundipagg.com/docs/plano). O objeto `plan` possui os seguintes atributos:
- [Criar plano](https://docs.mundipagg.com/reference/criar-plano.md): Este recurso possibilita a criação de um `plan` que poderá ser utilizado futuramente para a criação de uma assinatura.
- [Obter plano](https://docs.mundipagg.com/reference/obter-plano.md): A partir do identificador de um plano criado (`plan_id`) é possível recuperar as informações deste plano.
- [Editar metadados do plano](https://docs.mundipagg.com/reference/editar-metadados-do-plano.md): Com o verbo _HTTP PATCH_, através do identificador do plano (`plan_id`) é possível atualizar o objeto `metadata` do plano.
- [Editar plano](https://docs.mundipagg.com/reference/editar-plano.md): Com o verbo HTTP PUT, através do identificador do plano (`plan_id`)  é possível atualizar os dados do plano.
- [Excluir plano](https://docs.mundipagg.com/reference/excluir-plano.md): Com o verbo HTTP DELETE, através do identificador do plano (`plan_id`) é possível excluir um plano.
- [Listar planos](https://docs.mundipagg.com/reference/listar-planos.md): Este recurso permite listar seus planos. Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Assinaturas](https://docs.mundipagg.com/reference/assinaturas.md): O objeto `subscription` é uma recorrência em si, que possibilita a cobrança do clientes com intervalos pré determinados, sem que seja necessário criar essa regra de negócio do seu lado. O objeto `subscription` contêm os seguintes atributos:
- [Criar assinatura avulsa](https://docs.mundipagg.com/reference/cria-assinatura-avulsa.md): Fornecemos a possibilidade de criação de uma assinatura (`subscription`) sem a necessidade de criação de um plano (`plan`).
- [Criar assinatura de plano](https://docs.mundipagg.com/reference/criar-assinatura-de-plano.md): Fornecemos a possibilidade de criação de uma assinatura (`subscription`) a partir de plano (`plan`).
- [Obter assinatura](https://docs.mundipagg.com/reference/obter-assinatura.md): Este recurso possibilita, através do identificador da assinatura (`subscription_id`), recuperar as informações da assinatura.
- [Editar cartão da assinatura](https://docs.mundipagg.com/reference/editar-cartão-da-assinatura.md): Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar o cartão utilizado para pagamento da assinatura.
- [Editar meio de pagamento da assinatura](https://docs.mundipagg.com/reference/editar-meio-de-pagamento-da-assinatura.md): Com o verbo HTTP PATCH, através do identificador da assinatura (`subscription_id`) é possível atualizar o meio de pagamento da assinatura.
- [Editar data de faturamento da assinatura](https://docs.mundipagg.com/reference/editar-data-de-faturamento-da-assinatura.md): Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar a data de faturamento da assinatura.
- [Editar metadados da assinatura](https://docs.mundipagg.com/reference/editar-metadados-da-assinatura.md): Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar o objeto `metadata` da assinatura.
- [Editar afiliação da assinatura no gateway](https://docs.mundipagg.com/reference/editar-gateway-affiliation-id-da-assinatura.md)
- [Cancelar assinatura](https://docs.mundipagg.com/reference/cancelar-assinatura.md): Com o verbo HTTP DELETE, através do identificador da assinatura (`subscription_id`) é possível cancelar a assinatura.
- [Listar assinaturas](https://docs.mundipagg.com/reference/listar-assinaturas.md): Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Editar data de início da assinatura](https://docs.mundipagg.com/reference/editar-data-de-início-da-assinatura.md): Com o verbo _HTTP PATCH_, através do identificador da assinatura (`subscription_id`) é possível atualizar a data de início da assinatura.
- [Ativar faturamento manual](https://docs.mundipagg.com/reference/ativar-faturamento-manual.md): Configuração da assinatura que indica se o faturamento será feito de forma `manual` ou `automática`. `Caso esteja ativa`, as faturas não serão geradas automaticamente pelo nosso sistema, ficando a cargo do lojista realizar o faturamento pelo endpoint [Criar Fatura](https://docs.mundipagg.com/reference#criar-fatura).
- [Desativar faturamento manual](https://docs.mundipagg.com/reference/desativar-faturamento-manual.md): Configuração da assinatura que indica se o faturamento será feito de forma `manual` ou `automática`. `Caso esteja desativada`, as faturas serão geradas automaticamente pelo nosso sistema.
- [Item da assinatura](https://docs.mundipagg.com/reference/item-da-assinatura.md): Um objeto `subscription` poderá ser compostas por um ou mais `items`. Cada objeto de `items` é composto pelos seguintes atributos:
- [Incluir item](https://docs.mundipagg.com/reference/incluir-item-da-assinatura.md): Através do identificador da assinatura (`subscription_id`) é possível incluir itens na assinatura do cliente.
- [Listar itens de uma assinatura](https://docs.mundipagg.com/reference/listar-itens-de-uma-assinatura.md): Este recurso permite listar as assinaturas. Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Editar item](https://docs.mundipagg.com/reference/editar-item-da-assinatura.md): Com o verbo _HTTP PUT_, através dos identificadores do item (`subscription_item_id`) e da assinatura (`subscription_id`) associada é possível atualizar os dados do item da assinatura.
- [Remover item](https://docs.mundipagg.com/reference/remover-item-da-assinatura.md): Com o verbo _HTTP DELETE_, através dos identificadores do item (`subscription_item_id`) e da assinatura (`subscription_id`) associada é possível remover um item da assinatura.
- [Uso de um item da assinatura](https://docs.mundipagg.com/reference/uso-de-um-item.md): O objeto `usage` descreve o uso de um `items` pertencente a uma `subscription`. O objeto `usage` tem os seguintes atributos:
- [Incluir uso](https://docs.mundipagg.com/reference/incluir-uso-de-item-de-assinatura.md): Este recursso permite incluir um `usage` de um `items` associado a uma `subscription`.
- [Remover uso](https://docs.mundipagg.com/reference/remover-uso-de-item-de-assinatura.md): Com o verbo HTTP DELETE, através dos identificadores do uso (`usage_id`), do item (`subscription_item_id`) a da assinatura associada (`subscription_id`), é possível excluir o uso do item de uma assinatura.
- [Listar uso](https://docs.mundipagg.com/reference/listar-uso-de-item-de-assinatura.md): Este recurso permite listar os usos de um item de assinatura.
- [Item do plano](https://docs.mundipagg.com/reference/item-do-plano.md): Um objeto `plan` poderá ser compostos por um ou mais `items`. Cada objeto de `items` é composto pelos seguintes atributos:
- [Incluir item](https://docs.mundipagg.com/reference/incluir-item-do-plano.md): Através do identificador do plano (`plan_id`) é possível incluir itens ao plano associado.
- [Editar item](https://docs.mundipagg.com/reference/editar-item-do-plano.md): Com o verbo _HTTP PUT_, através dos identificadores do item (`plan_item_id`) e do plano (`plan_id`) associado é possível atualizar os dados do item do plano.
- [Remover item](https://docs.mundipagg.com/reference/remover-item-do-plano.md): Com o verbo _HTTP DELETE_, através dos identificadores do item (`plan_item_id`) e do plano (`plan_id`) associado é possível remover um item do plano.
- [Desconto](https://docs.mundipagg.com/reference/desconto.md): O objeto `discount` poderá ser adicionado a um objeto de assinatura específico (`subscription`) para gerar um desconto, podendo aplicar-se a assinatura completa ou apenas a um item desta assinatura. O objeto `discount` tem os seguintes atributos:
- [Incluir desconto](https://docs.mundipagg.com/reference/incluir-desconto.md): Este recurso permite adicionar um desconto, através do identificador da assinatura (`subscription_id`).
- [Obter desconto](https://docs.mundipagg.com/reference/obter-desconto.md): Através dos identificadores da assinatura (`subscription_id`) e do desconto associado (`discount_id`) é possível recuperar as informações do desconto.
- [Remover desconto](https://docs.mundipagg.com/reference/remover-desconto.md): Com o verbo _HTTP DELETE_, através dos identificadores do desconto (`discount_id`) e da assinatura associada (`subscription_id`) é possível remover um desconto do plano.
- [Listar descontos](https://docs.mundipagg.com/reference/listar-descontos-1.md): Este recurso permite listar os descontos associados a uma assinatura.
- [Incremento](https://docs.mundipagg.com/reference/incremento.md): O objeto `increment` poderá ser adicionado a um objeto de assinatura específico (`subscription`) para gerar um incremento, podendo aplicar-se a assinatura completa ou apenas a um item desta assinatura. O objeto `increment` tem os seguintes atributos:
- [Incluir incremento](https://docs.mundipagg.com/reference/incluir-incremento.md): Este recurso permite adicionar um incremento, através do identificador da assinatura (`subscription_id`).
- [Obter incremento](https://docs.mundipagg.com/reference/obter-incremento.md): Através dos identificadores da assinatura (`subscription_id`) e do incremento associado (`incremento_id`) é possível recuperar as informações do incremento.
- [Listar incrementos](https://docs.mundipagg.com/reference/listar-descontos.md): Este recurso permite listar os incrementos associados a uma assinatura.
- [Remover incremento](https://docs.mundipagg.com/reference/remover-incremento.md): Com o verbo _HTTP DELETE_, através dos identificadores do incremento (`increment_id`) e da assinatura associada (`subscription_id`) é possível remover um incremento do plano.
- [Faturas](https://docs.mundipagg.com/reference/faturas.md): O objeto `invoice` representa os documentos gerados automaticamente ao final de cada ciclo de uma assinatura, discriminando todos os valores referentes à assinatura, como itens e descontos, para realização da cobrança do assinante. [Saiba mais sobre faturas](https://docs.mundipagg.com/docs/fatura). o objeto `invoice` tem os seguintes atributos:
- [Criar fatura](https://docs.mundipagg.com/reference/criar-fatura.md): Este recurso cria uma fatura (`invoice`) de acordo com o identificador do ciclo a ser cobrado (`cycle_id`) de um determinada assinatura (`subscription_id`).
- [Obter fatura](https://docs.mundipagg.com/reference/obter-fatura.md): Através do identificador da fatura (`invoice_id`) é possível recuperar as informação da fatura.
- [Editar metadados da fatura](https://docs.mundipagg.com/reference/editar-metadados-da-fatura.md): Com o verbo _HTTP PATCH_, através do identificador da fatura (`invoice_id`) é possível atualizar o objeto `metadata` da fatura.
- [Cancelar fatura](https://docs.mundipagg.com/reference/cancelar-fatura.md): Com o verbo _HTTP DELETE_, através do identificador da fatura (`invoice_id`), este recurso possibilita realizar o cancelamento da fatura.
- [Listar faturas](https://docs.mundipagg.com/reference/listar-faturas.md): Este recurso permite listar os descontos associados a uma assinatura.  Pode ser utilizados alguns parâmetros como filtro da listagem.
- [Ciclos](https://docs.mundipagg.com/reference/ciclos.md): O objeto `cycle` representa o ciclo de faturamento de uma assinatura. O objeto `cycle` tem os seguintes atributos:
- [Renovar ciclo](https://docs.mundipagg.com/reference/renovar-ciclo.md): Através do identificador da assinatura (`subscription_id`) é possível renovar o ciclo de uma assinatura. A utilização do método irá sempre renovar o ciclo à frente. Para Listar os ciclos de uma assinatura, acesse [Listar Ciclos](https://dash.readme.io/project/mundipagg/v1/refs/listar-ciclos).
- [Obter ciclo](https://docs.mundipagg.com/reference/obter-ciclo.md): Através do identificador do ciclo (`cycle_id`) é possível recuperar as informação do ciclo de uma assinatura.
- [Listar ciclos](https://docs.mundipagg.com/reference/listar-ciclos.md): Este recurso permite listar os ciclos associados a uma assinatura. Podem ser utilizados alguns parâmetros como filtro da listagem.
- [Visão Geral do Marketplace](https://docs.mundipagg.com/reference/marketplace-overview.md): Com a API Mundipagg é possível realizar o gerenciamento do seu Marketplace e para isso nosso sistema provê uma gama de recursos necessários para sua operação. Oferecemos recurso de [Recebedores](https://docs.mundipagg.com/v1/reference#recebedores) para gerenciamento dos recebíveis de uma venda com [Split](https://docs.mundipagg.com/v1/reference#split).
- [Recebedores](https://docs.mundipagg.com/reference/recebedores.md): O objeto `recipient` representa um **recebedor**, que irá receber parte da venda realizada.  Para criar um pedido com [Split de pagamentos](https://docs.mundipagg.com/v1/reference#split), você deve primeiramente cadastrar recebedores. Cada recebedor deve ser criado somente uma vez e poderá ser utilizado em qualquer quantidade de pedidos.  Por exemplo, vamos supor que seu marketplace tem duas lojas cadastradas. Para realizar split entre essas lojas e seu marketplace, você terá que criar três recebedores: - Marketplace - Loja 1 - Loja 2  Dessa forma, quando você criar um pedido com Split para a loja 1, você irá enviar o recebedor da loja 1, o recebedor do marketplace e sua regra de divisão para este pedido.  Este objeto possui os seguintes atributos:
- [Criar recebedor](https://docs.mundipagg.com/reference/criar-recebedor.md): Rota para criar um recebedor, definindo os dados do recebedor, transferência e qual a conta bancária que será utilizada para envio dos pagamentos.
- [Editar recebedor](https://docs.mundipagg.com/reference/editar-recebedor.md): Rota para editar um recebedor,  é possível alterar apenas os dados do recebedor.
- [Obter recebedor](https://docs.mundipagg.com/reference/obter-recebedor.md): Retorna um objeto com os dados de um recebedor específico.
- [Listar recebedores](https://docs.mundipagg.com/reference/listar-recebedores.md): Retorna um array com os dados de todos recebedores criados.
- [Saldo](https://docs.mundipagg.com/reference/saldo-1.md): O objeto `balance` representa os saldos associados a um **recebedor**. Este objeto possui os seguintes atributos:
- [Obter saldo](https://docs.mundipagg.com/reference/consulta-saldo-de-recebedor.md)
- [Conta bancária](https://docs.mundipagg.com/reference/conta-bancária.md): O objeto `bank_acoount` representa a conta bancária associada a um **recebedor**. Este objeto possui os seguintes atributos:
- [Atualizar conta bancária do recebedor](https://docs.mundipagg.com/reference/atualizar-conta-bancária-do-recebedor.md): Rota para editar uma conta bancária de um recebedor.  É possível alterar apenas os dados da conta .
- [Informações de transferência](https://docs.mundipagg.com/reference/informações-de-transferência.md): O objeto `transfer_setting` representa a configuração de transferência automática associada a um **recebedor**. Este objeto possui os seguintes atributos:
- [Atualizar informações de transferência](https://docs.mundipagg.com/reference/atualizar-informações-de-transferência.md)
- [Informações de antecipação automática](https://docs.mundipagg.com/reference/informações-de-antecipação-automática.md): O objeto `automatic_anticipation_settings` representa a configuração de antecipação automática associada a um **recebedor**. Este objeto possui os seguintes atributos:
- [Atualizar informações de antecipação automática](https://docs.mundipagg.com/reference/atualizar-informações-de-antecipação-automática.md)
- [Split](https://docs.mundipagg.com/reference/split.md): Utilizando a funcionalidade de Split você pode criar um pedido com mais de um recebedor.  [Saiba mais sobre Split](https://docs.mundipagg.com/docs/pedidos-com-split).  O objeto `split` tem as seguintes propriedades:
- [Criar pedido com split](https://docs.mundipagg.com/reference/criar-pedido-com-split.md): Para realizar pedidos com split, você deve criar um objeto order com o objeto split.  Para criar um pedido com, você deve primeiramente cadastrar recebedores.  O objeto order com split possui os seguintes atributos:
- [Capturar cobrança com split](https://docs.mundipagg.com/reference/capturar-cobrança-com-split.md): Rota para capturar uma cobrança com split, definindo a regra de split e os recebedor que irão participar da divisão dos pagamentos.
- [Cancelar cobrança com split](https://docs.mundipagg.com/reference/cancelar-cobrança-com-split.md): Rota para cancelar uma cobrança com split, definindo a regra de split e os recebedor que irão participar da divisão dos pagamentos.
- [Saque](https://docs.mundipagg.com/reference/saque.md): o objeto `withdrawals` representa uma **Saque** realizada para a **conta bancária** de um **recebedor**. Este objeto possui os seguintes atributos:
- [Cria saque](https://docs.mundipagg.com/reference/cria-saque.md): Rota para realizar o saque para uma **conta bancária**  de um **recebedor**.
- [Obter saque](https://docs.mundipagg.com/reference/obter-saque.md): Rota para realizar a consulta de um saque específico.
- [Listar saques](https://docs.mundipagg.com/reference/listar-saques.md): Rota para realizar  a consulta de saques para um determinado **recebedor**.
- [Mundi.js](https://docs.mundipagg.com/reference/checkout-transparente.md)
- [Tokenização](https://docs.mundipagg.com/reference/checkout-transparente-via-tokenizacao.md)
- [Checkout Mundipagg](https://docs.mundipagg.com/reference/checkout-personalizado.md): Com o **checkout Mundipagg**, oferecemos uma página de checkout desenvolvida por nós e hospedada em nossos servidores. Desta forma, você não precisa se preocupar em desenvolver essa interface.
- [Envio de Checkout](https://docs.mundipagg.com/reference/checkout-por-email.md)
- [Opção Lightbox](https://docs.mundipagg.com/reference/checkout-via-lightbox.md): Com a opção **Lightbox**, você pode customizar a página de finalização da compra com a identidade da sua loja, sem alterar a URL no navegador do cliente. Ao clicar em fechar o carrinho, aparece um lightbox na página do seu site para que o comprador preencha os dados para pagamento.
- [Visão geral sobre Webhooks](https://docs.mundipagg.com/reference/webhooks-overview.md): Sempre que ocorre um evento importante, nós disparamos uma notificação para seu servidor. Essas notificações são chamadas de **webhooks**. É possível configurar varios endpoints e escolher quais eventos serão disparados . O objeto `webhook` contêm os seguintes atributos:
- [Exemplo de webhook](https://docs.mundipagg.com/reference/exemplo-de-webhook.md): Segue o exemplo de um webhook `order.paid` que nós enviamos:
- [Eventos de webhook](https://docs.mundipagg.com/reference/eventos-de-webhook.md)
- [Enviar webhook](https://docs.mundipagg.com/reference/enviar-webhook.md)
- [Listar webhooks](https://docs.mundipagg.com/reference/listar-webhooks.md)
- [Obter webhook](https://docs.mundipagg.com/reference/obter-webhook.md)
- [Tutoriais](https://docs.mundipagg.com/reference/tutoriais-1.md)