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/v2/sadad/moi/enquiry'
--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": "SME",
"MessageDescription": "Renew Iqama Payment",
"BankCode": "GIB",
"CompanyCode": "Singleview",
"AccountNumber": "20000005639",
"TransactionData": {
"SequenceNumber": "82170026",
"BillerId": "090",
"ServiceCode": "002",
"ID": "4035260050",
// Service-specific tags - insert here
}
}
},
"Signature": "GpSW4P5n6sI9ikr7yJaguCQT2NGziSn7M7gYNnWG+ETFLDbPd2GL1LM+V/vahHor5Kxc8vgtEq2vcyRdxCltFtl8eXz3so1HJ5/Vm7JtzcZbbmUoC6ybY3V9U0dAkPwt4jNZnllxDYnAFKS00jXTAw1NdgVtXCxjIkmxNOQmc6hUZuWr+C6F87NzvX0QNMBYDTQhmZrtsh/NU0TGkuf43HSkn/SugrgELH0zZttwVaNfbnQmnGPHUi22sGHeqOWUzpvtgmFG62Ag6/nOol29/FMMh1so/7wPkXfhN0VfZTaQdQqzcnf39NmcVo2uDnF27y2J8TeTpmg3ZQnzltnzDg=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
Message | Mandatory | Header information (client credentials) | Object |
OSVSadadMOIEnquiryRequest | Mandatory | Tag carrying information on the SADAD MOI requested | Object |
TransactionType | Mandatory | Type of transaction to be mentioned as | String |
MessageDescription | Mandatory | Description of the MOI transaction | String |
BankCode | Mandatory | Code identifying the bank through which the transaction is processed | String |
CompanyCode | Mandatory | Unique company identification code | String |
AccountNumber | Mandatory | Bank account number associated with the SADAD MOI enquiry transaction | String |
TransactionData | Mandatory | Tag carrying information on the requested SADAD MOI for enquiry | Object |
SequenceNumber | Mandatory | Sequence number generated by the client associated with the transaction | String |
BillerId | Mandatory | Unique SADAD biller identifier Refer SADAD MOI Info | String |
ServiceCode | Mandatory | Unique code identifying the MOI service Refer SADAD MOI Info | String |
ID | Mandatory | Customer identifier required for the service | String |
| Mandatory | Additional tags required for the selected MOI service Refer SADAD MOI Info | String |
{
"OSVSadadMOIEnquiryResponse": {
"TransactionType": "SME",
"CompanyCode": "Singleview",
"BankCode": "GIB",
"StatusCode": "Completed",
"StatusDetail": "MOI enquiry performed successfully.",
"TransactionData": {
"SequenceNumber": "82171029",
"BillerID": "090",
"ServiceCode": "002",
"ID": "4035260050",
"FeeAmount": "305.01",
"FeeReferenceId": "",
"SadadReferenceId": ""
}
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
OSVSadadMOIEnquiryResponse | Root tag carrying SADAD MOI enquiry response | Object |
TransactionType | Type of transaction to be mentioned as | String |
CompanyCode | Unique company code associated with the transaction | String |
BankCode | Code of the bank processing the transaction | String |
StatusCode | Code indicating the status of MOI enquiry | String |
StatusDetail | Provides additional information about the transaction status | String |
TransactionData | Tag carrying transaction information for SADAD MOI enquiry | Object |
SequenceNumber | Sequence number returned for the transaction | String |
BillerID | SADAD biller identifier | String |
ServiceCode | Code identifying the MOI service | String |
ID | Customer or transaction identifier | String |
FeeAmount | Fee amount associated with the transaction | String |
FeeReferenceId | Reference ID for the applicable fee Not provided for SAB, AlRajhi, and GIB | String |
SadadReferenceId | Unique SADAD reference identification details Not provided for SAB, AlRajhi, and GIB | String |
StatusCode | StatusDetail |
|---|---|
Completed | MOI enquiry performed successfully. |
Failed | Bank response description |
Response_Timeout | Timeout! Unable to get response from the bank. Please try again or contact SingleView support if issue persists. |