CLI

Receitas

Comandos prontos para o dia a dia. A CLI tem duas camadas: comandos curados para os recursos mais usados e um escape hatch (get/post/put/patch/delete) que alcança qualquer endpoint da API.

Comandos prontos para o dia a dia. A CLI tem duas camadas: comandos curados para os recursos mais usados e um escape hatch (get/post/put/patch/delete) que alcança qualquer endpoint da API.

Todos aceitam as flags globais --profile, --api-key, --base-url, --json e -v/--verbose. Mutações aceitam --idempotency-key.

Transações

# criar (o corpo é um JSON — igual ao body da API)
selectwin transactions create -d '{"amount":5000,"payment":{"method":"pix","currency":"BRL"},"customer":{"firstName":"João","lastName":"Silva","email":"[email protected]"}}'

selectwin transactions list --limit 20
selectwin transactions get tra_123
selectwin transactions refund tra_123                 # reembolso total
selectwin transactions refund tra_123 -d '{"amount":2500}'   # parcial

Clientes

selectwin customers create -d '{"firstName":"Maria","lastName":"Souza","email":"[email protected]"}'
selectwin customers list --limit 20
selectwin customers get cus_123
selectwin customers delete cus_123

Webhooks

selectwin webhooks endpoints create -d '{"name":"Minha loja","endpoint":"https://minhaloja.com/webhooks/selectwin","events":["transaction.approved"]}'
selectwin webhooks endpoints list --limit 20
selectwin webhooks endpoints get whe_123
selectwin webhooks test whe_123                       # dispara uma entrega de teste

Escape hatch — qualquer endpoint

Não há comando curado para tudo. Para qualquer outro recurso (assinaturas, produtos, cupons, carteiras…), fale direto com a API:

selectwin get /v1/subscriptions --limit 10
selectwin get /v1/subscriptions/subs_123
selectwin post /v1/subscriptions -d '{"planId":"plan_123","customer":"cus_123"}'
selectwin patch /v1/subscriptions/subs_123 -d '{"metadata":{"tier":"gold"}}'
selectwin delete /v1/coupons/cpn_123

Perfis

selectwin whoami                 # valida a chave e mostra conta/ambiente
selectwin config list            # lista os perfis
selectwin config use prod        # troca o perfil ativo
selectwin config get             # mostra o perfil ativo

Próximos passos

How is this guide?

On this page