Flex control evaluated
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: rules
Event: evaluation_requested
Version: 1
request
Title: The evaluation request
Type: objectamount required
Title: The amount of the payment transaction.
Type: integer
Example:
49999accounts
Title: The accounts related to the transaction.
Type: objectfrom
Title: The account the transaction originated from.
Type: object
Example:{ "id": 292933, "customer_id": 50000, "card_id": 40000, "processing_code": "007100", "currency_code": "USD", "balance": 60000 }id required
Title: The account ID.
Type: integer
Example:
292933balance
Title: The balance of the account.
Type: integer
Example:
60000card_id
Title: The card ID.
Type: integer
Example:
40000currency_code
Title: The currency code based on ISO-4217.
Type: string
Example:
USDcustomer_id
Title: The customer ID.
Type: integer
Example:
50000processing_code
Title: The processing code of the transaction.
Type: string
Min length: 1
Max length: 6
Example:
007100to
Title: The transaction target account.
Type: object
Example:{ "id": 292344, "customer_id": 50000, "card_id": 40000, "processing_code": "007100", "currency_code": "USD", "balance": 10000 }id required
Title: The account ID.
Type: integer
Example:
292344balance
Title: The balance of the account.
Type: integer
Example:
10000card_id
Title: The card ID.
Type: integer
Example:
40000currency_code
Title: The currency code based on ISO-4217.
Type: string
Example:
USDcustomer_id
Title: The customer ID.
Type: integer
Example:
50000processing_code
Title: The processing code of the transaction.
Type: string
Min length: 1
Max length: 6
Example:
007100currency_code
Title: The currency code based on ISO-4217.
Type: string
Min length: 1
Max length: 3
Example:
USDentry_mode
Title: The entry mode are numeric or string codes that identify the method a card transaction was captured.
Type: string
Min length: 1
Max length: 1024
Example:
9180force
Title: Force to evaluate true due to Anti-Fraud decision.
Type: boolean
Example:
truemerchant_category_code
Title: A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services.
Type: string
Min length: 1
Max length: 1024
Example:
5542merchant_id
Title: The merchant ID.
Type: string
Min length: 1
Max length: 1024
Example:
2ca51949-3d57-4f70-81b7-cc6a20d6bb4bsimulation
Title: The evaluation request is for simulating evaluation.
Type: boolean
Example:
falsetracking_id
Title: The tracking id of the request.
Type: string
Min length: 1
Max length: 254
Example:
ee065d92-339f-405d-99fd-4ed75b784bc7country_code
Title: Origin country of the transaction, in the three-letter country code defined in 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:
false
result
Title: The evaluation result
Type: objectresult required
Title: The evaluation result value
Type: boolean
Example:
truedeny_code
Title: The deny code
Type: string
Min length: 1
Max length: 100
Example:
MAX_LIMIT_USD_P1Mmessage
Title: The result message
Type: string
Min length: 1
Max length: 1024
Example:
[dd9ff885-14da-40e6-8b54-bb56fce06936] Got value '22095' and the rule value is '1'.response_code
Title: Alphanumeric two-character response code. This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.
Type: string
Min length: 2
Max length: 2
Example:
FM
57
05
{
"$schema": "http://json-schema.org/draft-07/schema",
"required": [
"request",
"result"
],
"title": "Flex control evaluated",
"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>",
"type": "object",
"properties": {
"request": {
"required": [
"amount"
],
"title": "The evaluation request",
"type": "object",
"properties": {
"amount": {
"title": "The amount of the payment transaction.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
49999
]
},
"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",
"currency_code": "USD",
"balance": 60000
}
],
"required": [
"id"
],
"title": "The account the transaction originated from.",
"type": "object",
"properties": {
"id": {
"title": "The account ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
292933
]
},
"balance": {
"title": "The balance of the account. ",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
60000
]
},
"card_id": {
"title": "The card ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
40000
]
},
"currency_code": {
"examples": [
"USD"
],
"title": "The currency code based on ISO-4217.",
"type": "string"
},
"customer_id": {
"title": "The customer ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
50000
]
},
"processing_code": {
"title": "The processing code of the transaction.",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"007100"
]
}
}
},
"to": {
"examples": [
{
"id": 292344,
"customer_id": 50000,
"card_id": 40000,
"processing_code": "007100",
"currency_code": "USD",
"balance": 10000
}
],
"required": [
"id"
],
"title": "The transaction target account.",
"type": "object",
"properties": {
"id": {
"title": "The account ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
292344
]
},
"balance": {
"title": "The balance of the account.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
10000
]
},
"card_id": {
"title": "The card ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
40000
]
},
"currency_code": {
"examples": [
"USD"
],
"title": "The currency code based on ISO-4217.",
"type": "string"
},
"customer_id": {
"title": "The customer ID.",
"type": "integer",
"minimum": 1,
"maximum": 18446744073709551617,
"examples": [
50000
]
},
"processing_code": {
"title": "The processing code of the transaction.",
"type": "string",
"minLength": 1,
"maxLength": 6,
"examples": [
"007100"
]
}
}
}
}
},
"currency_code": {
"title": "The currency code based on ISO-4217.",
"type": "string",
"minLength": 1,
"maxLength": 3,
"examples": [
"USD"
]
},
"entry_mode": {
"title": "The entry mode are numeric or string codes that identify the method a card transaction was captured.",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"9180"
]
},
"force": {
"title": "Force to evaluate true due to Anti-Fraud decision.",
"type": "boolean",
"examples": [
true
]
},
"merchant_category_code": {
"title": "A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services.",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"5542"
]
},
"merchant_id": {
"title": "The merchant ID.",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"2ca51949-3d57-4f70-81b7-cc6a20d6bb4b"
]
},
"simulation": {
"title": "The evaluation request is for simulating evaluation.",
"type": "boolean",
"examples": [
false
]
},
"tracking_id": {
"title": "The tracking id of the request.",
"type": "string",
"minLength": 1,
"maxLength": 254,
"examples": [
"ee065d92-339f-405d-99fd-4ed75b784bc7"
]
},
"country_code": {
"title": "Origin country of the transaction, in the three-letter country code defined in 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
]
}
}
},
"result": {
"required": [
"result"
],
"title": "The evaluation result",
"type": "object",
"properties": {
"result": {
"title": "The evaluation result value",
"type": "boolean",
"examples": [
true
]
},
"deny_code": {
"title": "The deny code",
"type": "string",
"minLength": 1,
"maxLength": 100,
"examples": [
"MAX_LIMIT_USD_P1M"
]
},
"message": {
"title": "The result message",
"type": "string",
"minLength": 1,
"maxLength": 1024,
"examples": [
"[dd9ff885-14da-40e6-8b54-bb56fce06936] Got value '22095' and the rule value is '1'."
]
},
"response_code": {
"title": "Alphanumeric two-character response code. This can be the standard card network response code or an alternative custom response code. When the platform denies a control evaluation, it returns the response code that provides the precise reason for the denial by the card network or anti-fraud solution.",
"type": "string",
"minLength": 2,
"maxLength": 2,
"examples": [
"FM",
"57",
"05"
]
}
}
}
}
}
{
"request": {
"amount": 49999,
"accounts": {
"from": {
"id": 292933,
"balance": 60000,
"card_id": 40000,
"currency_code": "USD",
"customer_id": 50000,
"processing_code": "007100"
},
"to": {
"id": 292344,
"balance": 10000,
"card_id": 40000,
"currency_code": "USD",
"customer_id": 50000,
"processing_code": "007100"
}
},
"currency_code": "USD",
"entry_mode": "9180",
"force": true,
"merchant_category_code": "5542",
"merchant_id": "2ca51949-3d57-4f70-81b7-cc6a20d6bb4b",
"simulation": false,
"tracking_id": "ee065d92-339f-405d-99fd-4ed75b784bc7",
"country_code": "BRA",
"number_of_installments": false,
"is_password_present": false,
"is_physical_card_present": false
},
"result": {
"result": true,
"deny_code": "MAX_LIMIT_USD_P1M",
"message": "[dd9ff885-14da-40e6-8b54-bb56fce06936] Got value '22095' and the rule value is '1'.",
"response_code": "FM"
}
}
Updated 15 days ago