How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

GSMA Bills API

The **Bills** APIs allow a mobile money provider to allow customers to retrieve and pay bills. Specific use cases include:- Retrieving information on service providers (bill companies) that accept bill payments.- Retrieving bills at a service provider for a given mobile money customer.- Allowing mobile money customers to partially or fully pay bills for a service provider.- Retrieving bill payment information from a service provider for a given customer.

GSMA Bills API is one of 31 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Bills. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.

This API exposes 16 operations across 11 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version 1.2.0.

Requests are made against a single base URL, https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm.

16 operations 11 paths 35 schemas 11 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.2.0
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Resource Areas
1

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 11 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Bills 16

The Bills APIs allow a mobile money provider to allow customers to retrieve and pay bills. Specific use cases include: - Retrieving information on service providers (bill companie…

GET
/billcompanies
View Bill Companies
billCompaniesGET 12 params → 200400401404500503
GET
/billcompanies/{serviceProvider}
View a Specific Bill Company
billCompaniesServiceProviderGET 11 params → 200400401404500503
GET
/accounts/{accountId}/billcompanies
View Bill Companies
accountsAccountIdBillCompaniesGET 13 params → 200400401404500503
GET
/accounts/{identifierType}/{identifier}/billcompanies
View Bill Companies
accountsIdentifierTypeIdentifierBillCompaniesGET 14 params → 200400401404500503
GET
/accounts/{accountId}/bills
View Account Bills
accountsAccountIdBillsGET 15 params → 200400401404500503
GET
/accounts/{identifierType}/{identifier}/bills
View Account Bills
accountsIdentifierTypeIdentifierBillsGET 16 params → 200400401404500503
POST
/accounts/{accountId}/bills/{billReference}/payments
Create A Bill Payment
accountsAccountIdBillsBillReferencePaymentsPOST 14 params body → 201202400401404500503
GET
/accounts/{accountId}/bills/{billReference}/payments
View Payments for a Bill
accountsAccountIdBillsBillReferencePaymentsGET 16 params → 200400401404500503
POST
/accounts/{identifierType}/{identifier}/bills/{billReference}/payments
Create A Bill Payment
accountsIdentifierTypeIdentifierBillsBillReferencePaymentsPOST 15 params body → 201202400401404500503
GET
/accounts/{identifierType}/{identifier}/bills/{billReference}/payments
View Payments for a Bill
accountsIdentifierTypeIdentifierBillsBillReferencePaymentsGET 17 params → 200400401404500503
POST
/bills/{billReference}/payments
Create A Bill Payment
billsBillReferencePaymentsPOST 13 params body → 201202400401404500503
GET
/bills/{billReference}/payments
View Payments for a Bill
abillsBillReferencePaymentsGET 15 params → 200400401404500503
POST
/accounts/{accountId}/bills/payments
Create A Bill Payment without a Bill Reference
accountsAccountIdBillsBillPaymentsPOST 13 params body → 201202400401404500503
GET
/accounts/{accountId}/bills/payments
View Payments for a Bill without a Bill Reference
accountsAccountIdBillsBillPaymentsGET 15 params → 200400401404500503
POST
/accounts/{identifierType}/{identifier}/bills/payments
Create A Bill Payment without a Bill Reference
accountsIdentifierTypeIdentifierBillsBillPaymentsPOST 14 params body → 201202400401404500503
GET
/accounts/{identifierType}/{identifier}/bills/payments
View Payments for a Bill without a Bill Reference
accountsIdentifierTypeIdentifierBillsBillPaymentsGET 16 params → 200400401404500503

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are responseBillPayment (17 properties), responseBillPayment2 (16 properties), requestBillPayment (12 properties), responseBills (11 properties). Each schema is shown below with its type and property counts.

requestBillPayment
object
12 properties 2 required
supplementaryBillReferenceDetails
object
2 properties 2 required
metadata
object
2 properties 2 required
requestingOrganisationBillPay
string
The originating mobile money provider or financial institution that holds the wallet/account of the payer.
serviceProviderNotification
string
Allows the Service Provider to include specific information that will be included on the notification to the customer by the mobile money provider.
metadataArray
array
A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource.
paymentType
string
billStatus
string
customerReference
string
Textual reference provided by the customer paying the bill.
dueDate
string
Date on which the Bill is due to be paid.
companyName
string
Display Name for the Service Provider.
billReference
string
Reference number for the Bill that the payer can use when making a payment.
modificationDate
string
Date and time when the object was modified by the API Provider.
currency
string
requestingOrganisationTransactionReference
string
A reference provided by the requesting organisation that is to be associated with the transaction.
customDataArray
array
A collection of key/value pairs. These can be used to populate provider specific fields.
responseBillCompanies
object
5 properties 2 required
requestBillPayment2
object
11 properties 2 required
responseBillPayment2
object
16 properties 3 required
requestStateObject
object
8 properties 3 required
supplementaryBillReferenceDetailsArray
array
In some cases, a single reference is not sufficient to identify a bill. This key-value collection enables further reference information to be supplied.
billDescription
string
Description of the bill that is to be paid
serviceProviderComment
string
Allows the Service Provider to include specific information regarding the bill payment.
serviceProviderSubType
string
Sub-Type of Service Provider.
responseBillPayment
object
17 properties 3 required
creationDate
string
Date and time when the object was created by the API Provider.
serviceProviderType
string
Type of Service Provider that accepts payments.
responseBills
object
11 properties
billPaymentStatus
string
Indicates the status of the bill payment as stored by the API provider.
serviceProvider
string
Service Provider Reference Code.
requestDate
string
The date and time of the request as supplied by the client.
serviceProviderPaymentReference
string
Reference for the payment generated by the service provider.
errorObject
object
5 properties 2 required
amount
string
customData
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-bills-api-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Accounts API
GSMA Authorisation Codes API
GSMA Call Forwarding information retrieval API
GSMA Check Device Swap API
GSMA Check SIM Swap API
GSMA Debit Mandates API
GSMA Device reachability status API
GSMA Discovery API
GSMA Get Device Identifiers API
GSMA Home Devices QoD API
GSMA Links API
GSMA Location Retrieval API
Where this information came from

This is an independent, third-party profile of GSMA Bills API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.