PayZu Conta HubCobrança na contaCriação e consulta
Consultar uma cobrança
GET/transactions/payment/{paymentId}
Confira o passo a passo → https://docs.payzu.com.br/docs/account-hub/look-up-a-charge
Requisições recentes
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Cobrança encontrada
idstringID da cobrança.
methodstringMeio de pagamento.
PIXstatusstringStatus da cobrança.
PENDINGPAIDREFUNDEDEXPIREDamountintegerValor da cobrança, em centavos.
descriptionstring | nullTexto exibido para quem paga.
serviceFeeintegerTarifa do recebimento em centavos, descontada do valor.
netAmountintegerValor creditado na conta em centavos, já sem a tarifa.
refundedAmountintegerTotal de devoluções concluídas, em centavos.
refundFeeintegerTarifa cobrada nas devoluções concluídas, em centavos.
refundInProgressAmountintegerValor de devolução em andamento, em centavos.
refundableAmountintegerQuanto ainda pode ser devolvido, em centavos.
openInfractionProtocolstring | nullProtocolo da infração MED aberta sobre a cobrança.
externalRefstring | nullSeu identificador, enviado na criação.
callbackUrlstring | nullURL que recebe os avisos da transação.
createdAtstringData e hora do registro.
paidAtstring | nullData e hora do pagamento.
refundedAtstring | nullData e hora da devolução total.
pixobject | nullDados do QR Code.
Campos do objeto 2
qrCodeTextstring | nullCódigo Pix copia e cola, usado para desenhar o QR Code.
endToEndIdstring | nullID end-to-end do Pix que pagou.
customerobject | nullCliente informado na criação.
Campos do objeto 4
namestringNome do cliente.
documentstringCPF ou CNPJ do cliente, só com números.
emailstring | nullE-mail do cliente.
phonestring | nullTelefone do cliente.
payerobject | nullQuem de fato pagou, segundo o banco.
Campos do objeto 3
namestring | nullNome de quem pagou.
documentstring | nullCPF ou CNPJ de quem pagou, com o CPF mascarado.
bankobject | nullInstituição de origem do Pix.
Campos do objeto 2
namestring | nullNome da instituição.
ispbstring | nullISPB da instituição, com 8 dígitos.
refundsarray of objectsDevoluções da cobrança, da mais recente à mais antiga.
Campos de cada item 10
idstringID da devolução, o refundId dos webhooks.
statusstringStatus da devolução.
PROCESSINGSETTLEDRELEASEDamountintegerValor devolvido ao pagador, em centavos.
serviceFeeintegerTarifa da devolução, em centavos.
totalDebitedintegerTotal que sai da conta, com a tarifa, em centavos.
endToEndIdstring | nullID end-to-end da devolução.
rejectedReasonstring | nullMotivo da recusa do banco, para exibir.
requestedAtstringData e hora do pedido de devolução.
settledAtstring | nullData e hora da devolução.
releasedAtstring | nullData e hora em que o valor voltou ao saldo, após recusa.
401Credencial ausente ou inválida
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
403Acesso negado
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
404Cobrança não encontrada
messagestringMotivo em texto, para exibir ou registrar.
codestringCódigo do erro.
Esta página ajudou?