← Back to schema index

ValidationStats

JSON:API resource with validation counters by `banxico_status`, lifecycle state, and validation mode.

Properties

FieldTypeDescription
typestringJSON:API resource type. Always `validation_stats`.
attributesobjectAggregated counters under the request filters.
totalintegerValidations matching the filters, regardless of verdict.
validintegerNumber of validations confirmed by Banxico (CEP available).
not_foundintegerNumber of transfers with no match in Banxico.
cep_unavailableintegerNumber of validations whose CEP was not available even though Banxico recognized the transaction.
returnedintegerNumber of validations whose transfer was settled and later returned.
errorintegerValidations without a conclusive verdict because of an error.
pendingintegerNumber of validations whose processing is under way.
deletedintegerWithdrawn validations matching the remaining filters.
otherintegerDifference between `total` and the six verdict counters.
by_typeobjectBreakdown by validation type. `direct + ocr` always sums to `total`.
direct*integerManual validations using CLABE, card, or phone fields.
ocr*integerOCR validations (from a receipt image).
by_statusobjectBreakdown by lifecycle state. All nine properties are always present and add up to `total`.
queued*integerAccepted validations awaiting processing.
processing*integerValidations currently being processed.
valid*integerValidations with a transfer confirmed in the CEP.
not_found*integerValidations with no matching transfer in the CEP.
cep_unavailable*integerNumber of validations whose CEP was not available even though Banxico recognized the transaction.
invalid*integerValidations rejected because of invalid data.
returned*integerValidations whose transfer was settled and later returned.
failed*integerValidations with a terminal processing failure.
error*integerValidations whose processing ended with an error.

Used in operations

  • GET /v1/validations/stats