Evaluation requested
This event occurs asynchronously when the platform completes an evaluation request of a flex control. The event contains information about the evaluated parameters and the result of the evaluation.
More information: Flexible transaction controls
Type: object
Domain: audit
Event: evaluation_requested
Version: 1
method required
Title: The HTTP Method of address register operation
Type: string
Example:
POST
uri required
Title: The URI of address register operation
Type: string
Example:
/v1/evaluation
email required
Title: The email of operator that registered address
Type: string
Example:
[email protected]
roles required
Type: array
origin required
Title: The request origin of address register operation
Type: string
Example:
P2P
PAYMENTS
object required
Title: The Evaluation request
Type: objectrequest required
Title: The evaluation request
Type: objectamount required
Title: The amount of the payment transaction.
Type: integer
Example:
49999currency_code
Title: The currency code based on ISO-4217.
Type: string
Example:
USDaccounts
Title: The accounts related to the transaction
Type: objectfrom required
Title: The account the transaction originated from
Type: object
Example:{ "id": 292933, "customer_id": 50000, "card_id": 40000, "processing_code": "007100", "balance": 60000 }id required
Title: The account ID.
Type: integer
Example:
292933customer_id
Title: The customer ID.
Type: integer
Example:
50000card_id
Title: The card ID.
Type: integer
Example:
40000processing_code
Title: The Processing Code of the transaction.
Type: string
Example:
007100balance
Title: The Balance of the account.
Type: integer
Example:
60000to
Title: The transaction targed account
Type: object
Example:{ "id": 292344, "customer_id": 50000, "card_id": 40000, "processing_code": "007100", "balance": 10000 }id required
Title: The account ID.
Type: integer
Example:
292344customer_id
Title: The customer ID.
Type: integer
Example:
50000card_id
Title: The card ID.
Type: integer
Example:
40000processing_code
Title: The Processing Code of the transaction.
Type: string
Example:
007100balance
Title: The Balance of the account.
Type: integer
Example:
10000merchant_id
Title: The merchant ID.
Type: string
Example:
2ca51949-3d57-4f70-81b7-cc6a20d6bb4bmerchant_category_code
Title: A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services.
Type: string
Example:
5542entry_mode
Title: The entry mode are numeric or string codes that identify the method a card transaction was captured.
Type: string
Example:
9180simulation
Title: The evaluation request is for simulating evaluation.
Type: boolean
Example:
falseforce
Title: Force to evaluate true due to Anti-Fraud decision.
Type: boolean
Example:
truetracking_id
Title: The tracking id of the request.
Type: string
Example:
ee065d92-339f-405d-99fd-4ed75b784bc7country_code
Title: The country where the transaction originated. The country code is a three-letter code defined by ISO 3166-1.
Type: string
Min length: 3
Max length: 3
Example:
BRAnumber_of_installments
Title: Number of installments in the operation.
Type: integer
Example:
falseis_password_present
Title: Flag that indicates whether the password is present in the evaluation request for the contactless transaction.
Type: boolean
Example:
falseis_physical_card_present
Title: Flag that indicates whether a physical card is present.
Type: boolean
Example:
falsecard_mode
Title: Specifies the operational mode of the card.
Description: Specifies the operational mode of the card.
Type: string
Must be one of the following:
credit
debit
Example:
creditis_device_registered
Title: Is device registered
Description: Indicates whether the device used for the operation is registered according to the financial institution's security policies.
Type: boolean
Example:
falseresult required
Title: The evaluation result
Type: objectresult required
Title: The evaluation result value
Type: boolean
Example:
truemessage
Title: The result message
Type: string
Example:
[dd9ff885-14da-40e6-8b54-bb56fce06936] Got value '22095' and the rule value is '1'.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"title": "Evaluation requested",
"description": "This event occurs asynchronously when the platform completes an evaluation request of a flex control. The event contains information about the evaluated parameters and the result of the evaluation. <br> More information: <a href='https://developers.pismo.io/pismo-docs/docs/flex-controls' target='_blank'>Flexible transaction controls</a>",
"required": [
"method",
"uri",
"email",
"roles",
"origin",
"object"
],
"properties": {
"method": {
"type": "string",
"title": "The HTTP Method of address register operation",
"examples": [
"POST"
]
},
"uri": {
"type": "string",
"title": "The URI of address register operation",
"examples": [
"/v1/evaluation"
]
},
"email": {
"type": "string",
"title": "The email of operator that registered address",
"examples": [
"[email protected]"
]
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"title": "The roles of operator that registered address",
"examples": [
"test1",
"test2"
]
},
"origin": {
"type": "string",
"title": "The request origin of address register operation",
"examples": [
"P2P",
"PAYMENTS"
]
},
"object": {
"type": "object",
"title": "The Evaluation request",
"required": [
"request",
"result"
],
"properties": {
"request": {
"required": [
"amount"
],
"title": "The evaluation request",
"type": "object",
"properties": {
"amount": {
"type": "integer",
"title": "The amount of the payment transaction.",
"examples": [
49999
]
},
"currency_code": {
"examples": [
"USD"
],
"title": "The currency code based on ISO-4217.",
"type": "string"
},
"accounts": {
"required": [
"from"
],
"title": "The accounts related to the transaction",
"type": "object",
"properties": {
"from": {
"examples": [
{
"id": 292933,
"customer_id": 50000,
"card_id": 40000,
"processing_code": "007100",
"balance": 60000
}
],
"required": [
"id"
],
"title": "The account the transaction originated from",
"type": "object",
"properties": {
"id": {
"examples": [
292933
],
"title": "The account ID.",
"type": "integer"
},
"customer_id": {
"examples": [
50000
],
"title": "The customer ID.",
"type": "integer"
},
"card_id": {
"examples": [
40000
],
"title": "The card ID.",
"type": "integer"
},
"processing_code": {
"examples": [
"007100"
],
"title": "The Processing Code of the transaction.",
"type": "string"
},
"balance": {
"examples": [
60000
],
"title": "The Balance of the account.",
"type": "integer"
}
}
},
"to": {
"examples": [
{
"id": 292344,
"customer_id": 50000,
"card_id": 40000,
"processing_code": "007100",
"balance": 10000
}
],
"required": [
"id"
],
"title": "The transaction targed account",
"type": "object",
"properties": {
"id": {
"examples": [
292344
],
"title": "The account ID.",
"type": "integer"
},
"customer_id": {
"examples": [
50000
],
"title": "The customer ID.",
"type": "integer"
},
"card_id": {
"examples": [
40000
],
"title": "The card ID.",
"type": "integer"
},
"processing_code": {
"examples": [
"007100"
],
"title": "The Processing Code of the transaction.",
"type": "string"
},
"balance": {
"examples": [
10000
],
"title": "The Balance of the account.",
"type": "integer"
}
}
}
}
},
"merchant_id": {
"examples": [
"2ca51949-3d57-4f70-81b7-cc6a20d6bb4b"
],
"title": "The merchant ID.",
"type": "string"
},
"merchant_category_code": {
"examples": [
"5542"
],
"title": "A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services.",
"type": "string"
},
"entry_mode": {
"examples": [
"9180"
],
"title": "The entry mode are numeric or string codes that identify the method a card transaction was captured.",
"type": "string"
},
"simulation": {
"examples": [
false
],
"title": "The evaluation request is for simulating evaluation.",
"type": "boolean"
},
"force": {
"examples": [
true
],
"title": "Force to evaluate true due to Anti-Fraud decision.",
"type": "boolean"
},
"tracking_id": {
"examples": [
"ee065d92-339f-405d-99fd-4ed75b784bc7"
],
"title": "The tracking id of the request.",
"type": "string"
},
"country_code": {
"title": "The country where the transaction originated. The country code is a three-letter code defined by ISO 3166-1.",
"type": "string",
"minLength": 3,
"maxLength": 3,
"examples": [
"BRA"
]
},
"number_of_installments": {
"title": "Number of installments in the operation.",
"type": "integer",
"minimum": 1,
"maximum": 255,
"examples": [
false
]
},
"is_password_present": {
"title": "Flag that indicates whether the password is present in the evaluation request for the contactless transaction.",
"type": "boolean",
"examples": [
false
]
},
"is_physical_card_present": {
"title": "Flag that indicates whether a physical card is present.",
"type": "boolean",
"examples": [
false
]
},
"card_mode": {
"title": "Specifies the operational mode of the card.",
"description": "Specifies the operational mode of the card.",
"type": "string",
"enum": [
"credit",
"debit"
],
"examples": [
"credit"
]
},
"is_device_registered": {
"title": "Is device registered",
"description": "Indicates whether the device used for the operation is registered according to the financial institution's security policies.",
"type": "boolean",
"examples": [
false
]
}
}
},
"result": {
"required": [
"result"
],
"title": "The evaluation result",
"type": "object",
"properties": {
"result": {
"examples": [
true
],
"title": "The evaluation result value",
"type": "boolean"
},
"message": {
"examples": [
"[dd9ff885-14da-40e6-8b54-bb56fce06936] Got value '22095' and the rule value is '1'."
],
"title": "The result message",
"type": "string"
}
}
}
}
}
}
}
Updated 15 days ago