Initiate and manage bill payments through the SADAD payment network
SADAD Bill Payment API enables businesses to securely initiate payments for bills registered within the SADAD ecosystem through a single API integration.
This service allows organizations to automate bill settlement processes, improve payment efficiency, and provide seamless bill payment experiences across digital channels.
The API supports payments for a wide range of SADAD billers and services, subject to the organization's subscription and bank configuration.
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/bill/payment'
--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": {
"OSVSadadBillPaymentRequest": {
"TransactionType": "SBP",
"CompanyCode": "OSV0001",
"BankCode": "NCB",
"AccountNumber": "SA6181234204608017172770",
"MessageDescription": "Electricity Bill Payment",
"TransactionData": {
"SequenceNumber": "12345678912",
"BillerId": "002",
"Amount": "168.25",
"SubscriberNumber": "123456781",
"BillCategory": "50",
"ServiceType": "ELCT",
"POINum": "",
"POIType": ""
}
}
},
"Signature": "nqusYO9e8l+WzuOSvKysOPaN5mQaH6EujqvhTqyTHApGh+zEZUjQG7jQP1cEC5opOqU1QZj4m1d0bHwTYGXYmHLypQb+d1IncMvKA+sLFVgu5wMi6PqnDg5+e6hktgwYRJAGdQs9Om8B8LUnCKYKgghKR2roFU0yhu0Qs4y8+NZPx1a1L7tzs01ZyxnNxPe5lCSgtJHsQX5Cqb/gEDb64uYpN/=="
}'Request parameters
JSON Tag | Requirement | Description | Data type |
|---|---|---|---|
Message | Mandatory | Tag carrying the request information | Object |
OSVSadadBillPaymentRequest | Mandatory | Root node containing all the SADAD bill payment information | Object |
TransactionType | Mandatory | Type of transaction to be mentioned as | String |
CompanyCode | Mandatory | Unique company identification code | String |
BankCode | Mandatory | Unique bank identification code | String |
AccountNumber | Mandatory | Valid SAR account number associated with the respective SADAD bill | String |
MessageDescription | Mandatory | Details of the SADAD bill payment transaction | String |
TransactionData | Mandatory | Tag carrying information on the payment details of requested SADAD bill | Object |
SequenceNumber | Mandatory | Unique number generated by the client representing the transaction | String |
BillerId | Mandatory | Unique biller identification details | String |
Amount | Mandatory | Details on bill amount to be paid as specified in the payment enquiry response | String |
SubscriberNumber | Mandatory | Unique subscriber identification details | String |
BillCategory | Conditional | Unique bill category of the SADAD bill to be mentioned as | String |
ServiceType | Conditional | Details on service type of the SADAD bill | String |
POINum | Conditional | Unique identifier for a bill-paying entity, including people and companies, provided by bank as Customer ID | String |
POIType | Conditional | Proof of identity type as provided by Customer ID Type by the bank. This field is mandatory for non-branch channel and optional for branch. Mapping with SADAD as follows:
| String |
{
"OSVSadadBillPaymentResponse": {
"TransactionType": "SBP",
"CompanyCode": "OSV0001",
"BankCode": "NCB",
"StatusCode": "Completed",
"StatusDetail": "Bill payment successful. Kindly check account statement for updated information.",
"TransactionData": {
"SequenceNumber": "12345678912",
"BillerID": "002",
"SubscriberNumber": "123456781"
}
}
}Response parameters
JSON Tag | Description | Data type |
|---|---|---|
OSVSadadBillPaymentResponse | Tag carrying information on bill payment response | Object |
TransactionType | Details on type of message to be displayed as | String |
CompanyCode | Unique company identification code | String |
BankCode | Unique bank identification code | String |
StatusCode | Status code of the bill payment response | String |
StatusDetail | Details on the status code displayed as | String |
TransactionData | Tag carrying information on the payment details of requested SADAD bill | Object |
SequenceNumber | Unique sequence number of the SADAD bill payment transaction generated by the client | String |
BillerId | Unique biller identification details | String |
SubscriberNumber | Unique subscriber identification details | String |
StatusCode | StatusDetail |
|---|---|
Completed | Bill payment successful. Kindly check account statement for updated information. |
Failed | Response as provided by the bank |
Response_Timeout | Timeout! Unable to get response from the bank. Please check account statement in few minutes or contact SingleView support. |