GSMA Mobile Money API
The GSMA Mobile Money API is a harmonised REST/JSON specification for mobile money platforms, developed by the GSMA with the mobile money industry and published openly at developer.mobilemoneyapi.io. Version 1.2.0 defines 53 paths across Transactions, Quotations, Accounts, Bills, Debit Mandates, Links, and Authorisation Codes, covering merchant payments, disbursements, international transfers, P2P transfers, recurring payments, account linking, bill payments, and agent cash-in/cash-out. The OpenAPI 3.0.0 document is downloadable without registration; the simulator sandbox host referenced in the spec did not resolve in DNS on the review date.
GSMA Mobile Money API is one of 18 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Mobile Money, Payments, Financial Inclusion, and Specification. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 71 operations across 53 paths, organized into 8 resource areas, and defines 176 schemas. It is described by OpenAPI 3.0.0, at version 1.2.0.
Requests are made against a single base URL, https://sandbox.mobilemoneyapi.io/simulator/v1.2/passthrough/mm.
71 operations
53 paths
176 schemas
41 GET13 PATCH17 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 71
Across 53 paths, the API surfaces 71 operations — 41 GET, 13 PATCH, 17 POST. They span 8 resource areas: Transactions, Accounts, Bills, Debit Mandates, Links, Quotations, Authorisation Codes, Supporting. Each is listed below with its method, path, parameters, and response codes.
Transactions 10
The Transactions APIs are used to support mobile money financial transaction use cases. Transactions are used for a wide range of use cases including merchant payments, internatio…
POST
/transactionsdeprecated
Create a Transaction
POST
/transactions/type/{transactionType}
Create a Transaction
GET
/transactions/{transactionReference}
View A Transaction
PATCH
/transactions/{transactionReference}
Update A Transaction
POST
/transactions/{transactionReference}/reversals
Create A Reversal
POST
/batchtransactions
Create A Transaction Batch
GET
/batchtransactions/{batchId}
View A Transaction Batch
PATCH
/batchtransactions/{batchId}
Update A Transaction Batch
GET
/batchtransactions/{batchId}/rejections
View Batch Rejections
GET
/batchtransactions/{batchId}/completions
View Batch Completions
Accounts 19
The Accounts APIs are used to support a range of operations on a financial account resource and associated resources. Types of accounts include mobile wallets, financial instituti…
POST
/accounts/{identityType}
Create an Account
GET
/accounts/{accountId}
View an Account
PATCH
/accounts/{accountId}
Update an Account
GET
/accounts/{identifierType}/{identifier}
View an Account
PATCH
/accounts/{identifierType}/{identifier}
Update an Account
PATCH
/accounts/{accountId}/identities/{identityId}
Update an Account Identity.
PATCH
/accounts/{identifierType}/{identifier}/identities/{identityId}
Update an Account Identity
GET
/accounts/{accountId}/status
View Account Status
GET
/accounts/{identifierType}/{identifier}/status
View Account Status
GET
/accounts/{accountId}/accountname
View Account Name
GET
/accounts/{identifierType}/{identifier}/accountname
View Account Name
GET
/accounts/{accountId}/balance
View Account Balance
GET
/accounts/{identifierType}/{identifier}/balance
View Account Balance
GET
/accounts/balance
View Account Balance
GET
/accounts/{accountId}/transactions
View Account Specific Transaction
GET
/accounts/{identifierType}/{identifier}/transactions
View Account Specific Transaction
GET
/accounts/{accountId}/statemententries
View Account Statements
GET
/accounts/{identifierType}/{identifier}/statemententries
View Account Statements
GET
/statemententries/{transactionReference}
View Specific Statement
Bills 16
The Bills APIs allow a mobile money provider to allow customers to retrieve and pay bills. Specific use cases include: - Retrieving information on service providers (bill companie…
GET
/billcompanies
View Bill Companies
GET
/billcompanies/{serviceProvider}
View a Specific Bill Company
GET
/accounts/{accountId}/billcompanies
View Bill Companies
GET
/accounts/{identifierType}/{identifier}/billcompanies
View Bill Companies
GET
/accounts/{accountId}/bills
View Account Bills
GET
/accounts/{identifierType}/{identifier}/bills
View Account Bills
POST
/accounts/{accountId}/bills/{billReference}/payments
Create A Bill Payment
GET
/accounts/{accountId}/bills/{billReference}/payments
View Payments for a Bill
POST
/accounts/{identifierType}/{identifier}/bills/{billReference}/payments
Create A Bill Payment
GET
/accounts/{identifierType}/{identifier}/bills/{billReference}/payments
View Payments for a Bill
POST
/bills/{billReference}/payments
Create A Bill Payment
GET
/bills/{billReference}/payments
View Payments for a Bill
POST
/accounts/{accountId}/bills/payments
Create A Bill Payment without a Bill Reference
GET
/accounts/{accountId}/bills/payments
View Payments for a Bill without a Bill Reference
POST
/accounts/{identifierType}/{identifier}/bills/payments
Create A Bill Payment without a Bill Reference
GET
/accounts/{identifierType}/{identifier}/bills/payments
View Payments for a Bill without a Bill Reference
Debit Mandates 6
The Debit Mandates APIs allow a mobile money customer to provide prior approval for payments to be taken from their account by a requesting payee. If the amount limit field is not…
POST
/accounts/{accountId}/debitmandates
Create A Debit Mandate
POST
/accounts/{identifierType}/{identifier}/debitmandates
Create A Debit Mandate
GET
/accounts/{accountId}/debitmandates/{debitMandateReference}
View A Debit Mandate
PATCH
/accounts/{accountId}/debitmandates/{debitMandateReference}
Update A Debit Mandate
GET
/accounts/{identifierType}/{identifier}/debitmandates/{debitMandateReference}
View A Debit Mandate
PATCH
/accounts/{identifierType}/{identifier}/debitmandates/{debitMandateReference}
Update A Debit Mandate
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
POST
/accounts/{identifierType}/{identifier}/links
Create A Link
GET
/accounts/{accountId}/links/{linkReference}
View A Link
PATCH
/accounts/{accountId}/links/{linkReference}
Update A Link
GET
/accounts/{identifierType}/{identifier}/links/{linkReference}
View A Link
PATCH
/accounts/{identifierType}/{identifier}/links/{linkReference}
Update A Link
Quotations 2
The Quotations APIs are used to obtain one or multiple quotes for a mobile money customer who wishes to transfer money. The creation of a quote involves returning any fees that wi…
POST
/quotations
Create A New Quotation
GET
/quotations/{quotationReference}
View A Quotation
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
GET
/accounts/{accountId}/authorisationcodes
View Authorisation Codes for a given account
POST
/accounts/{identifierType}/{identifier}/authorisationcodes
Create an Authorisation Code via an account identifier.
GET
/accounts/{identifierType}/{identifier}/authorisationcodes
View Authorisation Codes for a given account
GET
/accounts/{accountId}/authorisationcodes/{authorisationCode}
View an Authorisation Code
PATCH
/accounts/{accountId}/authorisationcodes/{authorisationCode}
Update an Authorisation Code
GET
/accounts/{identifierType}/{identifier}/authorisationcodes/{authorisationCode}
View an Authorisation Code
PATCH
/accounts/{identifierType}/{identifier}/authorisationcodes/{authorisationCode}
Cancel an Authorisation Code
Supporting 4
Supporting APIs consist of the following: - Heartbeat API: Used for monitoring purposes and establishes whether the system of an API provider is in a state that enables a client t…
GET
/heartbeat
Check API availability
GET
/requeststates/{serverCorrelationId}
View A Request State
PATCH
/requeststates/{serverCorrelationId}deprecated
Update A Request State
GET
/responses/{clientCorrelationId}
View A Response
Schemas 176
The contract defines 176 schemas that model the data the API accepts and returns. The most detailed are responseTransaction (29 properties), responseQuotation (26 properties), responseReversal (25 properties), requestTransaction (22 properties). Each schema is shown below with its type and property counts.
amount
string
currency
string
type
string
The harmonised Transaction Type.
typeReversal
string
The harmonised Transaction Type.
subType
string
A non-harmonised sub-classification of the type of transaction. Values are not fixed, and usage will vary according to Provider.
descriptionText
string
Free format text description of the transaction provided by the client. This can be provided as a reference for the receiver on a notification SMS and on an ac…
requestDate
string
The date and time of the request as supplied by the client.
requestingOrganisationTransactionReference
string
A reference provided by the requesting organisation that is to be associated with the transaction.
oneTimeCode
string
A one-time code that can be supplied in the request or can be generated in the response depending upon the use case. An authorisation code can be supplied in t…
geoCode
string
Indicates the geographic location from where the transaction was initiated.
originalTransactionReference
string
For reversals and refunds, this field indicates the transaction which is the subject of the reversal.
servicingIdentity
string
The field is used to identify the servicing identity for transactions, e.g. till, POS ID, assistant ID.
requestingLei
string
Legal Entity Identifier of the organisation that is requesting the transaction.
receivingLei
string
Legal Entity Identifier of the organisation that is receiving the transaction.
transactionStatus
string
Indicates the status of the transaction as stored by the API provider.
dateCreated
string
Date and time when the object was created by the API Provider.
creationDate
string
Date and time when the object was created by the API Provider.
dateModified
string
Date and time when the object was modified by the API Provider.
modificationDate
string
Date and time when the object was modified by the API Provider.
transactionReference
string
Unique reference for the transaction. This is returned in the response by API provider.
transactionReceipt
string
Transaction receipt number as notified to the parties. This may differ from the Transaction Reference.
quotationReference
string
Reference for the quotation that was provided to the sender.
quoteId
string
The specific quote associated with the quotation.
remittancePurpose
string
Field providing a description of the reason for the international remittance.
relationshipSender
string
Indicates the relationship (if any) between the sender and the receiver.
deliveryMethod
string
party
object
2 properties
2 required
creditPartyArray
array
A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier.
debitPartyArray
array
A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier.
payee
array
A collection of key/value pairs that enable the payee to be identified. Keys include MSISDN and Wallet Identifier.
feesArray
array
Returns all fees that are applicable to the object.
metadataArray
array
A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource.
customDataArray
array
A collection of key/value pairs. These can be used to populate provider specific fields.
fees
object
3 properties
3 required
metadata
object
2 properties
2 required
customData
object
2 properties
2 required
nationality
string
dateOfBirth
string
Birth date of the KYC subject.
occupation
string
Occupation of the KYC subject.
employerName
string
Employer name of the KYC subject.
contactPhone
string
Contact phone number (mobile or landline) of the KYC subject.
gender
string
Gender of the KYC subject.
emailAddress
string
Email address of the KYC subject.
internationalTransferInformation
object
A collection of properties detailing information specifically used for international transfers.
8 properties
1 required
internationalTransferInformationResponse
object
10 properties
1 required
idDocumentArray
array
An array of properties containing the forms of identification that are associated with the subject.
idDocument
object
8 properties
1 required
postalAddress
object
7 properties
1 required
subjectName
object
6 properties
kyc
object
11 properties
batchTitle
string
Client-provided title for the batch.
batchDescription
string
Client-provided description of the batch.
processingFlag
boolean
Indicates whether the batch is currently undergoing processing by the API Provider.
scheduledStartDate
string
If the batch has been scheduled, the expected start time is provided here.
batchStatus
string
approvalDate
string
Indicates when the batch was approved as recorded by the API.
completionDate
string
Indicates when the batch was completed as recorded by the API.
transactionCompletionDate
string
Date and time indicating when the transaction was completed.
completedDate
string
Indicates when the batch was completed as recorded by the API.
transactionCompletedDate
string
Date and time indicating when the transaction was completed.
rejectionCount
number
Indicates the number of records that have been rejected, either during parsing or during final processing.
parsingSuccessCount
number
Indicates the number of records that have been parsed successfully.
completedCount
number
Indicates the number of records that have been successful completed.
batchId
string
Identifier for the Batch that is assigned by the API provider. This ID is used by the client on subsequent GET or PATCH methods.
rejectionDate
string
Date and time of the rejection.
dateRejected
string
Date and time of the rejection.
rejectionReason
string
The reason for the transaction request as indicated by the API provider.
link
string
Provides a URL to the resource.
lei
string
Legal Entity Identifier.
identityRequest
object
6 properties
2 required
identityResponse
object
9 properties
4 required
accountIdentifiersArray
array
A collection of key/value pairs that enable the account to be identified. Keys include MSISDN and Wallet Identifier.
identityRequestArray
array
An array containing the details of each identity associated with an account.
identityResponseArray
array
An array containing the details of each identity associated with an account.
accountType
string
A non-harmonised field that indicates the type of the account.
accountSubStatus
string
Field can be used to return a provider-specific status for the account.
commissionEarnedArray
array
Returns all commission earned by the registering entity for the creation of the account.
commissionEarned
object
3 properties
3 required
registeringEntity
string
The entity that registered the account, for example, a mobile money agent.
currentBalance
Current outstanding balance on the account.
availableBalance
Indicates the balance that is able to be debited for an account. This balance is only provided on some API provider systems.
reservedBalance
Indicates the portion of the balance that is reserved, i.e. intended to be debited. This balance is only provided on some API provider systems.
unclearedBalance
Indicates the sum of uncleared funds in an account, i.e. the funds that are awaiting a credit confirmation.
identityId
string
A unique id for the identity as assigned by the API Provider.
identityType
string
Indicates the type of the identity. Currently, only ‘individual’ is supported.
identityStatus
string
A unique id for the identity as assigned by the API Provider.
accountRelationship
string
Describes the relationship that the identity holds with the account.
kycVerificationStatus
string
Indicates the status of the identity’s KYC verification.
kycVerificationEntity
string
Indicates the entity (e.g. mobile money agent) that has verified the KYC of the identity.
kycLevel
integer
Indicates the KYC level that the identity is associated with.
accountStatus
string
Indicates a harmonised representation of the account status. This will be shown as available, unavailable or unregistered.
subStatus
string
Can be used to return a provider-specific status for the account.
displayType
string
The transaction type that is to be used for presentation to the account holder as determined by the API provider. This is not necessarily the actual transactio…
companyName
string
Display Name for the Service Provider.
serviceProvider
string
Service Provider Reference Code.
serviceProviderType
string
Type of Service Provider that accepts payments.
serviceProviderSubType
string
Sub-Type of Service Provider.
serviceProviderPaymentReference
string
Reference for the payment generated by the service provider.
billPaymentStatus
string
Indicates the status of the bill payment as stored by the API provider.
requestingOrganisation
object
An object that details the originating organisation of the request.
2 properties
2 required
requestingOrganisationBillPay
string
The originating mobile money provider or financial institution that holds the wallet/account of the payer.
serviceProviderComment
string
Allows the Service Provider to include specific information regarding the bill payment.
serviceProviderNotification
string
Allows the Service Provider to include specific information that will be included on the notification to the customer by the mobile money provider.
customerReference
string
Textual reference provided by the customer paying the bill.
paymentType
string
supplementaryBillReferenceDetailsArray
array
In some cases, a single reference is not sufficient to identify a bill. This key-value collection enables further reference information to be supplied.
supplementaryBillReferenceDetails
object
2 properties
2 required
dueDate
string
Date on which the Bill is due to be paid.
billReference
string
Reference number for the Bill that the payer can use when making a payment.
billDescription
string
Description of the bill that is to be paid
billStatus
string
startDate
string
Date on which the mandate starts. If a frequencyType is specified, this will also be the date on which the first payment is to be taken.
endDate
string
Date on which the mandate ends.
numberOfPayments
number
Indicates the number of consecutive payments that are to be taken.
frequencyType
string
mandateStatus
string
mandateReference
string
Unique reference provided by the API Provider for the mandate.
status
string
mode
string
linkReference
string
Indicates the Link reference. This enables a linked account to be uniquely identified.
quoteArray
array
A collection of quotes. A quote can be received from a single financial service provider or from multiple providers.
quotes
object
10 properties
5 required
quoteExpiryTime
string
The timestamp when the quote will expire.
receivingServiceProvider
string
The name of the receiving service provider, i.e. the provider that the quote is associated with.
fxRate
string
The conversion rate applicable between the sending and the receiving currency for the requested transaction.
senderBlockingReason
string
The reason for blocking the quotation, based on AML checks on the sender.
recipientBlockingReason
string
The reason for blocking the quotation, based on AML checks on the recipient.
quotationStatus
string
Indicates the creation state of the Quotation.
authorisationCode
string
The code that will be presented to the other party for redemption.
codeState
string
Indicates the state of the Authorisation Code.
codeLifetime
number
Indicates the expiry time in seconds of the code.
amountType
string
The amount for the authorisation can be an exact amount or can be a maximum amount.
holdFundsIndicator
boolean
Indicates whether funds should be reserved against the payers account where the payer is the requestor.
redemptionChannels
array
Indicates the channel(s) that the code can be redeemed against, e.g. ATM, Merchant, etc.
redemptionTransactionTypes
array
Indicates the Transaction Types(s) that the code can be redeemed against.
redemptionAccountIdentifiers
array
A collection of key/value pairs that enable the redemption account to be identified. Keys include MSISDN and Wallet Identifier.
serviceStatus
string
Provides the status of the requested service.
delay
number
The anticipated processing delay in milliseconds.
plannedRestorationTime
string
Where the planned restoration time is known (e.g. scheduled maintenance), it can be provided in this field.
requestStateObject
object
8 properties
3 required
genericUpdateSuccess
object
1 property
1 required
errorObject
object
5 properties
2 required
requestTransaction
object
22 properties
5 required
requestTransactionType
requestReversal
object
17 properties
1 required
requestBatchTransaction
object
9 properties
1 required
requestAccount
object
7 properties
1 required
requestBillPayment
object
12 properties
2 required
requestBillPayment2
object
11 properties
2 required
requestDebitMandate
object
11 properties
1 required
requestLink
object
6 properties
3 required
requestQuotation
object
16 properties
4 required
requestAuthorisationCode
object
12 properties
requestGenericPatchArray
array
Collection of updates that are to be processed.
requestGenericPatch
object
3 properties
3 required
responseTransaction
object
29 properties
7 required
responseTransactionType
responseReversal
object
25 properties
4 required
responseBatchTransaction
object
17 properties
4 required
responseBatchTransactionRejection
object
8 properties
4 required
responseBatchTransactionCompletion
object
8 properties
5 required
responseAccount
object
17 properties
3 required
responseAccountStatus
object
3 properties
1 required
responseAccountName
object
2 properties
responseAccountBalance
object
6 properties
responseStatementEntries
object
15 properties
6 required
responseBillCompanies
object
5 properties
2 required
responseBillPayment
object
17 properties
3 required
responseBillPayment2
object
16 properties
3 required
responseBills
object
11 properties
responseDebitMandate
object
16 properties
1 required
responseLink
object
9 properties
4 required
responseQuotation
object
26 properties
5 required
responseAuthorisationCode
object
16 properties
2 required
responseHeartbeat
object
3 properties
1 required
responseResponse
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from GSMA 12
Other APIs GSMA publishes across the network.
GSMA Call Forwarding Signal
GSMA Carrier Billing
GSMA Carrier Billing Refund
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
#Mobile Money#Payments#Financial Inclusion#Specification
Where this information came from
This is an independent, third-party profile of GSMA Mobile Money 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.