SADAD MOI payment

SADAD MOI Payment API enables businesses to securely initiate payments for Ministry of Interior (MOI) services through the SADAD ecosystem using a single API integration.

This service allows organizations to automate government fee payments, streamline operational workflows, and provide seamless payment experiences for customers and business users.

The API supports various MOI payment services including residency services, visa fees, traffic violations, permits, and other government-related payments supported by the participating banks and the SADAD network.

workflows.

Important information

The user must provide the valid credentials in the header
Encrypted and valid Signature and an active Access Token
Request format as specified with all the mandatory details with appropriate request tags
Ensure that the SequenceNumber 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
sandboxapi.onesingleview.com
3 Calls per Minute
Production/LIVE
To be provided upon onboarding
Based on contract

Environment	Domain	Rate/Limit
Sandbox	sandboxapi.onesingleview.com	3 Calls per Minute
Production/LIVE	To be provided upon onboarding	Based on contract

Make SADAD MOI Payment

Endpoint details

Endpoint URL	Method	Authentication requirements
`/api/payment/sadad/moi`	POST	`CompanyId` `SVReferenceID` `DateTimeStamp` `Device` `Authorization: Bearer`

Sample request

Initiate MOI Payment Request

curl --location 'https://sandboxapi.onesingleview.com/api/payment/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": {  
  "OSVSadadMOIPaymentRequest": {  
    "TransactionType": "SADADMOI",  
    "OSVSadadMOIPayment": [  
      {  
        "BankCode": "Enter_Bank_Code",  
        "CompanyCode": "Enter_Company_Code",  
        "AccountNumber": "Enter_Account_Number",  
        "TransactionReferenceNumber": "Enter_Transaction_Reference_Number",  
        "MessageDescription": "Enter_Message_Description",  
        "TransactionData": [  
          {  
            "ID": "Enter_ID",  
            "VisaCount": "Enter_Visa_Count",  
            "GroupPayId": "Enter_Group_Payment_ID",  
            "SequenceNumber": "Enter_Sequence_Number",  
            "ReferenceNumber": "Enter_Reference_Number",  
            "FeeReferenceId": "Enter_Fee_Reference_Id",  
            "SADADReferenceId": "Enter_SADAD_Reference_Id",  
            "DueAmount": "Enter_Due_Amount",  
            "PaymentType": "Enter_Payment_Type",  
            "BillerID": "Enter_Biller_ID",  
            "RequestType": "Enter_Request_type",  
            "NationalID": "Enter_National_ID",  
            "SponsorID": "Enter_Sponsor_ID",  
            "JobCategory": "Enter_Job_Category",  
            "Duration": "Enter_Duration"  
          }  
        ]  
      }  
    ]  
  }  
}'

Request parameters

JSON Tag	Requirement	Description	Data type
Message	Mandatory	Header information	Object
OSVSadadMOIPaymentRequest	Mandatory	Root node containing all the SADAD MOI payment information	Object
TransactionType	Mandatory	Type of transaction to be mentioned as `SADADMOI`	String
OSVSadadMOIPayment	Mandatory	Tag carrying information on the SADAD MOI payment requested	Object
BankCode	Mandatory	Unique bank identification code	String
CompanyCode	Mandatory	Unique company identification code	String
AccountNumber	Mandatory	Unique account identification number with SADAD MOI	String
TransactionReferenceNumber	Mandatory	Unique transaction reference number	String
MessageDescription	Mandatory	Details of the transaction	String
TransactionData	Mandatory	Tag carrying information on the requested SADAD MOI payment	Object
ID	Mandatory	Unique identification details	String
VisaCount	Mandatory	Number indicating the count of the Visa	Numerical
GroupPayId	Mandatory	Unique group payment identification	String
SequenceNumber	Mandatory	Unique sequence number of the payment generated by the client	String
ReferenceNumber	Mandatory	Unique payment reference number	String
FeeReferenceId	Mandatory	Unique fee reference identification details	String
SADADReferenceId	Mandatory	Unique SADAD reference number of the payment	String
DueAmount	Mandatory	Amount denoting the total due	Numerical
PaymentType	Mandatory	Details on the type of payment	Strong
BillerID	Mandatory	Unique biller identification details	String
RequestType	Mandatory	Type of the request	String
NationalID	Mandatory	Unique national identification details of the customer	String
SponsorID	Mandatory	Unique sponsor identification details for the visa	String
JobCategory	Mandatory	Details of the job category	String
Duration	Mandatory	Duration of the visa	String

Sample response

Initate MOI Payment Response

{  
  "OSVSadadMOIPaymentResponse": {  
    "MessageType": "SADADMOI",  
    "TimeStamp": "YYYY-MM-DDTHH:MM:SS",  
    "OSVSadadMOIPayment": [  
      {  
        "BankCode": "Bank_Code",  
        "TransactionReferenceNumber": "Transaction_Reference_Number",  
        "MessageDescription": "Message_Description",  
        "CompanyCode": "Company_Code",  
        "AccountNumber": "Account_Number",  
        "BankReferenceNumber": "Bank_Reference_Number",  
        "TransactionData": [  
          {  
            "PaymentRefNumber": "Payment_Ref_Number",  
            "SADADRqUID": "SADAD_Rq_UID",  
            "SequenceNum": "Sequence_Num",  
            "BankReference": "Bank_Reference",  
            "SadadReference": "Sadad_Reference",  
            "BillerID": "Biller_ID",  
            "SubscriberNumber": "Subscriber_Number",  
            "ServiceType": "Service_Type",  
            "PaidAmount": "Paid_Amount",  
            "StatusCode": "OK",  
            "FeeReferenceId": "Fee_Reference_Id",  
            "StatusDetail": "OK",  
            "CurrentAmount": "Current_Amount",  
            "PreviousAmount": "Previous_Amount",  
            "ID": "ID",  
            "VIsaNumber": "Visa_Number",  
            "BeneficiaryName": "Beneficiary_Name",  
            "Fees": [  
              {  
                "FeeAmount": "Fee_Amount",  
                "FeeType": "Fee_Type"  
              }  
            ]  
          }  
        ]  
      }  
    ]  
  }  
}

Response parameters

Meta Tag	Description	Data type
OSVSadadMOIPaymentResponse	Root tag carrying SADAD MOI payment response	Object
MessageType	Type of response message represented as `SADADMOI`	String
TimeStamp	Date and time of the response	String
OSVSadadMOIPayment	Tag carrying information on SADAD MOI payment	Object
BankCode	Unique bank identification code	String
TransactionReferenceNumber	Unique transaction reference details	Stering
MessageDescription	Details about the SADAD MOI payment	String
CompanyCode	Unique company identification details	String
AccountNumber	Unique account identification details for the SADAD MOI	String
BankReferenceNumber	Unique bank reference identification details	String
TransactionData	Tag carrying information on SADAD MOI payment transaction	Object
PaymentRefNumber	Unique payment reference details	String
SADADRqUID	SADAD request unique identification details	String
SequenceNum	Unqiue sequence number of the SADAD MOI payment generated by the client	String
BankReference	Unique bank reference details	String
SadadReference	Unique SADAD reference details	String
BillerID	Unique biller identification details	String
SubscriberNumber	Unique SADAD MOI subscriber identification details	String
ServiceType	Type of the SADAD MOI service	String
PaidAmount	Total paid amount for the MOI	Numerical
StatusCode	Status code of the MOI payment transaction	Boolean
FeeReferenceId	Unique fee reference identification	String
StatusDetail	Status details of the SADAD MOI payment transaction	String
CurrentAmount	Current amount paid for the SADAD MOI	Numerical
PreviousAmount	Previous amount paid for the SADAD MOI	Numerical
ID	Unique customer identification details	String
VIsaNumber	Unique visa number of the customer	String
BeneficiaryName	Name of the beneficiary	String
Fees	Tag carrying information on SADAD MOI fee details	Object
FeeAmount	Amount denoting the fee	Numerical
FeeType	Details on fee type	String

GENERAL INFORMATION

Getting started

GETTING STARTED

Authentication

ERP API Services

CONSENT MANAGEMENT

AUTHENTICATION

Data APIs

Raw Data APIs

Payment APIs

DATA USE CASE APIS

SADAD

Plug-and-Play Integrations

RESOURCES

API Archives

Domain details

Make SADAD MOI Payment

Endpoint details

Sample request

Sample response