API Reference
Log In

Busca Cobrança por ID

Este end-point tem como objetivo consultar uma cobrança pelo ID.

ChargeResponse

VariávelTipoDescrição
idNumberId da cobrança que foi buscada
orderStringNúmero de ordem da cobrança
descriptionStringDescrição da cobrança
softDescriptorStringDescrição dos dados de fatura do cartão de crédito do cliente
dateDateData da cobrança
totalValueNumberValor total da cobrança recorrente
subscriptionIdNumberIdentificador da assinatura da qual a cobrança pertence
statusChargeStatusStatus atual da cobrança
installmentNumberNúmero da parcela a qual a determinada cobrança se refere
paymentInformationTransaction[]Informações de tentativas de pagamento da cobrança
referenceStringNúmero de referencia da cobrança de recorrência
cancellationDateDateData de cancelamento da cobrança (caso ela tenha sido cancelada)

ChargeStatus

VariávelDescrição
PAYEDCobrança paga
TO_CANCELCobrançaem processo de cancelada dado o cancelamento de uma assinatura
CANCELEDCobrança cancelada dado o cancelamento de uma assinatura
FAILEDTodas as tentativas de cobrança falharam
RETRYA tentativa de cobrança falhou e deve ser realizada novamente
PENDINGA cobrança está pendente e deverá ser realizada na sua data
BLOCKEDA cobrança está bloqueada tendo em devido a falta de pagamento

Transaction

VariávelTipoDescrição
orderStringNúmero de ordem da transação realizada
statusTransactionStatusStatus da transação
acquirerMessageStringMensagem de erro em caso de falha de pagamento
valueCentsNumberValor da cobrança

TransactionStatus

VariávelDescrição
AUTHORIZEDTransação autorizada e efetivada
NOT_AUTHORIZEDTransação não autorizada
CANCELEDTransação cancelada
ERRORAconteceu um erro na realização da transação
Language
Authorization
Header
Click Try It! to start a request and see the response here!