Recursos para IA
Checkout Pro
Checkout Pro redireciona o comprador para um ambiente do Mercado Pago para que conclua o pagamento. Você o integra pela API de preferências. 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 Pro.
Endpoints disponíveis
Todos os endpoints que compõem a integração do Checkout Pro via Preferences API.
A preferência é o objeto central do Checkout Pro. Define os itens, valores, meios de pagamento habilitados e URLs de retorno do comprador.
| Operação | Path | Descrição |
| Criar preferênciaPOST | /checkout/preferences | Cria uma preferência com itens, preços e back_urls, retornando o init_point para redirecionar o comprador. |
| Pesquisar preferênciasGET | /checkout/preferences/search | Pesquisa preferências por filtros como external_reference ou data, retornando resultados paginados. |
| Obter preferênciaGET | /checkout/preferences/{id} | Retorna o detalhe de uma preferência: init_point, itens e back_urls configuradas. |
| Atualizar preferênciaPUT | /checkout/preferences/{id} | Atualiza uma preferência existente antes de o comprador concluir o pagamento. |
Endpoints de leitura para verificar o estado de um pagamento após receber a notificação webhook ou o redirect de retorno.
| Operação | Path | Descrição |
| Pesquisar pagamentosGET | /v1/payments/search | Pesquisa pagamentos por filtros como external_reference, status ou data, retornando resultados paginados. |
| Obter pagamentoGET | /v1/payments/{id} | Retorna o status e o detalhe do pagamento, incluindo o status_detail para confirmar o resultado após a notificação. |
| Operação | Path | Descrição |
| Obter meios de pagamentoGET | /v1/payment_methods | Lista os meios de pagamento disponíveis para o site, para incluí-los ou excluí-los na preferência. |
| Operação | Path | Descrição |
| Calcular tarifas de envioPOST | /shipping/v1/shipments-rates | Calcula as tarifas de envio disponíveis para um conjunto de itens e endereço de destino. |
| Criar envioPOST | /shipping/v1/shipments | Cria um envio associado a uma preferência; retorna o identificador do envio. |
| Obter envioGET | /shipping/v1/shipments | Retorna o detalhe e o status de um envio existente. |
| Cancelar envioDELETE | /shipping/v1/shipments/{id} | Cancela um envio antes de ser despachado. |
| Obter etiqueta de envioGET | /shipping/v1/shipments/{id}/packages/{packageId}/label | Retorna a etiqueta de envio em formato PDF para impressão e fixação no pacote. |
| Rastrear envioGET | /shipping/v1/shipments-tracking/{tracking_number} | Retorna o status de rastreamento de um envio pelo número de tracking. |
| Operação | Path | Descrição |
| Obter contestaçãoGET | /v1/chargebacks/{id} | Busca um caso de contestação a partir de seu ID retornado no body da notificação configurada para contestações. Retorna o detalhe de uma contestação, sendo o status da disputa, o valor afetado e o prazo para definição. |
| Buscar contestaçõesGET | /v1/chargebacks/search | Busca todas as contestações de um pagamento por seu "payment_id" retornado no body da notificação configurada para contestações. A busca retorna resultados paginados com o detalhe de cada caso. |
| Enviar documentação comprobatóriaPOST | /v1/chargebacks/{id}/documentation | Envia arquivos de evidência para contestar uma contestação enquanto seu status ("documentation_status") for "pending". |
| Obter arquivo de documentação comprobatóriaGET | /v1/chargebacks/documentation/{type}/{uuid} | Baixa ou renderiza em linha um arquivo de documentação enviado para um caso de contestação. |
SDKs
Use nossos SDKs oficiais para integrar o Checkout Pro mais rapidamente. O GitHub é a fonte de verdade de cada biblioteca.
Tudo pronto para começar?
Vá ao primeiro endpoint e comece a criar sua primeira preferência de pagamento.
