post https://pagamentos.k8bank.com.br/PagamentosAPI/api/ConsultaTransacaoReferencia
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
Campo | Tipo | Descrição |
---|---|---|
Referencia | Texto | Referência da consulta da transação |
Resposta
Campo | Tipo | Descrição |
---|---|---|
LinhaDigitavel | Texto | Linha Digitável do Boleto. |
CodigoBarras | Texto | Código equivalente ao binário do código de barras do boleto gerado. |
NossoNumero | Texto | Nosso número do boleto gerado. |
QRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix. |
Retorno | Texto | Retorno da chamada, podendo possuir os valores OK ou ERRO. |
DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO. |
Identificador | Texto | Identificador da transação. |
Tipo | Texto | Tipo do pagamento, podendo ser: NaoDefinido, Boleto, Cartao, Pix, Ted, SaldoWebConta, BoletoHibrido, OpenFinance. |
Estado | Texto | Estado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento. |
MotivoCancelamento | Texto | Motivo do cancelamento da compra. |
DataPagamento | Texto | Data do pagamento da transação. |
Valor | Número | Valor total da transação. |
ValorPago | Número | Valor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado. |
ConfirmaURL | Boleano | Indica se a transação foi confirmada na URL do comércio. |
Splits | TransacaoSplit | - |
ClienteId | Texto | O Id do seller(ou do marketplace). |
Valor | Número | Valor da parte da transação referente ao seller ou marketplace. |
ValorRoyalties | Número | Valor da parte da transação referente ao seller ou marketplace. |
Decisão | Texto | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor. |
Parcelas | TransacaoParcela | - |
Numero | Número | Número de parcelas. |
Estado | Texto | Estado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento. |
MotivoCancelamento | Texto | Motivo do cancelamento da compra. |
DataPagamento | Texto | Data do pagamento da transação. |
Valor | Número | Valor total da transação. |
ConfirmadaURL | Boleano | Indica se a transação foi confirmada na URL do comércio. |
ClienteDescricao | Texto | Descrição da compra. |
ClienteIP | Texto | IP do usuário final da compra. |
ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação. |
ClienteNome | Texto | Nome do cliente final da transação. |
NumeroPedido | Texto | Número do pedido e/ou carrinho de compras. |
CardToken | Texto | O token do cartão para transações de recorrência. |
Recorrente | Boleano | Retorna os valores true ou false, informando se esse pagamento é recorrente. |
ContaBolsao | Boleano | Retorna true ou false, para informar se os valores estão alocados em conta bolsão k8. |
Referencia | Texto | Referência para localização futura do boleto. |
DataLiquidacao | Texto | Data em que os valores da transação foram disponibilizados ao recebedor. |
DataDisponibilizacao | Texto | Data da disponibilização do valor ao recebedor. |
Liquidacao | Boleano | Retorna se foi realizada a liquidação da transação. |
EndToEnd | Texto | Exclusivos para transação do tipo pix, retornando o end to end da transação. |