Pular para o conteúdo principal
GET
Recuperar uma Validação de Transação

Autorizações

X-API-Key
string
header
obrigatório

Autenticação por API Key. Usada por implantações single-tenant (MULTI_TENANT_ENABLED=false). Enviada em todas as requisições /v1/*.

Cabeçalhos

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

X-API-Key
string
obrigatório

A chave de API para autenticação. Este header é obrigatório para todos os endpoints, exceto verificações de integridade.

X-Request-Id
string<uuid>

Um identificador único usado para rastrear cada requisição.

Parâmetros de caminho

id
string<uuid>
obrigatório

O identificador único da validação de transação que você deseja recuperar.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

Registro completo de validação de transação.

validationId
string<uuid>

Identificador único gerado pelo servidor para este registro de validação.

requestId
string<uuid>

Identificador de requisição fornecido pelo cliente para correlação.

transactionType
enum<string>

Tipo de transação (método de pagamento).

Opções disponíveis:
CARD,
WIRE,
PIX,
CRYPTO
subType
string

Subtipo da transação para contexto adicional.

amount
string

Valor da transação como string decimal (ex.: "1500.00").

currency
string

Código de moeda ISO 4217.

transactionTimestamp
string<date-time>

Quando a transação ocorreu.

decision
enum<string>

Decisão da validação.

Opções disponíveis:
ALLOW,
DENY,
REVIEW
reason
string

Motivo legível da decisão.

account
object

Contexto da conta para validação.

segment
object

Contexto do segmento (opcional). Se fornecido, segmentId é obrigatório.

portfolio
object

Contexto do portfólio (opcional). Se fornecido, portfolioId é obrigatório.

merchant
object

Contexto do estabelecimento (opcional, recomendado para transações de cartão). Se fornecido, merchantId é obrigatório.

metadata
object

Pares chave-valor personalizados fornecidos na requisição.

matchedRuleIds
string<uuid>[]

IDs das regras que corresponderam e dispararam a decisão.

evaluatedRuleIds
string<uuid>[]

IDs de todas as regras que foram avaliadas.

limitUsageDetails
object[]

Detalhes sobre cada limite verificado durante a validação.

processingTimeMs
number<double>

Tempo de processamento em milissegundos.

totalRulesLoaded
integer

Número total de regras carregadas para avaliação.

truncated
boolean

Se a resposta foi truncada devido a limites de tamanho.

createdAt
string<date-time>

Quando o registro de validação foi criado.