Order Created

Description

This event is triggered when a new order is created.

Triggers

Order created

Webhook URL


https://example.com/api/webhooks/order-created

Method

POST

Request


{
  "id":"434-4324-4324-4ffas",
  "status":"PRE-APPROVED",
  "customer": {
    "salary": 25000,
    "id": 1005530090,
    "id_version": 1,
    "first_name_ar": "محمد",
    "father_name_ar": "احمد",
    "grand_name_ar": "محمد",
    "family_name_ar": "ابراهيم",
    "first_name_en": "MOHAMED",
    "father_name_en": "AHMED",
    "grand_name_en": "MOHAMED",
    "family_name_en": "IBRAHIM",
    "two_names_ar": "محمد احمد",
    "two_names_en": "MOHAMED AHMED",
    "full_name_ar": "محمد احمد ابراهيم",
    "full_name_en": "MOHAMED AHMED IBRAHIM",
    "gender": "M",
    "id_issue_date_g": "2017-08-20",
    "id_issue_date_h": 14381128,
    "id_expiry_date_g": "2040-03-24",
    "id_expiry_date_h": 14620311,
    "language": "A",
    "nationality": 113,
    "nationality_ar": "العربية السعودية",
    "nationality_en": "Saudi Arabia",
    "dob_g": "1975-03-24",
    "dob_h": 12940312,
    "card_issue_place_ar": "الرياض  1",
    "card_issue_place_en": "Riyadh 1",
 
  },
  "masdr": {
    "basicWage": 530,
    "housingAllowance": 0,
    "otherAllowance": 1267,
    "fullWage": 1797,
    "employerName": "الخدمات البحري العامليه",
    "dateOfJoining": "01/04/2005",
    "workingMonths": "7",
 
    "gosinumber": "1234567890",
    "legalEntity": "منشأة محدودة",
    "occupation": {
      "arabic": "أمين مخزن",
      "english": "Storekeeper"
    },
    "occupationCode": 432101
  },
  "product": {
    "category": 12,
    "id": 3,
    "name": "Personal Finance",
    "managementFeesPercentage": 1,
    "managementFeesMaxAmount": 30000,
    "brokerageFeesPercentage": 1,
    "brokerageFeesMaxAmount": 25000,
    "advancePayment": 50000,
    "interestRateMin": 1,
    "debtBurdenRatio": 33,
    "interestRateMax": 3,
    "financeAmountMin": 10000,
    "financeAmountMax": 1000000
  },
  "loan": {
    "preferredAmount": 376153,
    "period": 48,
    "MaxRepaymentPeriod": 1,
    "SalaryBank": {
      "id": 1,
      "name": "Riyadh Bank"
    }
  },
  "engine": {
    "totalAmountPaid": 324324,
    "brokerageFees": 323,
    "totalAmountRecieved": 322324,
    "managementFees": 123,
    "apr": 6,
    "monthlyInstallment": 500,
    "eligibility": true,
    "rules": {
      "WATCH_LIST_CHECK": true,
      "CREDIT_SCORE_CHECK": true,
      "FRAUD_CHECK": true,
      "CUSTOMER_DUE_DILIGENCE": true,
      "CUSTOMER_AGE_CHECK": true,
      "CUSTOMER_SALARY_CHECK": true,
      "SIMAH_JUDGEMENTS_CHECK": true,
      "SIMAH_CHEQUE_BOUNCE_CHECK": true,
      "SIMAH_CREDIT_SCORE_CHECK": true
    }
  }
}

Request

{...

Request Parameters

Parameter	Type	Description
customer	Object	Customer information
product	Object	Product information
loan	Object	Loan information
engine	Object	Tamawal Decision Engine information

Request Description

Customer Parameters

Parameter	Type	Description
salary	Number	Salary
id	Number	ID
id_version	Number	ID version
first_name_ar	String	First name in Arabic
father_name_ar	String	Father name in Arabic
grand_name_ar	String	Grand name in Arabic
family_name_ar	String	Family name in Arabic
first_name_en	String	First name in English
father_name_en	String	Father name in English
grand_name_en	String	Grand name in English
family_name_en	String	Family name in English
two_names_ar	String	Two names in Arabic
two_names_en	String	Two names in English
full_name_ar	String	Full name in Arabic
full_name_en	String	Full name in English

Masdr Parameters

Parameter	Type	Description
basicWage	Number	Basic wage
housingAllowance	Number	Housing allowance
otherAllowance	Number	Other allowance
fullWage	Number	Full wage
employerName	String	Employer name
dateOfJoining	String	Date of joining
workingMonths	String	Working months
gosinumber	String	Gosinumber
legalEntity	String	Legal entity
occupation	Object	Occupation information
occupationCode	Number	Occupation code

Product Parameters

Parameter	Type	Description
category	Number	Category
id	Number	ID
name	String	Name
managementFeesPercentage	Number	Management fees percentage
managementFeesMaxAmount	Number	Management fees max amount
brokerageFeesPercentage	Number	Brokerage fees percentage
brokerageFeesMaxAmount	Number	Brokerage fees max amount
advancePayment	Number	Advance payment
interestRateMin	Number	Interest rate min
debtBurdenRatio	Number	Debt burden ratio
interestRateMax	Number	Interest rate max
financeAmountMin	Number	Finance amount min
financeAmountMax	Number	Finance amount max

Loan Parameters

Parameter	Type	Description
preferredAmount	Number	Preferred amount
period	Number	Period
MaxRepaymentPeriod	Number	Max repayment period
SalaryBank	Object	Salary bank information

Engine Parameters

Parameter	Type	Description
totalAmountPaid	Number	Total amount paid
brokerageFees	Number	Brokerage fees
totalAmountRecieved	Number	Total amount received
managementFees	Number	Management fees
apr	Number	Annual percentage rate
monthlyInstallment	Number	Monthly installment
eligibility	Boolean	Eligibility status
rules	Object	Rules information

Rules Parameters

Parameter	Type	Description
WATCH_LIST_CHECK	Boolean	Watch list check
CREDIT_SCORE_CHECK	Boolean	Credit score check
FRAUD_CHECK	Boolean	Fraud check
CUSTOMER_DUE_DILIGENCE	Boolean	Customer due diligence
CUSTOMER_AGE_CHECK	Boolean	Customer age check
CUSTOMER_SALARY_CHECK	Boolean	Customer salary check

Response

ℹ️

Please Notice The webhook response must be in the following format.


{
    "totalAmountPaid":324324,
    "brokerageFees":323,
    "totalAmountRecieved":322324,
    "managementFees":123,
    "apr":6,
    "monthlyInstallment":500,
    "eligibility": true
}

Response Parameters

Parameter	Type	Description
totalAmountPaid	Number	Total amount paid
brokerageFees	Number	Brokerage fees
totalAmountRecieved	Number	Total amount received
managementFees	Number	Management fees
apr	Number	Annual percentage rate
monthlyInstallment	Number	Monthly installment
eligibility	Boolean	Eligibility status