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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
GSMA

GSMA Authorisation Codes API

The **Authorisation** Codes APIs allow a payer to generate a payment code which when presented to the payee, can be redeemed for an amount associated with the code.Authorisation codes can be set to expire. Note that expiry time can be specified via the API, however the mobile money providermay mandate a common expiry period for all codes.Authorisation Codes are used widely in the industry across a range of use cases, including:- ATM Codes for card-less withdrawals. A code is generated in advance by the customer and entered into the ATM to facilitate the withdrawal.- Pre-authorised codes for agent withdrawals. A code is generated in advance by the customer and given to the agent to facilitate the withdrawal.- Pre-authorised codes for merchant payments. The customer generates a code which can be redeemed at a merchant.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

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

8 operations 4 paths 28 schemas 4 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 8

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

Authorisation Codes 8

The Authorisation Codes APIs allow a payer to generate a payment code which when presented to the payee, can be redeemed for an amount associated with the code. Authorisation code…

POST
/accounts/{accountId}/authorisationcodes
Create an Authorisation Code
accountsAccountIdAuthorisationcodesPOST 13 params body → 201202400401404500503
GET
/accounts/{accountId}/authorisationcodes
View Authorisation Codes for a given account
accountsAccountIdAuthorisationcodesGET 16 params → 200400401404500503
POST
/accounts/{identifierType}/{identifier}/authorisationcodes
Create an Authorisation Code via an account identifier.
accountsIdentifierTypeIdentifierAuthorisationCodesPOST 14 params body → 201202400401404500503
GET
/accounts/{identifierType}/{identifier}/authorisationcodes
View Authorisation Codes for a given account
accountsIdentifierTypeIdentifierAuthorisationCodesGET 17 params → 200400401404500503
GET
/accounts/{accountId}/authorisationcodes/{authorisationCode}
View an Authorisation Code
accountsAccountIdAuthorisationCodeAuthorisationCodeGET 12 params → 200400401404500503
PATCH
/accounts/{accountId}/authorisationcodes/{authorisationCode}
Update an Authorisation Code
accountsAccountIdAuthorisationCodesAuthorisationCodePATCH 14 params body → 202204400401404500503
GET
/accounts/{identifierType}/{identifier}/authorisationcodes/{authorisationCode}
View an Authorisation Code
accountsIdentifierTypeIdentifierAuthorisationCodesAuthorisationCodeGET 13 params → 200400401404500503
PATCH
/accounts/{identifierType}/{identifier}/authorisationcodes/{authorisationCode}
Cancel an Authorisation Code
accountsIdentifierTypeIdentifierAuthorisationCodesAuthorisationCodePATCH 15 params body → 202204400401404500503

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are responseAuthorisationCode (16 properties), requestAuthorisationCode (12 properties), requestStateObject (8 properties), errorObject (5 properties). Each schema is shown below with its type and property counts.

responseAuthorisationCode
object
16 properties 2 required
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.
codeLifetime
number
Indicates the expiry time in seconds of the code.
redemptionChannels
array
Indicates the channel(s) that the code can be redeemed against, e.g. ATM, Merchant, etc.
requestAuthorisationCode
object
12 properties
redemptionTransactionTypes
array
Indicates the Transaction Types(s) that the code can be redeemed against.
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.
redemptionAccountIdentifiers
array
A collection of key/value pairs that enable the redemption account to be identified. Keys include MSISDN and Wallet Identifier.
currency
string
customDataArray
array
A collection of key/value pairs. These can be used to populate provider specific fields.
amountType
string
The amount for the authorisation can be an exact amount or can be a maximum amount.
requestStateObject
object
8 properties 3 required
type
string
The harmonised Transaction Type.
codeState
string
Indicates the state of the Authorisation Code.
creationDate
string
Date and time when the object was created by the API Provider.
subType
string
A non-harmonised sub-classification of the type of transaction. Values are not fixed, and usage will vary according to 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
authorisationCode
string
The code that will be presented to the other party for redemption.
amount
string
customData
object
2 properties 2 required
holdFundsIndicator
boolean
Indicates whether funds should be reserved against the payers account where the payer is the requestor.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

gsma-authorisation-codes-api-openapi.yml Raw ↑

Other APIs GSMA publishes across the network.

GSMA Accounts API
AE Profile APIs.io
GSMA Bills API
AE Profile APIs.io
GSMA Call Forwarding information retrieval API
AE Profile APIs.io
GSMA Check Device Swap API
AE Profile APIs.io
GSMA Check SIM Swap API
AE Profile APIs.io
GSMA Debit Mandates API
AE Profile APIs.io
GSMA Device reachability status API
AE Profile APIs.io
GSMA Discovery API
AE Profile APIs.io
GSMA Get Device Identifiers API
AE Profile APIs.io
GSMA Home Devices QoD API
AE Profile APIs.io
GSMA Links API
AE Profile APIs.io
GSMA Location Retrieval API
AE Profile APIs.io
#Authorisation Codes
← Back to G APIs
API Details
ID
gsma:gsma-authorisation-codes-api
Base URL
https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm
Docs
https://developer.mobilemoneyapi.io/api-versions-1.2/
Provider
GSMA
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=gsma-authorisation-codes-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/gsma-authorisation-codes-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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