Consulta os dados de uma transação

Este método permite consultar uma determinada transação pela identificação, sendo utilizado principalmente para os comércios detectarem se uma determinada transação associada a uma compra foi paga ou cancelada.

Requisição

CampoTipoDescriçãoObrigatório
IdentificadorGUIDIdentificador da transação a ser consultada.Sim

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
IdentificadorTextoIdentificador da transação.
TipoTextoTipo da transação, podendo ser: NaoDefinido, Boleto, Cartao, Pix, Ted, SaldoWebConta, BoletoHibrido, OpenFinance.
EstadoTextoEstado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento.
MotivoCancelamentoTextoMotivo de cancelamento da transação, caso tenha sido cancelada.
DataPagamentoTextoData/hora de pagamento da transação.
ValorNúmeroValor da transação.
ValorPagoNúmeroValor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado.
ConfirmaURLBooleanoIndica se a transação foi confirmada na URL do comércio.
SplitsTransacaoSplitLista de “splits” relacionados à transação, indicando o código do cliente e o respectivo valor relacionado.
ClienteIdTextoIdentificador do Cliente.
ValorNúmeroValor da Transação.
ValorRoyaltiesNúmeroValor da parte da transação referente ao seller ou marketplace.
DecisãoTextoInforma se o split já está aprovado ou não para efetivação da transferência para o recebedor.
ParcelasTransacaoParcelaNúmero de parcelas.
EstadoTextoEstado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento.
MotivoCancelamentoTextoMotivo de cancelamento da transação, caso tenha sido cancelada.
DataPagamentoTextoData/hora de pagamento da transação.
ValorNúmeroValor da transação.
ConfirmadaURLBooleanoIndica se a transação foi confirmada na URL do comércio.
ClienteDescricaoTextoDescrição do cliente final da transação.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
NumeroPedidoTextoNúmero do pedido e/ou carrinho de compras.
CardTokenTextoCódigo identificador do token do cartão.
RecorrenteBooleanoAceita os valores true ou false, informando se esse pagamento é recorrente.
ContaBolsaoBooleanoRetorna true ou false, para informar se os valores estão alocados em conta bolsão k8.
ReferenciaTextoReferência para localização futura do boleto.
DataLiquidacaoTextoData em que os valores da transação foram disponibilizados ao recebedor.
DataDisponibilizacaoTextoData da disponibilização do valor ao recebedor.
LiquidacaoBooleanoRetorna se foi realizada a liquidação da transação.
EndToEndTextoExclusivos para transação do tipo pix, retornando o end to end da transação.
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!