Pular para o conteúdo principal
GET
/
v1
/
validations
/
{validation_id}
Recuperar uma Validação de Transação
curl --request GET \
  --url https://tracer.lerian.io/v1/validations/{validation_id} \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{
  "validationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionType": "CARD",
  "subType": "<string>",
  "amount": 123,
  "currency": "<string>",
  "transactionTimestamp": "2023-11-07T05:31:56Z",
  "decision": "ALLOW",
  "reason": "<string>",
  "account": {
    "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "checking",
    "status": "active",
    "metadata": {}
  },
  "segment": {
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "metadata": {}
  },
  "portfolio": {
    "portfolioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "metadata": {}
  },
  "merchant": {
    "merchantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "category": "<string>",
    "country": "<string>",
    "metadata": {}
  },
  "metadata": {},
  "matchedRuleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "evaluatedRuleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "limitUsageDetails": [
    {
      "limitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "limitAmount": 123,
      "currentUsage": 123,
      "exceeded": true,
      "period": "DAILY",
      "scope": "<string>",
      "attemptedAmount": 123
    }
  ],
  "processingTimeMs": 123,
  "totalRulesLoaded": 123,
  "truncated": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

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

validation_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
integer

Valor da transação em centavos (menor unidade monetária).

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
integer

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.