CLI

Pagamentos

Crie, consulte e cancele cobranças PIX pelo terminal. Espelha a API /api/v1/payments.

Documentação HTTP completa em Referência → PIX.

Criar cobrança

# valor em reais
hyzepay payments create \
  --amount 15.00 \
  --description "Pedido #1001" \
  --external-id pedido-1001 \
  --customer-name "Maria Silva" \
  --customer-email maria@email.com \
  --customer-document 12345678909

# valor em centavos
hyzepay payments create --amount-cents 1500 --description "Pedido #1001"

# JSON para scripts
hyzepay payments create --amount 19.90 --external-id ord_42 --json

A saída humana inclui o PIX copia-e-cola (br_code). Com o mesmo --external-id, a criação é idempotente.

Consultar

Use o UUID HyzePay ou o seu external_id:

hyzepay payments get a1b2c3d4-e5f6-7890-abcd-ef1234567890
hyzepay payments get pedido-1001
hyzepay payments get pedido-1001 --json

Listar

hyzepay payments list
hyzepay payments list --status paid --limit 50
hyzepay payments list --status pending --offset 20
hyzepay payments list --external-id pedido-1001 --json

Flag	Default	Descrição
`--status`	—	pending \| paid \| expired \| failed \| refunded
`--limit`	20	Máx. 100
`--offset`	0	Paginação

Cancelar

Só para pagamentos pending — marca como expired:

hyzepay payments cancel pedido-1001
hyzepay payments cancel <uuid> --json

Flags do `create`

Flag	Obrigatório	Descrição
`--amount-cents`	sim*	Valor em centavos
`--amount`	sim*	Valor em reais (15 ou 15.50)
`--description, -d`	não	Texto do PIX
`--external-id, -e`	não	Idempotência
`--expires-in`	não	Segundos (60–86400)
`--customer-name`	não	Nome do pagador
`--customer-email`	não	E-mail
`--customer-document`	não	CPF/CNPJ
`--customer-phone`	não	Telefone
`--metadata`	não	JSON string, ex: '{"sku":"PRO"}'