---
title: "Consulta os dados de uma transação"
method: POST
path: "/api/ConsultaTransacao"
tags: ["ConsultaTransacao"]
---

# Consulta os dados de uma transação

`POST /api/ConsultaTransacao`

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.
<br /> 

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** | 
|--|--|--|--| 
 |Identificador | GUID | Identificador da transação a ser consultada | Sim | 
 
### Resposta
 | **Campo** | **Tipo** | **Descrição** | 
|--|--| --| 
| 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 da transação |
| Estado           | Texto    | Estado da transação |
| MotivoCancelamento | Texto  | Motivo de cancelamento da transação, caso tenha sido cancelada |
| DataPagamento    | Texto    | Data/hora de pagamento da transação |
| Valor            | Número   | Valor da transação destinado ao Marketplace ou Seller |
| 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      | Booleano  | Indica se a transação foi confirmada na URL do comércio |
| Splits           | TransacaoSplit | Lista de “splits” relacionados à transação, indicando o código do cliente e o respectivo valor relacionado |
| ClienteId        | Texto    | Identificador do Cliente |
| Valor            | Número   | Valor da transação destinado ao Marketplace ou Seller |
| ValorRoyalties    | Número   | Valor da transação destinado ao Marketplace ou Seller, sobre o qual poderão incidir taxas, conforme a configuração prévia definida para o participante do split |
| Decisão          | Texto    | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor |
| Parcelas         | TransacaoParcela | Número de parcelas |
| Estado           | Texto    | Estado da transação |
| MotivoCancelamento | Texto  | Motivo de cancelamento da transação, caso tenha sido cancelada |
| DataPagamento    | Texto    | Data/hora de pagamento da transação |
| Valor            | Número   |Valor da transação destinado ao Marketplace ou Seller |
| ConfirmadaURL    | Booleano  | Indica se a transação foi confirmada na URL do comércio |
| ClienteDescricao  | Texto    | Descrição do cliente final da transação |
| ClienteIP        | Texto    | IP do cliente final da transação |
| 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    | Código identificador do token do cartão |
| Recorrente       | Booleano  | Aceita os valores true ou false, informando se esse pagamento é recorrente |
| ContaBolsao      | Booleano  | 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       | Booleano  | 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 |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessConsultaTransacaoRequest
  - `Identificador` string, required

## Response `200`

Método executado com sucesso

- BknBankPagamentosBusinessConsultaTransacaoResponse
  - `Retorno` 'OK' | 'ERRO'
  - `DetalhesErro` string
  - `Identificador` string
  - `Tipo` 'Todos' | 'NaoDefinido' | 'Boleto' | 'Cartao' | 'Pix' | 'Ted' | 'SaldoWebConta' | 'BoletoHibrido' | 'OpenFinance' | 'Manual'
  - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH'
  - `TipoPagamento` 'todos' | 'naodefinido' | 'boleto' | 'cartao' | 'pix' | 'ted' | 'SaldoWebConta' | 'OpenFinance' | 'Manual'
  - `MotivoCancelamento` string
  - `DataPagamento` string, date-time
  - `Valor` number, double
  - `ValorPago` number, double
  - `ValorTaxas` number, double
  - `DetalhesValores` BknBankPagamentosBusinessDetalhesValores
    - `ValorDesconto` number, double
    - `ValorDesconto2` number, double
    - `ValorDesconto3` number, double
    - `ValorMulta` number, double
    - `ValorJuros` number, double
  - `ConfirmadaURL` boolean
  - `Splits` BknBankPagamentosBusinessTransacaoSplit[]
    - `ClienteId` string, uuid
    - `Valor` number, double
    - `ValorRoyalties` number, double
    - `Decisao` string
  - `Parcelas` BknBankPagamentosBusinessTransacaoParcela[]
    - `Numero` integer
    - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH'
    - `MotivoCancelamento` string
    - `DataPagamento` string, date-time
    - `Valor` number, double
    - `ConfirmadaURL` boolean
  - `ClienteDescricao` string
  - `ClienteIP` string
  - `ClienteCPFCNPJ` string
  - `ClienteNome` string
  - `NumeroPedido` string
  - `CardToken` string, uuid
  - `Recorrente` boolean
  - `ContaBolsao` boolean
  - `Referencia` string
  - `DataLiquidacao` string, date-time
  - `DataDisponibilizacao` string, date-time
  - `Liquidado` boolean
  - `EndToEnd` string
  - `LinhaDigitavel` string
  - `CodigoBarras` string
  - `NossoNumero` string
  - `QRCodeTexto` string
  - `CanalPagamento` 'NaoDefinido' | 'AgenciasPostosTradicionais' | 'TerminalAutoAtendimento' | 'Internet' | 'Pix' | 'CorrespondenteBancario' | 'CentralAtendimento' | 'ArquivoEletronico' | 'DDA' | 'CorrespondenteBancarioDigital'
  - `MeioPagamento` 'NaoDefinido' | 'Especie' | 'DebitoEmConta' | 'CartaoCredito' | 'Cheque'
  - `ContaEmissao` string

## Other responses

- `500` — Erro executando método

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)