Validate a transaction

Use this endpoint to check a transaction against your active rules and the applicable spending limits in real time. Returns a decision (ALLOW, DENY, or REVIEW) along with details about which rules matched and the usage each limit would reach. A DENY or REVIEW by the rules decides. An ALLOW is checked against each applicable limit, and an amount that would take a limit past its maximum answers DENY with the reason limit_exceeded. This call only reads: no limit counter moves and nothing is reserved. Only the ledger’s transaction reserve consumes a limit. A requestId already used with the same body returns the decision stored for it. A different body, or a requestId first used on POST /v1/validations/rules-only, answers 409 (code 0084).

POST /v1/validations

Validate a transaction

cURL

curl --request POST \
  --url https://tracer.sandbox.lerian.net/v1/validations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account": {
    "accountId": "00000000-0000-0000-0000-000000000000",
    "metadata": {},
    "status": "ACTIVE",
    "type": "deposit"
  },
  "amount": "100.00",
  "asset": "USD",
  "requestId": "00000000-0000-0000-0000-000000000000",
  "transactionTimestamp": "2021-01-01T00:00:00Z",
  "metadata": {},
  "scheme": "PIX",
  "subType": "purchase",
  "transactionType": "PIX"
}
'

200

{
  "decision": "ALLOW",
  "evaluatedAt": "2021-01-01T00:00:00Z",
  "evaluatedRuleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "limitUsageDetails": [
    {
      "attemptedAmount": "100.00",
      "currentUsage": "500.00",
      "exceeded": true,
      "limitAmount": "1000.00",
      "limitId": "00000000-0000-0000-0000-000000000000",
      "period": "DAILY",
      "scope": "account:00000000-0000-0000-0000-000000000000",
      "skipReason": "outside_time_window",
      "skipped": true
    }
  ],
  "matchedRuleIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "processingTimeMs": 12.5,
  "reason": "Transaction denied by rule 'Block high-value checking transactions'",
  "requestId": "00000000-0000-0000-0000-000000000000",
  "totalRulesLoaded": 42,
  "truncated": false,
  "validationId": "00000000-0000-0000-0000-000000000000"
}

Autorizaciones

BearerAuthApiKeyAuth

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json

account · object · requerido

Show child attributes

amount · string · requerido

Ejemplo:

"100.00"

asset · string · requerido

Ejemplo:

"USD"

requestId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

transactionTimestamp · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

merchant · object

Show child attributes

metadata · object

Show child attributes

portfolio · object

Show child attributes

scheme · string

Payment scheme, required unless the deprecated transactionType is sent: 1 to 50 characters of A-Z, 0-9, _ or - after trimming and upper-casing.

Maximum string length: 50

Ejemplo:

"PIX"

segment · object

Show child attributes

subType · string

Sub type, at most 50 bytes after trimming; stored lower-cased and matched case-insensitively.

Maximum string length: 50

Ejemplo:

"purchase"

transactionType · string · obsoleto

Deprecated: use scheme. Same value under its former name; when both are sent they must match.

Maximum string length: 50

Ejemplo:

"PIX"

Respuesta

200

application/json

OK

decision · string · requerido

Ejemplo:

"ALLOW"

evaluatedAt · string<date-time> · requerido

Ejemplo:

"2021-01-01T00:00:00Z"

evaluatedRuleIds · string<uuid>[] | null · requerido

limitUsageDetails · object[] | null · requerido

Show child attributes

matchedRuleIds · string<uuid>[] | null · requerido

processingTimeMs · number<double> · requerido

Ejemplo:

12.5

reason · string · requerido

Ejemplo:

"Transaction denied by rule 'Block high-value checking transactions'"

requestId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"

totalRulesLoaded · integer<int64> · requerido

Ejemplo:

42

truncated · boolean · requerido

Ejemplo:

false

validationId · string<uuid> · requerido

Ejemplo:

"00000000-0000-0000-0000-000000000000"