Fraud notification service
Afetr a successful transaction with antifraud (payment status CON
, PPC
, PPN
or EST
), the merchant may identify that, in reality, a fraud occurred. In this case, the merchant can call the fraud notification service to warn the risk analysis institution about this occurrence. This will refine the analysis process of said institution, making it more accurate and preventing more frauds in the future.
Currently, this API supports the following antifraud institutions:
- Konduto
- Fraud Detect
Call details
- Resource:
/v1/transactions/{nit}/fraud
- HTTP method:
POST
- Request format:
JSON
- Response format:
JSON
- Header parameters:
Parameter | Description | Format | Mandatory |
---|---|---|---|
merchant_id | Merchant code on e-SiTef. The production and certification codes will be different. | < 15 AN | YES |
merchant_key | Merchant authentication key on e-SiTef. The production and certification keys will be different. | < 80 AN | YES |
Content-Type | It must be sent with the value application/json . | = 15 AN | YES |
Examples
Below is an example of a fraud notification service call using the cURL tool.
Request:
curl
--request POST "https://esitef-homologacao.softwareexpress.com.br/e-sitef/api/v1/transactions/1234567890abcdefghijklmnopqrstuvwxyz1234567890abcdefghijklmnopqr/fraud"
--header "Content-Type: application/json"
--header "merchant_id: xxxxxxxx"
--header "merchant_key: xxxxxxxxxxx"
--data-binary
{}
--verbose
Response:
{
"code":"0",
"message":"OK. Transaction successful.",
"analysis":{
"code":"0",
"message":"Success"
}
}
Request parameters
Currently, there are no parameters to be sent in the request body.
Response parameters
If successful, the HTTP response code will be 201
. Any other code must be interpreted as an error. The table below describes the response parameters of the fraud notification service:
Parameter | Description | Format |
---|---|---|
code | e-SiTef response code. Any code different from 0 means failure. Learn more. | < 4 N |
message | e-SiTef response message. | < 500 AN |
analysis | ||
code | Risk analysis institution response code. | < 4 N |
message | Risk analysis institution response message. | < 500 AN |