GSMA Transactions API is one of 31 APIs that GSMA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes
10 operations
across 8 paths,
and defines 85 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.
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.
completedCount
number
Indicates the number of records that have been successful completed.
gender
string
Gender of the KYC subject.
dateCreated
string
Date and time when the object was created by the API Provider.
scheduledStartDate
string
If the batch has been scheduled, the expected start time is provided here.
emailAddress
string
Email address of the KYC subject.
batchTitle
string
Client-provided title for the batch.
rejectionCount
number
Indicates the number of records that have been rejected, either during parsing or during final processing.
completionDate
string
Indicates when the batch was completed as recorded by the API.
transactionCompletedDate
string
Date and time indicating when the transaction was completed.
completedDate
string
Indicates when the batch was completed as recorded by the API.
transactionReference
string
Unique reference for the transaction. This is returned in the response by API provider.
typeReversal
string
The harmonised Transaction Type.
subjectName
object
6 properties
internationalTransferInformation
object
A collection of properties detailing information specifically used for international transfers.
8 properties
1 required
party
object
2 properties
2 required
originalTransactionReference
string
For reversals and refunds, this field indicates the transaction which is the subject of the reversal.
errorObject
object
5 properties
2 required
occupation
string
Occupation of the KYC subject.
idDocument
object
8 properties
1 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.
requestGenericPatch
object
3 properties
3 required
transactionCompletionDate
string
Date and time indicating when the transaction was completed.
responseBatchTransactionRejection
object
8 properties
4 required
rejectionDate
string
Date and time of the rejection.
internationalTransferInformationResponse
object
10 properties
1 required
quotationReference
string
Reference for the quotation that was provided to the sender.
receivingLei
string
Legal Entity Identifier of the organisation that is receiving the transaction.
link
string
Provides a URL to the resource.
type
string
The harmonised Transaction Type.
batchDescription
string
Client-provided description of the batch.
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.
responseBatchTransaction
object
17 properties
4 required
requestTransaction
object
22 properties
5 required
responseTransaction
object
29 properties
7 required
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.
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.
parsingSuccessCount
number
Indicates the number of records that have been parsed successfully.
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.
requestBatchTransaction
object
9 properties
1 required
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.
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
approvalDate
string
Indicates when the batch was approved as recorded by the API.
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…
requestReversal
object
17 properties
1 required
quoteId
string
The specific quote associated with the quotation.
responseBatchTransactionCompletion
object
8 properties
5 required
metadataArray
array
A collection of key/value pairs. These can be used to populate additional properties that describe administrative information regarding the resource.
processingFlag
boolean
Indicates whether the batch is currently undergoing processing by the API Provider.
requestingOrganisation
object
An object that details the originating organisation of the request.
2 properties
2 required
rejectionReason
string
The reason for the transaction request as indicated by the API provider.
responseReversal
object
25 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.
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.
requestStateObject
object
8 properties
3 required
dateRejected
string
Date and time of the rejection.
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…
creationDate
string
Date and time when the object was created by the API Provider.
dateOfBirth
string
Birth date of the KYC subject.
customData
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GSMA publishes across the network.
