Consulta os dados de uma transação

Este endpoint Consulta os dados da transações através do descritivo da referencia adicionado na criação. Exclusivo para transações de pix.

Requisição

CampoTipoDescrição
ReferenciaTextoReferência da consulta da transação

Resposta

CampoTipoDescrição
LinhaDigitavelTextoLinha Digitável do Boleto.
CodigoBarrasTextoCódigo equivalente ao binário do código de barras do boleto gerado.
NossoNumeroTextoNosso número do boleto gerado.
QRCodeTextoTextoTexto do QRCode para realizar o pagamento via Pix.
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
IdentificadorTextoIdentificador da transação.
TipoTextoTipo do pagamento, 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 do cancelamento da compra.
DataPagamentoTextoData do pagamento da transação.
ValorNúmeroValor total 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.
ConfirmaURLBoleanoIndica se a transação foi confirmada na URL do comércio.
SplitsTransacaoSplit-
ClienteIdTextoO Id do seller(ou do marketplace).
ValorNúmeroValor da parte da transação referente ao seller ou marketplace.
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.
ParcelasTransacaoParcela-
NumeroNúmeroNú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 do cancelamento da compra.
DataPagamentoTextoData do pagamento da transação.
ValorNúmeroValor total da transação.
ConfirmadaURLBoleanoIndica se a transação foi confirmada na URL do comércio.
ClienteDescricaoTextoDescrição da compra.
ClienteIPTextoIP do usuário final da compra.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
NumeroPedidoTextoNúmero do pedido e/ou carrinho de compras.
CardTokenTextoO token do cartão para transações de recorrência.
RecorrenteBoleanoRetorna os valores true ou false, informando se esse pagamento é recorrente.
ContaBolsaoBoleanoRetorna 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.
LiquidacaoBoleanoRetorna 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!