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 Open Gateway Two Step Payment API

Operations to manage Two Step Payment procedure

GSMA Open Gateway Two Step Payment API is one of 34 APIs that GSMA Open Gateway publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Two Step Payment. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

4 operations 4 paths 18 schemas 4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.5.0
Server
{apiRoot}/carrier-billing/v0.5
Authentication
OpenID Connect, HTTP Bearer
License
Resource Areas
1

Authentication & Security 2

GSMA Open Gateway Two Step Payment 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 4 paths, the API surfaces 4 operations — 4 POST. Each is listed below with its method, path, parameters, and response codes.

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 18

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

CloudEvent
object
The notification format
7 properties 5 required
XCorrelator
string
AmountReservationTransactionForReserve
object
6 properties 3 required
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.
PaymentDetails
array
Detailed description of the concepts/items considered within a specific payment procedure.
ChargingMetaData
object
7 properties
SinkCredential
object
1 property 1 required
ErrorInfo
object
3 properties 3 required
ValidationInfo
object
1 property 1 required
ChargingInformation
object
5 properties 3 required
PaymentItem
object
6 properties 4 required
ValidatePayment
object
2 properties 2 required
PaymentAmountForReserve
object
3 properties 1 required
AmountReservationTransactionForReserveInput
object
4 properties 2 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…
PhoneNumber
object
1 property
BodyAmountReservationTransactionForReserve
object
6 properties 4 required
BodyAmountReservationTransactionForReserveInput
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

open-gateway-two-step-payment-api-openapi.yml Raw ↑

Other APIs GSMA Open Gateway publishes across the network.

GSMA Open Gateway Age Verification API
GSMA Open Gateway API Product API
GSMA Open Gateway API Product Order API
GSMA Open Gateway Application API
GSMA Open Gateway Application Owner API
GSMA Open Gateway Call Forwarding information retrieval API
GSMA Open Gateway Check Device Swap API
GSMA Open Gateway Check SIM swap API
GSMA Open Gateway Check Subscriber Tenure API
GSMA Open Gateway Connected Network Type API
GSMA Open Gateway Device reachability status API
GSMA Open Gateway Device reachability status subscription API
Where this information came from

This is an independent, third-party profile of GSMA Open Gateway Two Step Payment 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.