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 Carrier Billing

GSMA Carrier Billing from GSMA — 6 path(s) described in OpenAPI.

GSMA Carrier Billing is one of 18 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, organized into 3 resource areas, and defines 41 schemas. It is described by OpenAPI 3.0.3, at version wip.

Requests are made against a single base URL, {apiRoot}/carrier-billing/vwip.

7 operations 6 paths 41 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
wip
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Authentication
OpenID Connect, HTTP Bearer
License
Resource Areas
3

Authentication & Security 2

GSMA Carrier Billing declares 2 security schemes for authenticating requests. It supports OpenID Connect (openId) discovered at https://example.com/.well-known/openid-configuration. It accepts HTTP bearer tokens ({$request.body#/sinkCredential.credentialType}) (notificationsBearerAuth).

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 2 GET, 5 POST. They span 3 resource areas: One Step Payment, Payment, Two Step Payment. Each is listed below with its method, path, parameters, and response codes.

One Step Payment 1

Operations to manage One Step Payment procedure

POST
/payments
Create a new Payment
createPayment 1 param body → 201400401403404409422429
Payment 2

Operations to obtain information about payments

GET
/payments
Get a list of payments
retrievePayments 8 params → 200400401403429
GET
/payments/{paymentId}
Get payment details
retrievePayment 2 params → 200400401403404429
Two Step Payment 4

Operations to manage Two Step Payment procedure

POST
/payments/prepare
Prepare (reserve) a payment
preparePayment 1 param body → 201400401403404409422429
POST
/payments/{paymentId}/validate
Validate a payment
validatePayment 2 params body → 204400401403404409429
POST
/payments/{paymentId}/confirm
Confirm a payment
confirmPayment 2 params body → 202400401403404409422429
POST
/payments/{paymentId}/cancel
Cancel a payment
cancelPayment 2 params body → 202400401403404409422429

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are ChargingMetaData (7 properties), CloudEvent (7 properties), PaymentCreated (6 properties), Payment (6 properties). Each schema is shown below with its type and property counts.

XCorrelator
string
CreatePayment
object
3 properties 1 required
PaymentCreated
object
6 properties 4 required
PaymentArray
array
A list of payment(s)
Payment
object
6 properties 4 required
SinkCredential
object
1 property 1 required
PlainCredential
object
A plain credential as a combination of an identifier and a secret.
AccessTokenCredential
object
An access token credential.
RefreshTokenCredential
object
An access token credential with a refresh token.
5 required
AmountTransaction
object
6 properties 3 required
AmountTransactionInput
object
4 properties 2 required
PaymentAmountForCharge
object
3 properties 1 required
PhoneNumber
object
1 property
ValidatePayment
object
2 properties 2 required
BodyAmountReservationTransactionForReserve
object
6 properties 4 required
BodyAmountReservationTransactionForReserveInput
object
3 properties 1 required
AmountReservationTransactionForReserve
object
6 properties 3 required
AmountReservationTransactionForReserveInput
object
4 properties 2 required
PaymentAmountForReserve
object
3 properties 1 required
PaymentDetails
array
Detailed description of the concepts/items considered within a specific payment procedure.
PaymentItem
object
6 properties 4 required
ChargingInformation
object
5 properties 3 required
ChargingMetaData
object
7 properties
ValidationInfo
object
1 property 1 required
Open
Validate
CloudEvent
object
The notification format
7 properties 5 required
Source
string
Identifies the context in which an event happened - be a non-empty URI-reference like: - URI with a DNS authority: https://github.com/cloudevents mailto:cncf-w…
DateTime
string
Timestamp when the occurrence happened. It must follow [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339section-5.6) and must have time zone.
EventPaymentPendingValidation
Event structure for payment pending validation
EventPaymentReserved
Event structure for payment reserved
EventPaymentCompleted
Event structure for payment completed
EventPaymentCancelled
Event structure for payment cancelled
EventPaymentDenied
Event structure for payment denied
PaymentPendingValidation
PaymentReserved
PaymentCompleted
PaymentCancelled
PaymentDenied
BasicEvent
object
Data type to provide basic payment event information
3 properties 3 required
ErrorInfo
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-open-gateway-carrier-billing-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Mobile Money API
GSMA Call Forwarding Signal
GSMA Carrier Billing Refund
GSMA CAMARA Mobile Device Identifier
GSMA Device Location Retrieval
GSMA Device Location Verification
GSMA Device Reachability Status
GSMA Device Roaming Status
GSMA Device Swap
GSMA Home Devices QoD
GSMA Know Your Customer Match
GSMA Number Verification
Where this information came from

This is an independent, third-party profile of GSMA Carrier Billing, 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.