Recursos para IA

Comandos

O Mercado Pago CLI disponibiliza comandos para operar nossos principais produtos integráveis diretamente pelo terminal. Confira os comandos disponíveis por produto, como utilizá-los e a referência completa de cada um.

Comandos por produto

Comando	Disponibilidade por produto(s)
`mpcli payments`, `mpcli cards`	Checkout API
`mpcli advanced-payments`	Checkout API
`mpcli preferences`	Checkout Pro
`mpcli orders`	Checkout Pro Checkout API
`mpcli merchant-orders`	Marketplace
`mpcli subscriptions`, `mpcli subscription-plans`	Assinaturas
`mpcli pos`, `mpcli stores`	Point código QR
`mpcli shipping`	Envios
`mpcli chargebacks`	Todos os produtos.
`mpcli reports releases`, `mpcli reports settlements`	Todos os produtos.
`mpcli oauth`	Todos os produtos.

Como usar os comandos

Todos os comandos do CLI seguem o padrão mpcli [recurso] [ação] [flags]. Você pode consultar as opções disponíveis de qualquer comando utilizando a flag --help:

bash
mpcli --help
mpcli payments --help

Formato de saída

Por padrão, todos os comandos retornam um JSON:

bash
mpcli payments list
# { "status": "success", "data": { "results": [...] } }

Para uma saída tabular legível, utilize a flag --table. Confira um exemplo a seguir:

text
$ mpcli payments list --table
ID            STATUS    AMOUNT   METHOD          DATE
12345678      approved  $ 99.90  account_money   2025-01-01T...

Flags globais

Qualquer comando aceita as seguintes flags para controlar o formato de saída, autenticação ou determinado comportamento interativo. Consulte os detalhes de cada uma a seguir:

Flag	Atalho	Descrição
`--table`	—	Saída tabular formatada.
`--silent`	`-s`	Suprimir spinners e cores ANSI.
`--verbose`	`-v`	Exibir headers HTTP.
`--profile`	`-p`	Perfil de credenciais a usar.
`--idempotency-key`	—	Chave de idempotência para POST/PUT.
`--data`	—	Corpo da requisição via arquivo `JSON` (`@payload.json`).
`--no-interactive`	—	Desabilitar prompts (CI/CD).
`--no-color`	—	Desabilitar saída colorida.

Exit codes

Em scripts e pipelines, o Mercado Pago CLI retorna um código de saída ao final de cada execução. Use esses valores para tratar erros de forma programática:

Código	Significado
`0`	Sucesso.
`1`	Erro geral.
`2`	Erro de autenticação.
`3`	Erro de validação.
`4`	Rate limit.

Para abrir a Referência de API de qualquer produto diretamente no navegador, utilize mpcli docs [produto] — por exemplo, mpcli docs payments.

Referência de comandos

Pagamentos

Gerencia o ciclo de vida de um pagamento desde a criação até a captura, o cancelamento e a atualização.

bash
mpcli payments list
mpcli payments get <id>
mpcli payments search --status approved
mpcli payments search --payment-method-id pix
mpcli payments search --external-reference "ORDER-001"
mpcli payments create --data @payment.json
mpcli payments cancel <id>
mpcli payments capture <id>
mpcli payments update <id> --data @update.json

Reembolsos

Consulta o histórico e os detalhes de reembolsos associados a um pagamento e cria reembolsos totais ou parciais. É necessário informar o ID do pagamento original para utilizar este comando.

bash
mpcli refunds create <payment-id>
mpcli refunds create <payment-id> --amount 50.00
mpcli refunds list <payment-id>
mpcli refunds get <payment-id> <refund-id>

Pagamentos avançados

Cria e gerencia fluxos de pagamentos avançados com pagamentos divididos e desembolsos.

bash
mpcli advanced-payments create --data @advanced_payment.json
mpcli advanced-payments get <id>
mpcli advanced-payments search --external-reference ORDER-001
mpcli advanced-payments update <id> --data @update.json
mpcli advanced-payments refund <id>
mpcli advanced-payments refund <id> --amount 100.00

Preferências de pagamento em Checkout Pro

Cria e gerencia preferências de pagamento que configuram o comportamento do Checkout Pro em cada transação.

bash
mpcli preferences list
mpcli preferences get <id>
mpcli preferences create --data @pref.json
mpcli preferences update <id> --data @pref.json

Clientes e cartões

Gerencia perfis de clientes e seus cartões tokenizados, habilitando cobranças recorrentes e fluxos de pagamento com dados salvos.

bash
mpcli customers list
mpcli customers get <id>
mpcli customers create --email user@example.com
mpcli customers update <id> --data @customer.json
mpcli customers delete <id>

Gestão de assinaturas

Cria e gerencia planos e assinaturas recorrentes para cobranças periódicas. Consulte a documentação de planos de assinatura para mais informações.

bash
mpcli subscriptions list
mpcli subscriptions get <id>
mpcli subscriptions create --data @subscription.json
mpcli subscriptions update <id> --data @sub.json

Lojas e Pontos de venda (PDV)

Cria e configura lojas físicas e pontos de venda (PDV) para processar pagamentos presenciais com Point e Código QR. Consulte a documentação de Código QR para detalhes sobre o processamento de pagamentos com orders.

bash
mpcli stores search
mpcli stores get <id>
mpcli stores create --name "Loja Principal" --external-id MINHA_LOJA
mpcli stores update <id> --data @store.json
mpcli stores delete <id>

Orders

Merchant Orders

Agrupa pagamentos e envios em fluxos de Marketplace. Requer integração com Marketplace configurada.

bash
mpcli merchant-orders create --preference-id <preference-id>
mpcli merchant-orders create --data @order.json
mpcli merchant-orders get <id>
mpcli merchant-orders search --external-reference "REF-001"
mpcli merchant-orders update <id> --data @update.json

Envios

Contestações

Consulta e acompanha contestações de pagamento abertas contra cobranças realizadas pela sua integração.

bash
mpcli chargebacks list
mpcli chargebacks get <id>
mpcli chargebacks search --payment-id <payment-id>

Relatórios financeiros

Gera e consulta relatórios financeiros de liberações e dinheiro em conta para conciliação e auditoria de transações. Consulte a documentação de relatórios para mais informações.

O módulo de Relatórios financeiros precisa estar habilitado na conta do Mercado Pago.

Confira os comandos disponíveis por tipo de relatório:

bash
mpcli reports releases list
mpcli reports releases create --date-from 2025-01-01 --date-to 2025-01-31

Meios de pagamento e tipos de identificação

OAuth

Gerencia a troca de códigos de autorização e a renovação de tokens de acesso via OAuth 2.0. Consulte a documentação de OAuth para mais informações.

bash
mpcli oauth url --client-id <id> --redirect-uri https://meuapp.com/callback
mpcli oauth token --client-id <id> --client-secret <secret> --code <code> --redirect-uri https://meuapp.com/callback
mpcli oauth refresh --token <refresh-token>

Config

Gerencia perfis de credenciais nomeados para alternar entre contas e ambientes sem precisar reautenticar.

bash
mpcli config set --profile sandbox --token TEST-... --environment sandbox
mpcli config use sandbox
mpcli config list
mpcli config get environment

Sandbox e testes

Cria e configura usuários de teste, saldo virtual e cartões de teste para simular cenários de pagamento em ambiente de sandbox.

Criar usuário de teste

bash
mpcli tester create

Definir saldo virtual

bash
mpcli tester balance set --user-id <id> --amount 10000

Provisionar cartão de teste

O --scenario define o comportamento simulado:

bash
mpcli tester card create --user-id <id> --scenario approved
mpcli tester card create --user-id <id> --scenario insufficient_funds
mpcli tester card create --user-id <id> --scenario stolen_card
mpcli tester card create --user-id <id> --scenario high_risk

Cenário	Comportamento
`approved`	Cartão sempre aprovado.
`insufficient_funds`	Recusado por saldo insuficiente.
`stolen_card`	Recusado por código de segurança inválido.
`high_risk`	Entra em revisão de fraude.

AnteriorInstalar Mercado Pago CLIInstale o MP CLI via Homebrew e autentique com seu token de acesso.

PróximoChangelog