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 Refund API

Operations to manage Refund procedure

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

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

This API exposes 4 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version wip.

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

4 operations 3 paths 10 schemas 3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 Refund API 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 10

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

ErrorInfo
object
3 properties 3 required
SinkCredential
object
1 property 1 required
CloudEvent
object
The notification format
7 properties 5 required
XCorrelator
string
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.
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…
RefundArray
array
A list of refund(s)
Refund
object
Information about a Refund resource.
7 properties 4 required
PaymentRemainingAmount
object
Remaining Amount of a given payment not refunded yet.
5 properties 2 required
CreateRefund
object
Information to create a Refund resource.
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-refund-api-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Accounts API
GSMA Authorisation Codes API
GSMA Bills 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
Where this information came from

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