TM Forum Open API
Account Management API
Manage customer, billing and settlement accounts
The Account Management API manages party, billing, settlement and financial accounts in B2B and B2B2C settings. The main call, POST /partyAccount, creates an account and returns the PartyAccount object; matching GET, PATCH and DELETE calls find, update and remove accounts. It follows TM Forum TMF666 and is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.
- Billing accounts
- Partner settlement
- Account self-service
What you can do with this API
Read the full API overview
Overview of Account Management API
The Account Management API provides a standardized and structured approach for handling billing and settlement accounts, along with financial accounting processes such as accounts receivable. It supports operations for both B2B (Business-to-Business) and B2B2C (Business-to-Business-to-Consumer) relationships, ensuring flexibility in account management across diverse business models.
Key Capabilities
1. Account Creation & Management
- Enables businesses to create, update, and retrieve billing and financial accounts.
- Supports customer accounts, partner accounts, and settlement accounts.
2. Billing on Behalf of (B2B2C)
- Facilitates mass market customer billing through a structured “Billing on Behalf of” approach.
- Ensures service providers can handle invoicing for their end customers seamlessly.
3. Settlement & Financial Transactions (B2B)
- Supports the creation and management of billing/settlement accounts for partners and business customers.
- Helps enterprises track financial transactions, outstanding balances, and settlements.
4. Bill Item Creation & Query
- Allows businesses, partners, or customers to view and validate their invoices.
- Provides detailed breakdowns of billing items for better transparency.
5. Integration with Financial & CRM Systems
- Works seamlessly with ERP, accounting platforms, and CRM systems for streamlined account handling.
- Automates billing workflows, ensuring efficient payment tracking and reconciliation.
6. Compliance & Security
- Ensures data encryption and secure access controls to protect financial records.
- Complies with industry billing and financial regulations for accurate reporting.
Use Cases of Account Management API
- Enterprise Financial Operations – Helps businesses handle complex billing structures for customers and partners.
- Subscription-Based Services – Supports recurring billing models for B2B and B2B2C services.
- Wholesale & Partner Settlements – Enables seamless settlement tracking for vendors and partners.
- E-Commerce & Digital Transactions – Helps businesses streamline online payment and invoicing.
- Accounting & Audit Automation – Provides real-time insights for financial reporting and reconciliation.
The Account Management API plays a critical role in ensuring smooth financial operations, enhancing billing accuracy, and optimizing account management across business relationships.
Questions about the Account Management API
What can I do with the Account Management API?
The Account Management API manages party, billing, settlement and financial accounts in B2B and B2B2C settings. The main call, POST /partyAccount, creates an account and returns the PartyAccount object; matching GET, PATCH and DELETE calls find, update and remove accounts. It follows TM Forum TMF666 and is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.
- List or find BillingAccount objects (
GET /billingAccount) - Creates a BillingAccount (
POST /billingAccount) - Retrieves a BillingAccount by ID (
GET /billingAccount/{id})
Which inputs does each call to the Account Management API need?
GET /billingAccount: headerscountryCode,transactionIdPOST /billingAccount: requiresname,relatedParty; headerscountryCode,transactionIdGET /billingAccount/{id}: requiresid; headerscountryCode,transactionId
Every call also needs Authorization: Bearer <access_token>. The API reference on this page shows each field's type and an example request.
What does the Account Management API return?
POST /billingAccountreturns HTTP 201 withid,href,accountType,description,lastModified,nameGET /billingAccount/{id}returns HTTP 200 withid,href,accountType,description,lastModified,name
Responses are JSON.
How do I authenticate with the Account Management API?
- Call
POST https://api.ooredoo.com/tmf-api/oauth/v4/tokenwithclient_id,client_secretin the headers. Sendgrant_typein the body. Use the client ID and secret of your app. - The response contains
access_token,token_type,expires_in,scope. - Send
Authorization: Bearer <access_token>on each call until the token expires, then request a new one.
Which errors can the Account Management API return?
- 400: Bad Request
- 401: Invalid client credentials
- 403: Forbidden
- 404: Not Found
- 405: Method Not allowed
- 409: Conflict
- 500: Internal Server Error
On 401, request a new access token and retry.
Where is the Account Management API available?
Account Management is available in Algeria, Kuwait, Maldives, Oman, Palestine and Tunisia.
Which standard does the Account Management API follow?
It follows the TM Forum Open API standard used across the telecom industry. See our TM Forum certification page.
Sample call
From the published OpenAPI specification. Replace the placeholders with your app's credentials and real values.
1. Get an access token
curl -X POST https://api.ooredoo.com/tmf-api/oauth/v4/token \
-H "client_id: $CLIENT_ID" \
-H "client_secret: $CLIENT_SECRET" \
-d "grant_type=client_credentials"2. Call the API
curl -X GET https://api.ooredoo.com/tmf-api/accountManagement/v4/billingAccount \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "countryCode: <countryCode>" \
-H "transactionId: <transactionId>"API reference
Try any endpoint in the sandbox

