Retrieve Ministry of Interior (MOI) fee and payment information through the SADAD network
SADAD MOI Enquiry API enables businesses to retrieve outstanding fee information and payment details for services provided by the Ministry of Interior (MOI) through the SADAD ecosystem.
This service allows organizations to validate payment obligations before initiating payment transactions, helping reduce payment failures and improve reconciliation accuracy.
Typical use cases include visa services, residency services, traffic violations, government fees, and other MOI-related payment scenarios supported by SADAD.
Access TokenSequenceNumber is unique for each transaction. Payments with same sequence number appear as duplicate transactions and affects their processing and enquiry operations.Domain details
Environment
Domain
Rate/Limit
Sandbox
3 Calls per Minute
Production/LIVE
To be provided upon onboarding
Based on contract
Endpoint URL | Method | Authentication requirements |
|---|---|---|
| POST |
|
curl --location 'https://sandboxapi.onesingleview.com/api/enquiry/sadad/moi'
--header 'CompanyId: MYCOMPANY'
--header 'SVReferenceID: SV150619940615'
--header 'DateTimeStamp :2025-01-02T10:20:39'
--header 'Device: Web'
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjoiTDNyMmpxV29JS2I4MTNodDBNMlZ4WGpFZmR6WFNWaTFad3B5QnlkOVpHelZXR2ZwUmFQNUV1TXl6S1Aybi94Y0lwR2V5STNNMkdPL1pqakd4ZG0yclJKUkdhRXlaWGNpWnZnOHArMWIyOGtOQTVkZ0VKajVVSEdiTmtNPSIsImlhdCI6MTczNTgwMTQ3NywiZXhwIjoxNzM1ODA1MDc3fQ.Bh7LFkvxNFrLe9dmH5rURWjGpES-u4z2EGeyrNM7z6E'
--header 'Content-Type: application/json'
--data '{
"Message": {
"OSVSadadMOIEnquiryRequest": {
"TransactionType": "SADADMOI",
"OSVSadadMOIEnquiry": [
{
"BankCode": "Enter_Bank_Code",
"CompanyCode": "Enter_Company_Code",
"TransactionReferenceNumber": "Enter_Transaction_Reference_Number",
"MessageDescription": "Enter_Message_Description",
"TransactionData": [
{
"SequenceNumber": "Enter_Sequence_Number",
"POINum": "0000000000",
"POIType": "Enter_POI_Type",
"AccountNumber": "Enter_Account_Number",
"BillerID": "000",
"BillCategory": "00",
"ServiceCode": "000",
"BranchCode": "00000",
"RequestType": "000",
"ID": "0000000000",
"Duration": "00"
}
]
}
]
}
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
Message | Mandatory | Header information (client credentials) | Object |
OSVSadadMOIEnquiryRequest | Mandatory | Root node containing all the SADAD MOI information | Object |
TransactionType | Mandatory | Type of transaction to be mentioned as | String |
OSVSadadMOIEnquiry | Mandatory | Tag carrying information on the SADAD MOI requested | Object |
BankCode | Mandatory | Unique bank identification code | String |
CompanyCode | Mandatory | Unique company identification code | String |
TransactionReferenceNumber | Mandatory | Unique transaction reference number | String |
MessageDescription | Mandatory | Details about the transaction | String |
TransactionData | Mandatory | Tag carrying information on the requested SADAD MOI | Object |
SequenceNumber | Mandatory | Unique sequence number of the SADAD MOI generated by the client | String |
POINum | Mandatory | Unique customer identification details | String |
POIType | Mandatory | Type of customer identification | String |
AccountNumber | Mandatory | Unique account number details of the SADAD MOI | String |
BillerId | Mandatory | Unique biller identification details | String |
BillCategory | Mandatory | Unique bill category of the SADAD MOI | String |
ServiceCode | Mandatory | Unique service identification details | String |
BranchCode | Mandatory | Unique branch identification details for the respective SADAD MOI | String |
RequestType | Mandatory | Type of request | String |
ID | Mandatory | Unique identification details | String |
Duration | Mandatory | Duration of the request | Numerical |
{
"OSVSadadMOIEnquiryResponse": {
"MessageType": "SADADMOI",
"TimeStamp": "YYYY-MM-DDTHH:MM:SS",
"OSVSadadMOIEnquiry": [
{
"BankCode": "Bank_Code",
"CompanyCode": "Company_Code",
"TransactionReferenceNumber": "Transaction_Reference_Number",
"MessageDescription": "Message_Description",
"Status": "SUCCESS",
"TransactionData": [
{
"ID": "ID",
"BillerID": "Biller_Id",
"GroupPayId": 00000000,
"FeeReferenceId": "Fee_Reference_Id",
"SadadReferenceId": 0000000000,
"BeneficiaryName": "Beneficiary_Name",
"DueAmount": 0000,
"PreviousAmount": "0000",
"PmtIdType": "Payment_Id_Type",
"StatusDetail": "Success",
"StatusCode": "OK",
"FeeDetails": [
{
"Fees": {
"FeeType": "Fee_Type",
"FeeAmount": 0000
}
}
]
}
]
}
]
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
OSVSadadMOIEnquiryResponse | Root tag carrying MOI enquiry response | Object |
MessageType | Message type mentioned as | String |
TimeStamp | Stamp denoting date and time of the response | String |
OSVSadadMOIEnquiry | Tag carrying information on SADAD MOI | Object |
BankCode | Unique bank identification details | String |
CompanyCode | Unique company identification details | String |
TransactionReferenceNumber | Unique transaction reference details | String |
MessageDescription | Details about the response | String |
Status | Status of the response for MOI enquiry | Boolean |
TransactionData | Tag carrying transaction information for MOI enquiry | Object |
ID | Unique customer identification details | String |
BillerID | Unique biller identification details | String |
GroupPayId | Unique group payment identification details | String |
FeeReferenceId | Unique fee reference identification details | String |
SadadReferenceId | Unique SADAD reference identification details | String |
BeneficiaryName | Beneficiary name for the SADAD MOI | String |
DueAmount | Due amount for the SADAD MOI | Numerical |
PreviousAmount | Amount denoting any carried dues from previous month | Numerical |
PmtIdType | Unique payment identification type | String |
StatusDetail | Details about the status of the MOI | String |
StatusCode | Code representing the status of MOI enquiry | Boolean |
FeeDetails | Tag carrying information on MOI fee details | Object |
Fees | Tag carrying individual MOI fee details | Object |
FeeType | Details on MOI fee type | String |
FeeAmount | Amount denoting the MOI fee | Numerical |