Recursos para IA
Checkout API
Checkout API permite processar pagamentos diretamente no seu site ou app, sem redirecionar o comprador para uma página externa. Suporta cartões de crédito e débito, dinheiro e outros meios de pagamento locais. Esta referência descreve os endpoints disponíveis e como interagir com eles.
Está buscando o passo a passo desta integração? Ir à documentação do Checkout API.
Qual tipo de integração usar?
Escolha de acordo com o seu caso de uso.
- Processamento automático e manual
- Captura em duas etapas
- Novas funcionalidades e notificações simplificadas
- Processamento automático
- Captura em duas etapas
Via Orders API (Recomendada)
Via Payments API (Legacy)
Endpoints disponíveis
Todos os endpoints que compõem a integração do Checkout API via Orders.
| Operação | Path | Descrição |
| Criar orderPOST | /v1/orders | Cria uma nova order no modo automatic (pagamento em uma única etapa) ou manual (pagamento em duas etapas - autorizar e capturar); retorna o order_id. |
| Capturar order completamentePOST | /v1/orders/{id}/capture | Captura o valor completo de uma order no modo manual. Operação válida apenas para cartões de crédito. |
| Adicionar transações à orderPOST | /v1/orders/{id}/transactions | Adiciona uma transação a uma order no modo manual com card_token, installments e payment_method_id. |
| Excluir uma transação da orderDELETE | /v1/orders/{id}/transactions/{transaction_id} | Exclui uma transação antes de chamar /process, para corrigir o meio de pagamento ou o valor no modo manual. |
| Atualizar uma transação da orderPUT | /v1/orders/{id}/transactions/{transaction_id} | Atualiza os dados de uma transação existente em uma order no modo manual. |
| Processar order por IDPOST | /v1/orders/{id}/process | Dispara a autorização do pagamento e a order altera para approved, pending, rejected ou failed. |
| Pesquisar orderGET | /v1/orders/search | Pesquisa orders por filtros como data, status ou external_reference, retornando resultados paginados. |
| Obter order por IDGET | /v1/orders/{id} | Retorna o status e o detalhe completo da order, incluindo suas transações e o processing_mode ativo. |
| Cancelar order por IDPOST | /v1/orders/{id}/cancel | Cancela uma order antes de processá-la ou quando o pagamento resultou em rejeitado ou pendente. |
| Reembolsar uma orderPOST | /v1/orders/{id}/refund | Reembolsa uma order total ou parcialmente. |
| Operação | Path | Descrição |
| Obter meios de pagamentoGET | /v1/payment_methods | Lista os meios de pagamento disponíveis para o site (cartões, tickets, wallets, etc.) para exibir as opções no checkout. |
| Operação | Path | Descrição |
| Obter tipos de documentosGET | /v1/identification_types | Lista os tipos de documento disponíveis por país para preencher o formulário do pagador. |
Endpoints para salvar e gerenciar cartões de clientes. Úteis para reduzir o atrito em compras recorrentes.
| Operação | Path | Descrição |
| Salvar cartãoPOST | /v1/customers/{customer_id}/cards | Associa um cartão tokenizado a um cliente a partir de um card_token gerado com MercadoPago.js. |
| Obter cartões de um clienteGET | /v1/customers/{customer_id}/cards | Lista os cartões tokenizados salvos para um cliente. |
| Obter cartãoGET | /v1/customers/{customer_id}/cards/{card_id} | Retorna os dados de um cartão salvo, sendo os últimos 4 dígitos, a bandeira e a data de validade. |
| Atualizar cartãoPUT | /v1/customers/{customer_id}/cards/{card_id} | Atualiza os dados de um cartão tokenizado salvo. |
| Excluir cartãoDELETE | /v1/customers/{customer_id}/cards/{card_id} | Exclui um cartão guardado do cliente. |
Endpoints para criar e gerenciar perfis de clientes e salvar seus meios de pagamento.
| Operação | Path | Descrição |
| Criar clientePOST | /v1/customers | Registra um cliente cujo customer_id é necessário para gerenciar seus cartões e endereços. |
| Pesquisar em clientesGET | /v1/customers/search | Pesquisa clientes por e-mail ou outros filtros, retornando resultados paginados. |
| Obter clienteGET | /v1/customers/{id} | Retorna os dados do cliente, incluindo meios de pagamento salvos e metadata. |
| Atualizar clientePUT | /v1/customers/{id} | Atualiza os dados de um cliente. |
Endpoints para gerenciar os endereços associados aos clientes.
| Operação | Path | Descrição |
| Criar endereçoPOST | /v1/customers/{customer_id}/addresses | Registra um endereço de envio para o cliente. |
| Listar endereçosGET | /v1/customers/{customer_id}/addresses | Lista os endereços de envio salvos para um cliente. |
| Obter endereçoGET | /v1/customers/{customer_id}/addresses/{address_id} | Retorna o detalhe de um endereço de envio salvo. |
| Atualizar endereçoPUT | /v1/customers/{customer_id}/addresses/{address_id} | Atualiza os dados de um endereço de envio salvo. |
| Excluir um endereçoDELETE | /v1/customers/{customer_id}/addresses/{address_id} | Exclui um endereço de envio do cliente. |
| Operação | Path | Descrição |
| Obter contestaçãoGET | /v1/chargebacks/{id} | Retorna o detalhe de uma contestação, sendo o status da disputa, o valor afetado e o prazo para definição. |
Tudo pronto para começar?
Acesse o primeiro endpoint e comece a construir seu fluxo de pagamentos com a API de Orders.