GSMA Accounts API
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 institution accounts and utility accounts (e.g. for electricity).**Identifying a Target Account**Two methods are provided for identifying an account, the single identifier method and the multiple identifiers method.Single Identifier Method:- In the scenario where one identifier suffices to uniquely identify an account, the following path is to be used: **/accounts/{identifierType}/{identifier}**.Multiple Identifiers Method:- Where a single identifier is not sufficient to identify an account, the following path is to be used: ' **/accounts/{accountIdentifier1}@{value1}${accountIdentifier2}@{value2}${accountIdentifier3}@{value3}**'. The list of permitted account identifiers supported by the Mobile Money API can be found in the API documentation. As there can be multiple identifiers required to identify the target account, the path uses a '$' delimiter to separate each identifier, up to a limit of three account identifiers.
GSMA Accounts API is one of 31 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Account. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes
19 operations
across 17 paths,
and defines 87 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.
The identity and technical contract details declared by the specification.
postalAddress
object
7 properties
1 required
remittancePurpose
string
Field providing a description of the reason for the international remittance.
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…
identityResponseArray
array
An array containing the details of each identity associated with an account.
contactPhone
string
Contact phone number (mobile or landline) of the KYC subject.
geoCode
string
Indicates the geographic location from where the transaction was initiated.
requestingLei
string
Legal Entity Identifier of the organisation that is requesting the transaction.
gender
string
Gender of the KYC subject.
dateCreated
string
Date and time when the object was created by the API Provider.
lei
string
Legal Entity Identifier.
emailAddress
string
Email address of the KYC subject.
accountRelationship
string
Describes the relationship that the identity holds with the account.
kycLevel
integer
Indicates the KYC level that the identity is associated with.
kycVerificationEntity
string
Indicates the entity (e.g. mobile money agent) that has verified the KYC of the identity.
unclearedBalance
Indicates the sum of uncleared funds in an account, i.e. the funds that are awaiting a credit confirmation.
transactionReference
string
Unique reference for the transaction. This is returned in the response by API provider.
commissionEarnedArray
array
Returns all commission earned by the registering entity for the creation of the account.
subjectName
object
6 properties
party
object
2 properties
2 required
availableBalance
Indicates the balance that is able to be debited for an account. This balance is only provided on some API provider systems.
originalTransactionReference
string
For reversals and refunds, this field indicates the transaction which is the subject of the reversal.
occupation
string
Occupation of the KYC subject.
idDocument
object
8 properties
1 required
errorObject
object
5 properties
2 required
transactionReceipt
string
Transaction receipt number as notified to the parties. This may differ from the Transaction Reference.
creditPartyArray
array
A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier.
accountStatus
string
Indicates a harmonised representation of the account status. This will be shown as available, unavailable or unregistered.
accountSubStatus
string
Field can be used to return a provider-specific status for the account.
requestGenericPatch
object
3 properties
3 required
identityType
string
Indicates the type of the identity. Currently, only ‘individual’ is supported.
internationalTransferInformationResponse
object
10 properties
1 required
receivingLei
string
Legal Entity Identifier of the organisation that is receiving the transaction.
quotationReference
string
Reference for the quotation that was provided to the sender.
responseStatementEntries
object
15 properties
6 required
responseAccountName
object
2 properties
type
string
The harmonised Transaction Type.
identityStatus
string
A unique id for the identity as assigned 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.
subStatus
string
Can be used to return a provider-specific status for the account.
responseTransaction
object
29 properties
7 required
identityId
string
A unique id for the identity as assigned by the API Provider.
metadata
object
2 properties
2 required
feesArray
array
Returns all fees that are applicable to the object.
genericUpdateSuccess
object
1 property
1 required
relationshipSender
string
Indicates the relationship (if any) between the sender and the receiver.
responseAccount
object
17 properties
3 required
recipientBlockingReason
string
The reason for blocking the quotation, based on AML checks on the recipient.
requestGenericPatchArray
array
Collection of updates that are to be processed.
idDocumentArray
array
An array of properties containing the forms of identification that are associated with the subject.
modificationDate
string
Date and time when the object was modified by the API Provider.
kycVerificationStatus
string
Indicates the status of the identity’s KYC verification.
requestingOrganisationTransactionReference
string
A reference provided by the requesting organisation that is to be associated with the transaction.
employerName
string
Employer name of the KYC subject.
registeringEntity
string
The entity that registered the account, for example, a mobile money agent.
dateModified
string
Date and time when the object was modified by the API Provider.
debitPartyArray
array
A collection of key/value pairs that enable the party to be identified. Keys include MSISDN and Wallet Identifier.
fees
object
3 properties
3 required
commissionEarned
object
3 properties
3 required
currentBalance
Current outstanding balance on the account.
requestAccount
object
7 properties
1 required
identityRequest
object
6 properties
2 required
senderBlockingReason
string
The reason for blocking the quotation, based on AML checks on the sender.
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…
responseAccountStatus
object
3 properties
1 required
quoteId
string
The specific quote associated with the quotation.
accountType
string
A non-harmonised field that indicates the type of the account.
metadataArray
array
A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource.
requestingOrganisation
object
An object that details the originating organisation of the request.
2 properties
2 required
identityResponse
object
9 properties
4 required
customDataArray
array
A collection of key/value pairs. These can be used to populate provider specific fields.
servicingIdentity
string
The field is used to identify the servicing identity for transactions, e.g. till, POS ID, assistant ID.
requestStateObject
object
8 properties
3 required
transactionStatus
string
Indicates the status of the transaction as stored by the API provider.
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…
identityRequestArray
array
An array containing the details of each identity associated with an account.
creationDate
string
Date and time when the object was created by the API Provider.
accountIdentifiersArray
array
A collection of key/value pairs that enable the account to be identified. Keys include MSISDN and Wallet Identifier.
dateOfBirth
string
Birth date of the KYC subject.
responseAccountBalance
object
6 properties
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.
customData
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GSMA publishes across the network.
