Pular para o conteúdo principal

Pagamentos

As tentativas de liquidação de uma fatura: retentativa, troca de cartão, mudança de vencimento, estorno e reenvio do e-mail de cobrança.

ComandoHTTPDescrição
payments listGET /v1/paymentsListar pagamentos
payments createPOST /v1/paymentsProcessar pagamento
payments getGET /v1/payments/{id}Obter pagamento
payments deleteDELETE /v1/payments/{id}Excluir pagamento
payments cancelPOST /v1/payments/{id}/cancelCancelar pagamento
payments change-cardPOST /v1/payments/{id}/change-cardTrocar cartão do pagamento
payments change-due-datePOST /v1/payments/{id}/change-due-dateAlterar vencimento do boleto
payments refundPOST /v1/payments/{id}/refundEstornar pagamento
payments retryPOST /v1/payments/{id}/retryTentar pagamento novamente
payments send-emailPOST /v1/payments/{id}/send-emailEnviar boleto por e-mail
payments syncPOST /v1/payments/{id}/syncSincronizar pagamento com gateway
payments bulk-update-invoice createPOST /v1/payments/bulk-update-invoiceReatribuir pagamentos a outra fatura

Exemplos​

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar pagamentos
kobana billing payments list \
--fields "id,public_id,external_id,invoice_id,billing_account_id"

# Obter pagamento
kobana billing payments get --params '{"id": "PAYMENT_ID"}'

# Processar pagamento
kobana billing payments create --json '{"invoiceId": "INVOICEID"}'

# Cancelar pagamento
kobana billing payments cancel \
--params '{"id": "PAYMENT_ID"}' \
--json '{"reason": "REASON", "cancel_on_gateway": true}'

# Excluir pagamento
kobana billing payments delete --params '{"id": "PAYMENT_ID"}' --dry-run

Próximos passos​