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 Refund

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

GSMA Carrier Billing Refund 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 4 operations across 3 paths, and defines 32 schemas. It is described by OpenAPI 3.0.3, at version wip.

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

4 operations 3 paths 32 schemas 3 GET1 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
1

Authentication & Security 2

GSMA Carrier Billing Refund 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 4

Across 3 paths, the API surfaces 4 operations — 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Refund 4

Operations to manage Refund procedure

POST
/payments/{paymentId}/refunds
Create a new Refund
createRefund 2 params body → 201400401403404422409429
GET
/payments/{paymentId}/refunds
Get a list of refunds
retrieveRefunds 9 params → 200400401403404429
GET
/payments/{paymentId}/refunds/{refundId}
Get refund details
retrieveRefund 3 params → 200400401403404429
GET
/payments/{paymentId}/refunds/remaining-amount
Get remaining amount not refunded for a given payment
retrievePaymentRemainingAmount 2 params → 200400401403404429

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are Refund (7 properties), CloudEvent (7 properties), RefundItem (6 properties), ChargingInformation (5 properties). Each schema is shown below with its type and property counts.

XCorrelator
string
CreateRefund
object
Information to create a Refund resource.
4 properties 1 required
CreateTotalRefund
CreatePartialRefund
Refund
object
Information about a Refund resource.
7 properties 4 required
TotalRefund
PartialRefund
AmountTransactionTotalRefund
object
3 properties 2 required
RefundAmountTotalRefund
object
Information for a total refund. Whole amount is refunded so as it is not needed to be provided, then it can be an empty object unless merchantIdentifier is ind…
1 property
AmountTransactionPartialRefund
object
3 properties 2 required
RefundAmountPartialRefund
object
Information for a partial refund. Amount to be refunded is required.
3 properties 1 required
RefundArray
array
A list of refund(s)
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
ChargingInformation
object
5 properties 3 required
ChargingMetaData
object
1 property
RefundDetails
array
Detailed description of the concepts/items considered within a specific refund procedure.
RefundItem
object
6 properties 4 required
PaymentRemainingAmount
object
Remaining Amount of a given payment not refunded yet.
5 properties 2 required
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.
EventRefundCompleted
Event structure for refund completed
EventRefundDenied
Event structure for refund denied
EventRefundInBill
Event structure for refund in bill (i.e. confirmation about refund will be applied in next bill)
RefundCompleted
RefundDenied
RefundInBill
BasicEvent
object
Data type to provide basic refund event information
4 properties 4 required
ErrorInfo
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs GSMA publishes across the network.

GSMA Mobile Money API
GSMA Call Forwarding Signal
GSMA Carrier Billing
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 Refund, 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.