PayZu CellCobranças

Consultar uma cobrança

GET/v1/charges/{id}

Confira o passo a passo → https://docs.payzu.com.br/docs/cell/monthly-charges


Path Params

idstringobrigatório
ID da cobrança.

Headers

Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.

Responses

200Cobrança encontrada
idstringIdentificador da cobrança.
environmentstringAmbiente do dado: produção ou testes.
LIVETEST
customerIdstringID do titular cobrado.
customerNamestringNome do titular da cobrança.
lineIdstring | nullID da linha cobrada, quando houver.
lineMsisdnstring | nullNúmero da linha cobrada; nulo enquanto a linha não tem número.
kindstringAtivação, renovação, reativação ou troca de plano.
ACTIVATIONRENEWALREACTIVATIONPLAN_CHANGE
statusstringSituação da cobrança.
PENDINGPAIDEXPIREDCANCELLED
amountnumberValor em reais, número com até duas casas, como 29.9.
dueOnstringDia de vencimento.
expiresAtstringDepois disso a cobrança expira.
paidAtstring | nullData e hora do pagamento.
createdAtstringData e hora do registro.
paymentsarray of objectsPagamentos da cobrança.
Campos de cada item 11
idstringID do pagamento.
orderIdstringPedido de pagamento a que o pagamento pertence; é a referência dele no provedor.
chargeIdsarray of stringsFaturas cobertas pelo pedido do pagamento.
methodstringMeio usado; WALLET é saldo ou crédito na carteira do provedor; BALANCE é o saldo da carteira da empresa.
PIXCARDBOLETOWALLETBALANCE
statusstringSituação do pagamento.
PENDINGPAIDFAILEDEXPIREDCANCELLEDREFUNDED
amountnumberValor em reais, número com até duas casas, como 29.9.
pixCopyPastestring | nullPix copia e cola.
pixQrCodestring | nullQR do Pix em PNG base64.
expiresAtstring | nullData e hora em que o pagamento expira.
paidAtstring | nullInstante ISO 8601 com fuso.
createdAtstringInstante ISO 8601 com fuso.
401Chave ausente ou inválida
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
403Acesso negado
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.
404Cobrança não encontrada
statusCodeintegerO mesmo status HTTP da resposta.
errorstringNome do status HTTP em inglês.
messagestringExplicação do erro para quem lê. Decida pelo código: a mensagem pode mudar.
codestringCódigo estável do erro, no formato PZCnnn.

Linguagem

Credenciais Bearer

Token de API

curl --request GET \     --url https://api.payzucell.com.br/v1/charges/{id} \     --header 'authorization: Bearer SEU_TOKEN' \     --header 'accept: application/json'
Resposta

Clique em Try It! para enviar uma requisição e ver a resposta aqui. Ou escolha um exemplo:

application/json