​
Fraud Detection Request

This endpoint evaluates the risk level of a transaction by calculating a fraud percentage based on a predefined threshold and limit. All fields are required. Ensure that the transaction_id is unique for each request to maintain data integrity.

​
Request Endpoint

POST: {{BASE_URL}}/api/v1/monitoring/transaction_monitoring/

  • Media-Type: application/json

​
Status Codes

  • 201 Created: Transaction processed successfully. Fraud score calculated based on threshold.
  • 400 Bad Request: Missing or invalid fields in the request.
  • 500 Internal Server Error: Unexpected error during processing. The request body is not set correctly.

​
Payload Example Request

{
  "transaction_id": "13274",
  "amount": 25000.00,
  "currency": "NGN",
  "transaction_type": "card",
  "timestamp": "2024-05-23T14:30:00Z",
  "card_details": {
    "bin": "345676",
    "last4": "9809"
  },
  "merchant_details": {
    "merchant_name": "ABC Stores",
    "merchant_location": "Lagos, Nigeria"
  },
  "customer_details": {
    "customer_name": "John Doe",
    "customer_email": "anita@gmail.com",
    "customer_phone": "+2347012345678",
    "bvn": "1234567890"
  },
  "additional_info": {
    "ip_address": "102.89.1.1",
    "country_code": "234",
    "location": "Lagos, Nigeria"
  }
}

201 Created Response

{
    "status": "Success",
    "data": {
      "fraud_percentage": 20.02,
      "transaction_status": "Clean"
    }
    "message": "Sucessfully processed card transaction"
}

​
Request Body

FieldDescriptionType
transaction_idThis is the unique identifier for the transactionString
amountThe total transaction amountFloat
currencyThis is currency code for the transaction (e.g., USD, NGN)String
transaction_typeType of the transaction (e.g., card)String
timestampISO 8601 date and time of the transaction.String
card_detailsDetails of the card being used for the transactionObject
- binFirst six digits of the card numberString
- last4Last four digits of the card numberString
merchant_detailsDetails of the merchantObject
- merchant_nameName of the merchantString
- merchant_locationLocation of the merchantString
customer_detailsInformation about the verified customer initiating the transaction.Object
- customer_nameCustomer’s full nameString
- customer_emailCustomer’s email addressString
- customer_phoneCustomer’s phone number with country codeString
- bvnCustomer’s Bank Verification Number (BVN)String
additional_infoAdditional details regarding the transactionObject
- ip_addressIP address of the customer during the transactionString
- country_codeCountry code associated with the transactionString
- locationCustomer’s location (can be formatted as “lat=-30.6556,lon=-65.7655”)String