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

The **Links** APIs are used to establish a link between two separate accounts on the client and provider systems. The API can be used for example to link a mobile wallet account to a Microfinance Institution account or a bank account. The link object does not mandate the processes to verify and authenticate a link request - this depends upon the use case. A link needs to be associated with a mode of operation:- pull. The link can be used by the client to debit the target account held by the provider.- push. The link can be used by the client to credit the target account held by the provider.- both. The link can be used for Push and Pull requests.

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

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

This API exposes 6 operations across 4 paths, and defines 20 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.

6 operations 4 paths 20 schemas 2 GET2 PATCH2 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 6

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

Links 6

The Links APIs are used to establish a link between two separate accounts on the client and provider systems. The API can be used for example to link a mobile wallet account to a…

POST
/accounts/{accountId}/links
Create A Link
accountsAccountIdLinksPOST 13 params body → 201202400401404500503
POST
/accounts/{identifierType}/{identifier}/links
Create A Link
accountsIdentifierTypeIdentifierLinksPOST 14 params body → 201202400401404500503
GET
/accounts/{accountId}/links/{linkReference}
View A Link
accountsAccountIdLinksLinkReferenceGET 12 params → 200400401404500503
PATCH
/accounts/{accountId}/links/{linkReference}
Update A Link
accountsAccountIdLinksLinkReferencePATCH 14 params body → 202204400401404500503
GET
/accounts/{identifierType}/{identifier}/links/{linkReference}
View A Link
accountsIdentifierTypeIdentifierLinksLinkReferenceGET 13 params → 200400401404500503
PATCH
/accounts/{identifierType}/{identifier}/links/{linkReference}
Update A Link
accountsIdentifierTypeIdentifierLinksLinkReferencePATCH 15 params body → 202204400401404500503

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are responseLink (9 properties), requestStateObject (8 properties), requestLink (6 properties), errorObject (5 properties). Each schema is shown below with its type and property counts.

metadata
object
2 properties 2 required
requestGenericPatch
object
3 properties 3 required
genericUpdateSuccess
object
1 property 1 required
metadataArray
array
A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource.
mode
string
linkReference
string
Indicates the Link reference. This enables a linked account to be uniquely identified.
requestingOrganisation
object
An object that details the originating organisation of the request.
2 properties 2 required
requestGenericPatchArray
array
Collection of updates that are to be processed.
modificationDate
string
Date and time when the object was modified by the API Provider.
requestLink
object
6 properties 3 required
responseLink
object
9 properties 4 required
customDataArray
array
A collection of key/value pairs. These can be used to populate provider specific fields.
status
string
requestStateObject
object
8 properties 3 required
debitPartyArray
array
A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier.
creationDate
string
Date and time when the object was created by the API Provider.
requestDate
string
The date and time of the request as supplied by the client.
party
object
2 properties 2 required
errorObject
object
5 properties 2 required
customData
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-links-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 Location Retrieval API
Where this information came from

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