1. Customer management
API to fetch customer details by ID details or MSISDN. Allows also to verify Mobily employees and perform service base, service eligibility checks.
API details:
API URL:
/installedbase/getCustomerProductDetails
Swagger Link:
<<Customer Related Account Inquiry >>
API URL:
/customer
Swagger Link:
API URL:
/employee
Swagger Link:
API URL:
/installedbase/familyPlan
Swagger Link:
2. SIM management
APIs for reserve and validate SIM cards and for eSim activation
API details:
API URL:
/sim/get
Swagger Link:
API URL:
/mobily/simvalidationandorc
Swagger Link:
API URL:
/esim/v1/validation
Swagger Link:
3. Checkout
Checkout API is used to capture the data that is needed to successfully handle the commercial order.
API details:
API URL:
/checkout-api/v3/checkout/captureData
Swagger Link:
API URL:
/checkout-api/v3/checkout/structure
Swagger Link:
4. Package Eligibility
Service to validate whether customer is eligible to activate the requested package or not.
API details:
API URL:
/package-eligibilty-check
Swagger Link:
5. OTP Services
API responsible for OTP flows - from generating to validating the one time passwords for customers.
API details:
API URL:
/mobily-otp-services/services/otp-rayah/initiate
Swagger Link:
<<Rayah OTP Inquiry request >>
API URL:
/mobily-otp-services/otp-rayah/validate
Swagger Link:
<<Rayah OTP Validate request >>
API URL:
/mobily-otp-services/services/otp/inquiry
Swagger Link:
<<EAI OTP Framework Inquiry >>
API URL:
/mobily-otp-services/services/otp/generation
Swagger Link:
<<EAI OTP Framework Generate >>
API URL:
/mobily-otp-services/services/otp/regeneration
Swagger Link:
API URL:
/mobily-otp-services/services/otp/validation
Swagger Link:
<<EAI OTP Framework Validate >>
API URL:
/mobily-sms-service/services/sms-verify
Swagger Link:
API URL:
/mobily-sms-service/sms-otp/validate
Swagger Link:
API URL:
/mobily-sms-service/auth-initiation/initiate
Swagger Link:
API URL:
/mobily-sms-service/auth-validation/validate
Swagger Link:
6. Prepaid Recharge
This Document contains EVD REST APIs used by applications to implement EVD Integration, like login, reservation, confirm, receive confirm etc.
API details:
API URL:
/ecrLogin
Swagger Link:
<<ECR Login, ECR: Electronic Cash Register , this is for ECR or non-andorid Terminal Integration. >>
API URL:
/report/transactions
Swagger Link:
API URL:
/report/transactionsByRefnoList
Swagger Link:
<<Get Transactions By Reference List >>
API URL:
/merchant
Swagger Link:
API URL:
/merchant
Swagger Link:
API URL:
/topup/reconciliation
Swagger Link:
API URL:
/topup/reconciliation
Swagger Link:
API URL:
/topup/reservations
Swagger Link:
API URL:
/topup/reservations/{referenceNumber}/cancellations
Swagger Link:
<<Cancel Pin Code Reservation >>
API URL:
/topup/reservations/{referenceNumber}/confirmations
Swagger Link:
<<Confirm Pin Code Reservation >>
7. Self Service Management
This document contains all the apis related to self service management services.
API details:
API URL:
/api/service/rbt/v1/control/categories
Swagger Link:
API URL:
/api/service/rbt/v1/control/categories/{categoryId}
Swagger Link:
API URL:
/api/service/rbt/v1/control/albums
Swagger Link:
<<Returns the Album matching to the key param >>
API URL:
/api/service/rbt/v1/control/artists
Swagger Link:
<<Returns the artists matching to the key param >>
API URL:
/api/service/rbt/v1/control/subscriptiontones/{subscriptionId}
Swagger Link:
<<Queries a tone by subscriptionCode >>
API URL:
/api/service/rbt/v1/control/trending/tones
Swagger Link:
<<Returns the trending tones >>
API URL:
/api/service/rbt/v1/control/services
Swagger Link:
API URL:
/api/service/rbt/v1/control/services/{offerId}
Swagger Link:
API URL:
/api/service/rbt/v1/customer/recommendation/tones
Swagger Link:
<<Returns recommended Tones >>
API URL:
/api/service/rbt/v1/customer/subscription-list-info
Swagger Link:
<<Returns user Subscription List Info. >>
API URL:
/api/service/rbt/v1/manage/service/subscribe
Swagger Link:
<<Initiates a new service offer subscription >>
API URL:
/api/service/rbt/v1/manage/service/subscribe/{subscriptionId}
Swagger Link:
<<Updates a service offer subscription >>
API URL:
/api/service/rbt/v1/manage/content/subscribe
Swagger Link:
<<Initiates a new content subscription >>
API URL:
/api/service/rbt/v1/manage/content/subscribe/{subscriptionId}
Swagger Link:
<<Updates a content offer subscription >>
API URL:
/api/service/rbt/v1/manage/subscribers/defaulttone
Swagger Link:
API URL:
/api/service/rbt/v1/manage/subscribers/language
Swagger Link:
API URL:
/api/service/rbt/v1/manage/special-condition-assignment
Swagger Link:
<<Assign a special condition to subscriber profile >>
API URL:
/api/service/rbt/v1/manage/subscribers/firstlogin
Swagger Link:
API URL:
/mobilybe/rest/activesubs/service/list
Swagger Link:
<<Method used to retrieve active subscription service list. >>
API URL:
/mobilybe/rest/activesubs/content/list
Swagger Link:
<<Method used to retrieve active subscription content list. >>
API URL:
/mobilybe/rest/activesubs/subman/list
Swagger Link:
<<Method used to return all the Add-ons found on Sub-man and mobile app. >>
API URL:
/mobilybe/rest/activesubs/service/unsubscribe
Swagger Link:
<<Method used to retrieve active subscription content list. >>
API URL:
/mobilybe/rest/pands/subscriptionServices
Swagger Link:
<< Subscription Services Request >>
API URL:
/mobilybe/rest/pands/unsubscriptionServices
Swagger Link:
<< Unsubscription Services Request >>
API URL:
/mobilybe/rest/pands/unsubscriptionServicesWithParams
Swagger Link:
<< Unsubscription Services With Param Request >>
API URL:
/mobilybe/rest/pands/swapServicesWithParams
Swagger Link:
<< Swap Services With Param Request >>
API URL:
/api/services/pands/v1/bundle/country
Swagger Link:
<< Returns a list of bundle countries >>
API URL:
/api/services/pands/v1/bundles
Swagger Link:
<< Returns a list of bundle details >>
API URL:
/mobilybe/rest/corporate/serviceMgmt/listOfLines
Swagger Link:
8. Bill and Payment Management
This document contains all the apis related to bill and payment services (Consumer and Corporate)
API details:
API URL:
/cem/dpc/core/v1/audit
Swagger Link:
<<Audit payment transactions >>
API URL:
/cem/dpc/core/v1/processRequest
Swagger Link:
API URL:
/cem/dpc/mpgs/v1/process
Swagger Link:
API URL:
/cem/dpc/inquiry/v1/saved-card
Swagger Link:
API URL:
/cem/dpc/mpgs/v1/batch-status/{batchName}
Swagger Link:
API URL:
/cem/dpc/mpgs/v1/batch-response/{batchName}
Swagger Link:
API URL:
/cem/dpc/inquiry/v1/request/{refId}
Swagger Link:
<<Retrieve payment request details >>
API URL:
/api/payment/v1/bill/dues-penalty
Swagger Link:
API URL:
/api/payment/v4/overdue
Swagger Link:
API URL:
/api/payment/v2/saved-cards
Swagger Link:
<<Get list of payment tokens (Saved cards) >>
API URL:
/mobilybe/rest/ftth/balanceOrOutstanding
Swagger Link:
<<Balance or Outstanding Amount >>
API URL:
/api/payment/v2/overdue
Swagger Link:
<<Retrieve the Over Due amounts of all the related lines.>>
API URL:
/api/payment/v1/vat
Swagger Link:
<<Get the calculated total amount including VAT for the given amount.>>
API URL:
/cem/bff/dpc/v1/initiatePayment
Swagger Link:
<<InitiatePayment by Channels for various Authorize, Capture and Void operations >>
API URL:
/cem/bff/ecom/v1/initiatePayment
Swagger Link:
API URL:
/cem/bff/dpc/v1/process
Swagger Link:
<<Process request by Channels for various DPC's MPGS process operations. >>
API URL:
/mobilybe/rest/payment/balance/info
Swagger Link:
<<Retrieve Customer Balance Info >>
API URL:
/mobilybe/rest/payment/audit
Swagger Link:
API URL:
/mobilybe/rest/payment/deleteCard
Swagger Link:
API URL:
/mobilybe/rest/payment/updateDefaultCard
Swagger Link:
API URL:
/mobilybe/rest/payment/recharge/dataVoucher
Swagger Link:
API URL:
/mobilybe/rest/oth/credit/transfer
Swagger Link:
API URL:
/mobilybe/rest/oth/credit/transfer/confirm
Swagger Link:
API URL:
/api/bill/v1/pdf/latest
Swagger Link:
<<Returns the latest bill pdf information in the form of Base64 format. >>
API URL:
/api/my-balance/v1/prepaid-line-status
Swagger Link:
<<Inquiry Customer Balance to know the prepaid line status (Active or Inactive) >>
API URL:
/api/services/clg/v1/graceeligiblelines
Swagger Link:
API URL:
/api/services/clg/v1/graceperiod
Swagger Link:
API URL:
/mobilybe/rest/clg/creditlimit/inquiry
Swagger Link:
API URL:
/mobilybe/rest/clg/creditlimit/update
Swagger Link:
API URL:
/mobilybe/rest/clg/gracePeriod/update
Swagger Link:
<<Grace Period Updation (MSISDN) or 4.1.16.4 Grace Period Updation (Account Number) >>
API URL:
/mobilybe/rest/myprofile/bill/altcontact/update
Swagger Link:
<<Method used to update bill's alternative contact. >>
API URL:
/mobilybe/rest/myprofile/bill/email/update
Swagger Link:
<<Method used to update billing email. >>
API URL:
/mobilybe/rest/myprofile/bill/unbilled/details
Swagger Link:
API URL:
/mobilybe/rest/payment/prepaid/renewalsInquiry
Swagger Link:
<< Prepaid Renewals Inquiry >>
API URL:
/mobilybe/rest/payment/recharge/byvoucher
Swagger Link:
API URL:
/mobilybe/rest/usage/balance/credit
Swagger Link:
API URL:
/mobilybe/rest/usage/balance/outstanding
Swagger Link:
<< Retrieve Outstanding Balance >>
API URL:
/mobilybe/rest/usage/analytics
Swagger Link:
API URL:
/mobilybe/rest/usage/hotstatement
Swagger Link:
API URL:
/mobilybe/rest/vad/overDraft
Swagger Link:
<< Emergency Credit (VAD Overdraft) >>
API URL:
/api/bill/v1/list
Swagger Link:
API URL:
/api/bill/v1/pdf
Swagger Link:
<< Fetch bill pdf information >>
API URL:
/api/corpbilling/bills/v1/lastbills
Swagger Link:
<< Individual Lines Last bills >>
API URL:
/api/corpbilling/bills/v1/usage
Swagger Link:
<< Individual Line Usage details >>
API URL:
/mobilybe/rest/corporate/billing/downloadBill
Swagger Link:
API URL:
/mobilybe/rest/corporate/billing/freeResourceBalance
Swagger Link:
<< Get free resource balance details >>
API URL:
/mobilybe/rest/corporate/billing/getLastBillAndMonths
Swagger Link:
<< Get Last Bill And Months >>
API URL:
/mobilybe/rest/corporate/billing/lineBalance
Swagger Link:
API URL:
/mobilybe/rest/corporate/billing/list/lob
Swagger Link:
<< Get Corporate Services Lookup >>
API URL:
/mobilybe/rest/corporate/billing/list/prepaid
Swagger Link:
API URL:
/mobilybe/rest/corporate/billing/list/postpaid
Swagger Link:
API URL:
/mobilybe/rest/corporate/billing/resendBill
Swagger Link:
API URL:
/mobilybe/rest/corporate/payment/balance
Swagger Link:
<< Method used to inquire about corporate balance. >>
API URL:
/mobilybe/rest/corporate/paymenthistory/accountLevelhistory
Swagger Link:
API URL:
/mobilybe/rest/corporate/paymenthistory/download
Swagger Link:
API URL:
/mobilybe/rest/corporate/paymenthistory/servicelevelDetails
Swagger Link:
9. Authentication And Authorization
This document contains the authentication and authorization APIs used to generate Mobily Auth tokens. These auth tokens are required to access Mobily resources.
API details:
API URL:
/auth/realms/mobily/protocol/openid-connect/token
Swagger Link:
<<KeyCloak Token Generation >>
API URL:
/api/oauth-server/logout
Swagger Link:
API URL:
/api/oauth-server/logout/other
Swagger Link:
<<DAPI API for Logging Out Other Devices >>
API URL:
/api/oauth-server/logout/other/confirm
Swagger Link:
<<DAPI API for Confirming Logging Out Other Devices. >>
API URL:
/api/oauth-server/hand-over-code
Swagger Link:
API URL:
/api/oauth-server/oauth/token
Swagger Link:
<<DAPI Access Token Generation >>
API URL:
/auth/realms/mobily/protocol/openid-connect/logout
Swagger Link:
API URL:
/auth/realms/mobily/protocol/openid-connect/token/introspect
Swagger Link:
API URL:
/api/internal-oauth-server/logout
Swagger Link:
API URL:
/api/internal-oauth-server/oauth/token
Swagger Link:
<<DAPI Internal Access Token Generation >>
API URL:
/apis/apigee-oauth/access-token
Swagger Link:
<<Apigee Client Access Token Generation >>
API URL:
/api/oauth-server/resend-otp
Swagger Link:
API URL:
/api/login/account
Swagger Link:
<<API used for account login with mobily credentials >>
API URL:
/api/login/otp
Swagger Link:
<<API used to generate an OTP token. >>
API URL:
/api/login/validateotp
Swagger Link:
<<API used to validate pin code for the OTP token. >>
API URL:
/cem/bff/line/v1/authorize
Swagger Link:
<<Validate the account number against the user name attached to the access token >>
API URL:
/cem/bff/login/v1/alien
Swagger Link:
<<Check whether network location and line location is inside KSA or abroad. >>
API URL:
/cem/nafath/auth/v1/initiate
Swagger Link:
API URL:
/cem/nafath/auth/v1/tokenInfo
Swagger Link:
10. OTP Services
API responsible for OTP flows - from generating to validating the one time passwords for customers.
API details:
API URL:
/mobily-otp-services/services/otp-rayah/initiate
Swagger Link:
<<Rayah OTP Inquiry request >>
API URL:
/mobily-otp-services/otp-rayah/validate
Swagger Link:
<<Rayah OTP Validate request >>
API URL:
/mobily-otp-services/services/otp/inquiry
Swagger Link:
<<EAI OTP Framework Inquiry >>
API URL:
/mobily-otp-services/services/otp/generation
Swagger Link:
<<EAI OTP Framework Generate >>
API URL:
/mobily-otp-services/services/otp/regeneration
Swagger Link:
API URL:
/mobily-otp-services/services/otp/validation
Swagger Link:
<<EAI OTP Framework Validate >>
API URL:
/mobily-sms-service/services/sms-verify
Swagger Link:
API URL:
/mobily-sms-service/sms-otp/validate
Swagger Link:
API URL:
/mobily-sms-service/auth-initiation/initiate
Swagger Link:
API URL:
/mobily-sms-service/auth-validation/validate
Swagger Link:
11. Email Service
API for sending Email Messages to customers.
API details:
API URL:
/email/create
Swagger Link:
12. Order Generator
Order Generator is used to convert Bluemarble Commerce data into Product Order. The Order Generator service is implemented with the objective to create the order request and send orders to Mobily Order Management service.
API details:
API URL:
/OrderGenerator/cancelMNPOrder
Swagger Link:
<<Cancel MNP order by order id >>
API URL:
/OrderGenerator/fetchByOrderId/{orderId}
Swagger Link:
<<Fetch the Order by OrderId >>
API URL:
/OrderGenerator/generateOrderId
Swagger Link:
API URL:
/OrderGenerator/postProductOrder
Swagger Link:
<<Post Product Order from Shopping Cart >>
API URL:
/OrderGenerator/retryProductOrder
Swagger Link:
<<Retry Product Order from Shopping Cart >>
API URL:
/OrderGenerator/updateOrderStatus/{orderId}
Swagger Link:
<<Update the Order Status by External Order Id >>
API URL:
/OrderGenerator/orderTracking/orderInquiry
Swagger Link:
<<Track the order using order Number / Mobile Number >>
API URL:
/OrderGenerator/orderTracking/deliveryAddressChange
Swagger Link:
<<Update the delivery address for New Physical SIM >>
13. QR Code Service
API providing a QR Code generation service along with a functionality to fetch the QR Code and/or send it to a specified email address.
API details:
API URL:
/qr/get
Swagger Link:
API URL:
/qr/send
Swagger Link:
14. Security Deposit
API responsible for verifying the requirement for customer to make a deposit while buying a service or product from Mobily.
API details:
API URL:
/deposit/get
Swagger Link:
15. Resource Pool Management
API providing fetch and reserve functionality for customer phone numbers (MSISDNs).
API details:
API URL:
/resourcePoolManagement/AvailabilityCheck
Swagger Link:
API URL:
/resourcePoolManagement/Reservation
Swagger Link:
16. Unpaid Bills
API responsible for verifying if customer has any outstanding, unpaid bills.
API details:
API URL:
/customer/dues
Swagger Link:
17. TCC Eligibility Service
API offering functionality to perform TCC Eligibility check or Registration process.
API details:
API URL:
/tcc/register
Swagger Link:
API URL:
/tcc/eligibilityCheck
Swagger Link:
18. Product Offering Qualification
Product Offering Qualification Management REST APIs
API details:
API URL:
/api/product-offering-qualification-management/v3/getEligibleCategories
Swagger Link:
API URL:
/api/product-offering-qualification-management/v3/qualifyProducts
Swagger Link:
19. Shopping Cart Projection
Retrieve Shopping Cart by shopping cart Id
API details:
API URL:
/shopping-cart-projection/v3/shoppingCart/{shoppingCartId}
Swagger Link:
<<Query shopping cart by Id >>
20. Shopping Cart
Shopping Cart REST APIs for Create Patch and Validate Shopping Cart
API details:
API URL:
/api/shopping-cart/v3/shoppingCart
Swagger Link:
API URL:
/api/shopping-cart/v3/shoppingCart/{shoppingCartId}
Swagger Link:
API URL:
/api/shopping-cart/v3/shoppingCart/{shoppingCartId}/validate
Swagger Link:
API URL:
/mobily-shopping-cart-management/api/update-and-validate
Swagger Link: