PayZu PaymentsCobranças
Consultar uma cobrança
GET/charges/{chargeId}
Confira o passo a passo → https://docs.payzu.com.br/docs/payments/get-a-charge
Requisições recentes
Headers
Authorizationstringobrigatório
Bearer seguido do token de API.
acceptstring
Formato da resposta.
Responses
200Cobrança encontrada
idstringIdentificador da cobrança na PayZu.
externalIdstringSeu identificador, enviado na criação.
postbackUrlstring | nullURL que recebe os avisos da transação.
amountintegerValor da cobrança em centavos.
paymentTypestringMeio de pagamento.
creditcardpixcreatedAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
customerobject | nullDados do comprador.
Campos do objeto 7
namestringNome completo do comprador.
identitystring | nullNúmero do documento do comprador.
identityTypestring | nullTipo do documento do comprador.
emailstring | nullE-mail do comprador.
birthdatestring | nullData de nascimento do comprador.
phonestring | nullTelefone do comprador.
addressobject | nullEndereço de cobrança.
Campos do objeto 8
streetstringLogradouro.
numberstringNúmero do endereço.
complementstring | nullComplemento.
zipCodestringCódigo postal.
citystringCidade.
statestringEstado.
countrystringPaís.
districtstringBairro.
cartarray of objectsItens do carrinho.
Campos de cada item 4
namestringNome do produto.
quantityintegerQuantidade do produto.
skustringSKU do produto.
unitPriceintegerPreço unitário em centavos.
creditCardPaymentobject | nullDados do pagamento no cartão; nulo na cobrança Pix.
Campos do objeto 13
installmentsintegerNúmero de parcelas.
authenticatebooleanIndica se o comprador foi levado ao 3DS do emissor.
currencystringMoeda da cobrança.
acquirerTransactionIdstring | nullIdentificador da transação na adquirente.
authorizationCodestring | nullCódigo de autorização da adquirente.
reasonCodeintegerCódigo do motivo do resultado.
retryAllowedboolean | nullSe o emissor aceita outra tentativa com este cartão; nulo quando o pagamento não foi negado.
retryAfterstring | nullA partir de quando a outra tentativa é aceita, quando o emissor dá um prazo.
statusintegerStatus da transação (2 é PaymentConfirmed).
reversedAmountinteger | nullValor estornado em centavos.
reversedDatestring | nullData e hora do estorno.
cardobject | nullCartão usado na cobrança.
Campos do objeto 4
numberstringNúmero do cartão, mascarado.
holderstringNome impresso no cartão.
expirationstringValidade do cartão.
brandstringBandeira do cartão.
VisaMasterEloDinersHipercardchargebacksarray of objectsChargebacks da cobrança.
Campos de cada item 10
numberstringNúmero do chargeback na adquirente.
amountintegerValor do chargeback em centavos.
statusstringStatus do chargeback.
RECEIVEDACCEPTEDDEFENDEDreasonCodestring | nullCódigo do motivo informado pela bandeira. Pode vir vazio ou nulo.
reasonDescriptionstring | nullMotivo informado pela bandeira.
issuedAtstringData de emissão do chargeback.
defenseDeadlinestringPrazo para acatar ou contestar.
responseobject | nullResposta registrada; nulo enquanto ninguém respondeu.
Campos do objeto 10
actionstringACCEPT quando acatado, DEFENSE quando contestado.
ACCEPTDEFENSEreasonstring | nullJustificativa enviada na contestação.
disputeIdstringIdentificador da disputa na adquirente.
documentNamestring | nullNome do arquivo enviado.
documentTypestring | nullTipo do arquivo enviado.
documentSizeinteger | nullTamanho do arquivo, em bytes.
documentHashstring | nullSHA-256 do arquivo, em hexadecimal.
respondedBystringQuem enviou a resposta; pela API, api: seguido do client_id.
providerMessagestring | nullMensagem da adquirente ao registrar a resposta.
createdAtstringData e hora da resposta.
createdAtstringData e hora do registro.
updatedAtstringData e hora da última alteração.
pixPaymentobject | nullDados do pagamento Pix; nulo na cobrança de cartão.
Campos do objeto 7
statusstringStatus do Pix.
pendingpaidcanceledrefundedfailedqrCodestring | nullPix copia e cola; nulo se o Pix não foi gerado.
expiresAtstring | nullData e hora em que o QR Code deixa de aceitar pagamento.
paidAtstring | nullData e hora do pagamento.
canceledAtstring | nullData e hora do cancelamento.
endToEndIdstring | nullIdentificador do Pix no Banco Central, depois do pagamento.
refundsarray of objectsDevoluções do Pix, da mais antiga para a mais recente.
Campos de cada item 6
idstringIdentificador da devolução.
amountintegerValor devolvido em centavos.
statusstringStatus da devolução.
requestedconfirmedfailedcreatedAtstringData e hora do pedido.
confirmedAtstring | nullData e hora da conclusão.
failedAtstring | nullData e hora em que a devolução não se concluiu.
recurrenceobject | nullRecorrência a que a cobrança pertence.
Campos do objeto 6
recurrentPaymentIdstringIdentificador da recorrência.
intervalstringIntervalo entre as cobranças.
MONTHLYANNUALDAILYstatusstringStatus da recorrência.
ACTIVEINACTIVEENDEDamountintegerValor de cada ciclo em centavos.
nextRecurrencystring | nullData da próxima cobrança automática.
endDatestring | nullData final informada na criação.
recurrenceCycleinteger | nullCiclo da recorrência (0 é a cobrança inicial).
400Requisição inválida
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, PZ mais três dígitos; ausente nos erros de autenticação, de cotação e do servidor HTTP.
detailsarray of objectsDetalhes do erro: em 400, os campos recusados; em 422, a recusa original do cartão.
Campos de cada item 2
fieldstringCampo recusado.
messagestringMotivo da recusa.
401Token ou certificado inválido
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
403Acesso negado
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
404Cobrança não encontrada
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, PZ mais três dígitos; ausente nos erros de autenticação, de cotação e do servidor HTTP.
500Erro interno
statusCodeintegerStatus HTTP.
errorstringNome do status HTTP.
messagestringMotivo em texto.
codestringCódigo do erro, PZ mais três dígitos; ausente nos erros de autenticação, de cotação e do servidor HTTP.
requestIdstringID da chamada, para o suporte; só em 5xx.
Esta página ajudou?