SDP Solution API Reference (MobileMoney)

Change History
Changes between document issues are cumulative. The latest document issue contains all the changes
made in earlier issues.

Issue 33 (2016-09-22)
This issue is the 33th official release, and includes the following changes:
Delete the version field definition in 2.2.6 getaccountholderidentification and 2.2.7 getaccountholderinfo.

Issue 32 (2016-09-21)
This issue is the 32th official release, and includes the following changes:
Update the flow image description in 2.3.4 cancelpreapproval.

Issue 31 (2016-08-29)
This issue is the thirty-first official release, and includes the following changes:
Update the error code in 2.7 API Error Response.

Issue 30 (2016-08-25)
This issue is the thirty official release, and includes the following changes:
Add a new API named getaccountholderinfo in 2.2.7 getaccountholderinfo as per MTNSDP-DB-0184A.

Issue 29 (2016-08-25)
This issue is the twenty-ninth official release, and includes the following changes:
Update the error code in 1.2.5 Error Codes for RequestPayment and 1.4.5 Error Codes for
DepositMobileMoney.

Issue 28 (2016-03-03)
This issue is the twenty-eighth official release, and includes the following changes:
Add a new API named getaccountholderidentification as per MTNSDP-DB-0300.

Issue 27 (2016-02-29)
This issue is the twenty-seventh official release, and includes the following changes:
Add new parameter named CurrCode in 1.2.3 Request for RequestPayment as per MTNSDP-CR-0317.
Add new parameter named CurrCode in 1.3.3 Request for ConfirmThirdPartyPayment as per
MTNSDP-CR-0317.
Add new parameter named CurrCode in 1.4.3 Request for DepositMobileMoney as per MTNSDP-CR-0317.
Add new parameter named CurrCode in 1.5.4 Response for QueryThirdPartyAccount as per
MTNSDP-CR-0317.

Issue 26 (2015-12-28)
This issue is the twenty-sixth official release, and includes the following changes:
Add new parameter named profilename in 2.6.3 validatePayee response as per MTNSDP-CR-0231A.

Issue 25 (2015-12-18)
This issue is the twenty-fifth official release, and includes the following changes:
Modify Cookie definition in the MT HTTP Header for HTTP APIs.

Issue 24 (2015-11-20)
This issue is the twenty-fourth official release, and includes the following changes:
Change History
Password encryption algorithm supports SHA256.

Issue 23 (2015-09-29)
This issue is the twenty-third official release, and includes the following changes:
Add the validatePayee API to 2.6.3 validatePayee.

Issue 22 (2015-06-18)
This issue is the twenty-second official release, and includes the following changes:
Optimize the process for RequestPayment.
Add the following APIs to 2 HTTP APIs:
cancelpreapproval
getTransactionhistory
queryBalance

Issue 21 (2015-04-30)
This issue is the twenty-first official release, and includes the following changes:
Optimize the process for preapproval, getPreApprovalStatus and preapprovalcompleted.

Issue 20 (2015-01-12)
This issue is the twentieth official release, and includes the following changes:
Change the examples for the following APIs:
Response example for validateaccountholder
Request and response examples for getfinancialresourceinformation
Request and response examples for verifyfinancialresourceinformation
Response example for preapproval
Request and response examples for getPreApprovalStatus
Request and response examples for preapprovalcompleted
Request and response examples for Paymentcompleted
Request and response examples for gettransactionstatus
Request and response examples for reversetransaction
Request and response examples for getreversetransactiondetails
Request and response examples for withdraw
Request and response examples for startbatchtransfer
Request and response examples for approvebatchtransfer
Request and response examples for cancelbatchtransfer
Request and response examples for listbatchtransfer
Request and response examples for getbatchtransfer

Issue 19 (2014-10-31)
This issue is the nineteenth official release, and includes the following changes:
Add the chapter 1.6 APIs for notifying requestPaymentCompleted for requestPaymentCompleted API.
Change History
Issue 18 (2014-09-30)
This issue is the eighteenth official release, and includes the following changes:
Add one error code 1000 in the RequestPayment for Phase3.3.
Add the description of destPartnerId.
Add the chapter of MO Message Header for A2A Scenario.
Change the Level of Requirement of the SenderID to Optional.
Delete the CurrCode field for requestPaymentRequest, ConfirmThirdPartyPaymentRequest,
depositMobileMoneyRequest and QueryThirdPartyAccountResponse.

Issue 17 (2014-05-04)
This issue is the seventeenth official release, and includes the following changes:
Update the type of the serviceId field in the RequestPayment, DepositMobileMoney,
ConfirmThirdpartyPayment, and QueryThirdPaytyAccount request.
Change the description of serviceId and bundleID.

Issue 16 (2014-04-23)
This issue is the sixteenth official release, and includes the following changes:
Update the description and the example of serviceId field in the RequestPayment, DepositMobileMoney,
ConfirmThirdpartyPayment, and QueryThirdPaytyAccount request.

Issue 15 (2014-04-09)
This issue is the fifteenth official release, and includes the following changes:
Update the description of StatusDesc field.

Issue 14 (2014-03-27)
This issue is the fourteenth official release, and includes the following changes:
Modify the "fee deduction" to "bill payment".
Modify the description of Narration field in DepositMoney interface.
Add a note in the description of Cookie field.

Issue 13 (2014-03-19)
This issue is the thirteenth official release, and includes the following changes for Phase3.1:
Add the MerchantName field in the ConfirmThirdPartyPayment request.

Issue 12 (2014-03-10)
This issue is the twelfth official release, and includes the following changes for Phase2.3:
Delete the PrefLang field in the QueryThirdPartyAccount request.
Update the process flow for Paymentcompleted API.

Issue 11 (2014-02-12)
This issue is the eleventh official release, and includes the following changes for Phase2.2&Phase2.3:
Update the process flow for http APIs.
Update the chapter structure of http APIs.

Issue 10 (2013-12-17)
This issue is the tenth official release, and includes the following changes for phase2.2&phase2.3:
Change History
Delete the SenderID field in the RequestPayment request, delete the CurrCode field in the
DepositMobileMoney request, and update the Level of Requirement of the OpCoID in the
DepositMobileMoney response.
Update the error codes for RequestPayment and DepositMobileMoney interface.

Issue 09 (2013-12-13)
This issue is the ninth official release, and includes the following changes for phase2.3:
Delete the signature field in the HTTP message head.

Issue 08 (2013-12-06)
This issue is the eighth official release, and includes the following changes for phase2.2&2.3:
Add the API process for ECW.

Issue 07 (2013-12-03)
This issue is the seventh official release, and includes the following changes for phase2.2&2.3:
Update the 1.5 API Error Responses.

Issue 06 (2013-11-26)
This issue is the sixth official release, and includes the following changes for phase2.3.
Remove and add 1.2, 1.3, 1.4 chapter.

Issue 05 (2013-11-04)
This issue is the fifth official release, and includes the following changes for phase2.3:
Change DepositMobileMoney and RequestPayment as the HTTP interfaces.
Add 14 HTTP interfaces such as Paymentcompleted to 2 HTTP APIs.

Issue 04 (2013-10-12)
This issue is the fourth official release, and includes the following changes:
Add the error codes of ConfirmThirdPartyPayment and QueryThirdPartyAccount interfaces.

Issue 03 (2013-09-22)
This issue is the third official release, and includes the following changes:
Change the format from the Huawei style to MTN style.

Issue 02 (2013-09-11)
This issue is the second official release, and includes the following changes:
Modified Atomic Charging Unit of Cameroon, Cote D'Ivoire, Rwanda and Uganda in 6.1 The Currency and
Atomic Charging Unit of each OpCo country for Phase2.2.

Issue 01 (2013-09-06)
This issue is the first official release.
 Contents

1 SOAP APIs 1
1.1 Overviews 1
1.1.1 API Functions 1
1.1.2 Level of Requirement for Parameters 2
1.1.3 Request Format 2
1.1.4 Response Format 3
1.1.5 Namespaces 4
1.2 Bill Payment API Initiated by Partner 5
1.2.1 Process 5
1.2.2 RequestPayment 9
1.2.3 Request for RequestPayment 9
1.2.4 Response for RequestPayment 16
1.2.5 Error Codes for RequestPayment 18
1.3 Bill Payment API Initiated by Subscriber 35
1.3.1 Process 35
1.3.2 ConfirmThirdPartyPayment 36
1.3.3 Request for ConfirmThirdPartyPayment 36
1.3.4 Response for ConfirmThirdPartyPayment 41
1.3.5 Error Codes for ConfirmThirdPartyPayment 43
1.4 Deposit APIs 45
1.4.1 Process 45
1.4.2 DepositMobileMoney 45
1.4.3 Request for DepositMobileMoney 46
1.4.4 Response for DepositMobileMoney 54
1.4.5 Error Codes for DepositMobileMoney 57
1.5 APIs for Querying Subscriber Account Balances 74
1.5.1 Process 74
1.5.2 QueryThirdPartyAccount 75
1.5.3 Request for QueryThirdPartyAccount 75
1.5.4 Response for QueryThirdPartyAccount 78
1.5.5 Error Codes for QueryThirdPartyAccount 81
1.6 APIs for notifying requestPaymentCompleted 82
1.6.1 Process 82
1.6.2 requestPaymentCompleted 83
1.6.3 Request for requestPaymentCompleted 83
1.6.4 Response for requestPaymentCompleted 85
1.6.5 Error Codes for requestPaymentCompleted 86
1.7 API Error Responses 87
2 HTTP APIs 89
2.1 Overviews 89
2.1.1 MT Message Header 89
2.1.2 MO Message Header 94
2.1.3 MO Message Header for A2A Scenario 99
 Contents
2.2 Account Validation & Information 101
2.2.1 login 101
2.2.2 Logout 103
2.2.3 validateaccountholder 105
2.2.4 getfinancialresourceinformation 107
2.2.5 verifyfinancialresourceinformation 109
2.2.6 getaccountholderidentification 112
2.2.7 getaccountholderinfo 115
2.3 Approval 118
2.3.1 preapproval 118
2.3.2 getPreApprovalStatus 120
2.3.3 preapprovalcompleted 123
2.3.4 cancelpreapproval 126
2.4 Transaction Details 128
2.4.1 Paymentcompleted 128
2.4.2 gettransactionstatus 131
2.4.3 reversetransaction 134
2.4.4 getreversetransactiondetails 138
2.4.5 withdraw 140
2.5 Batch Processing 144
2.5.1 startbatchtransfer 144
2.5.2 approvebatchtransfer 148
2.5.3 cancelbatchtransfer 150
2.5.4 listbatchtransfer 152
2.5.5 getbatchtransfer 158
2.6 Financial 161
2.6.1 getTransactionhistory 161
2.6.2 queryBalance 177
2.6.3 validatePayee 179
2.7 API Error Response 184
3 Appendix 212
3.1 The Currency and Atomic Charging Unit of each OpCo country 212
3.2 ISO 4217 Codes for the representation of currencies and funds 213
3.3 OpCoID List 214
1 SOAP APIs

SOAP APIs
1.1 Overviews
1.1.1 API Functions
01
The SDP provides Mobile Money capability application programming interfaces (APIs) for third-party
applications (App for short) to connect to it and use its Mobile Money capability for Bill Payment, Depositing
Money in Subscribers account & Querying Subscriber's account in a third party system. The App is generally
developed by various partners of the SDP.

Partners are the enterprises and individuals who sign a contract and cooperate with carriers in utilizing the SDP.
Partners include service Partners, Developers, and API Partners. In this document, partners are mainly the service
Partners, Developers, and API Partners who use APIs for secondary development.
Table 1-1 describes functions of Mobile Money capability APIs provided by the SDP.
Table 1-1 Functions of Mobile Money capability APIs

Function Description API

Bill Payment API Bill payment initiated by Partner: The App initiates the 1.2.2
requestPayment API to debit mobile money from subscribers RequestPayment
mobile money account.
Ex : Utility Payments, Recurrent Payments etc
Bill payment initiated by Subscriber: The subscriber through 1.3.2
ECW initiates the ConfirmThirdPartyPayment API to pay their ConfirmThirdParty
Bill on third party system. Payment
Ex : School Payment, Bill Payment etc

Deposit The App initiates the depositMobileMoney API to deposit 1.4.2

mobile money in Subscriber s mobile money account. DepositMobileMon
ey
Ex : Cash Deposit
QueryingSubscriberaccou The SDP initiates the QueryThirdPartyAccount API to query 1.5.2
nt balance balance of a subscriber account on third party system. QueryThirdPartyA
Ex: check Outstanding Amount etc ccount

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 1
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

1.1.2 Level of Requirement for Parameters

The App must develop APIs based on the level of requirement for each parameter.
Table 1-2 Level of requirement for parameters

Type Description

Mandatory A parameter is always mandatory in a request.

Parameters with the Mandatory requirement are used for access authentication
or service processing. If a parameter with the Mandatory requirement is left
empty in a request, access authentication or service processing fails and the
request fails.

Conditional A parameter is mandatory or optional in specified conditions.

Parameters with the Conditional requirement are used for access authentication
or service processing in specified conditions. If the specified conditions is met but
a parameter with the Conditional requirement is left empty in a request, access
authentication or service processing fails and the request fails.

Optional A parameter is always optional.

Parameters with the Optional requirement are not used for service processing.

1.1.3 Request Format

The SDP provides the SOAP request in the following format:
<soapenv:Envelope>
<soapenv:Header>
<parameter></parameter>

</soapenv:Header>
<soapenv:Body>
<parameter></parameter>

</soapenv:Body>
</soapenv:Envelope>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 2
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-3 Request format

Element Description

<soapenv:Envelope> Root element in a request, which specifies the namespace.

<soapenv:Header> Request header.

Parameters in this element are defined by the SDP and are mainly information to
be processed by the SDP services, including access authentication parameters.

<soapenv:Body> Request body.

Parameters in this element comply with the SOAP protocol.

1.1.4 Response Format

Success Response Format

The SDP provides the SOAP API success responses in the following format:
<soapenv:Envelope>
<soapenv:Body>
<parameter></parameter>

</soapenv:Body>
</soapenv:Envelope>

Table 1-4 Success response format

Element Description

<soapenv:Envelope> Root element in a success response, which specifies the namespace.

<soapenv:Body> Success response body.

Parameters in this element comply with the SOAP protocol.

Error Response Format

The SDP provides the SOAP API error responses in the following format:
<soapenv:Envelope>
<soapenv:Body>
<soapenv:Fault>
<parameter></parameter>

<detail>
<parameter></parameter>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 3
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>

Table 1-5 Error response format

Element Description

<soapenv:Envelope> Root element in an error response, which specifies the namespace.

<soapenv:Body> Error response body, contains the <soapenv:Fault> and <detail> elements. This
element specifies the error code and error details.
<soapenv:Fault> Error code and description.
For details about error responses, see 1.7 API Error Responses.

<detail> Error details, which are the same as the <soapenv:Fault> element information.

1.1.5 Namespaces
When coding API functions, partners must follow the namespaces of Mobile Money capability APIs and data
types in the APIs.
Table 1-6 describes namespaces of Mobile Money capability APIs.
The namespace of data types in Mobile Money capability APIs is http://www.w3.org/2001/XMLSchema.

The Mobile Money capability APIs involve the following data types: Parameter[0..20], and Return[0..20]. For details
about the structure of the data types, see the parameter description for the matching API requests or responses.

Table 1-6 Namespaces of Mobile Money capability APIs

Namespace API

http://schemas.xmlsoap.org/soap/encoding/ 1.2.2 RequestPayment

http://schemas.xmlsoap.org/wsdl/ 1.3.2 ConfirmThirdPartyPayment
http://schemas.xmlsoap.org/wsdl/soap/ 1.4.2 DepositMobileMoney
http://b2b.mobilemoney.mtn.zm_v1.0/ 1.5.2 QueryThirdPartyAccount

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 4
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

1.2 Bill Payment API Initiated by Partner

1.2.1 Process
Figure 1-1 shows the synchronous process of bill payment for ECW.
Figure 1-1 Synchronous Process of bill payment for ECW

Table 1-7 describes the synchronous process for ECW.

Table 1-7 Description for the synchronous process of bill payment for ECW

Step Description

1 The App sends bill payment request to debit mobile money from subscribers account to SDP.

2 The SDP performs authentication and service level agreement (SLA) control based on fields in
the request.
The SDP sends response to the App.

Figure 1-2 shows the asynchronous process of bill payment for ECW.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 5
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Figure 1-2 Asynchronous Process of bill payment for ECW

Table 1-8 describes the asynchronous process for ECW.

Table 1-8 Description for the asynchronous process of bill payment for ECW

Step Description

1 The App sends bill payment request to debit mobile money from subscribers account to SDP.

2 The SDP performs authentication and service level agreement (SLA) control based on fields
in the request.
The SDP sends response to the App.
3 The SDP sends requestPaymentCompleted request to inform the App the result of the
requestPayment in case asynchronism requestPayment.
4 The APP processes the requestPaymentCompleted request and sends a response to the SDP.

Figure 1-3 shows the synchronous process of bill payment for Fundamo.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 6
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Figure 1-3 Synchronous Process of bill payment for Fundamo

Table 1-9 describes the synchronous process for Fundamo.

Table 1-9 Description for the synchronous process of bill payment for Fundamo

Step Description

1 The App sends bill payment request to the SDP.

2 The SDP performs authentication and service level agreement (SLA) control
based on fields in the request.
The SDP sends bill payment confirmation request to the App.

3 The App sends a bill payment confirmation response to the SDP.

4 The SDP sends a bill payment response to the App.

Figure 1-4 shows the asynchronous process of bill payment for Fundamo.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 7
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Figure 1-4 Asynchronous Process of bill payment for Fundamo

Table 1-10 describes the asynchronous process for Fundamo.

Table 1-10 Description for the asynchronous process of bill payment for Fundamo

Step Description

1 The App sends bill payment request to the SDP.

2 The SDP performs authentication and service level agreement (SLA) control based on fields in
the request.
The SDP sends a bill payment response to the App.

3 The SDP sends bill payment confirmation request to the App.

4 The App sends a bill payment confirmation response to the SDP.

5 The SDP sends requestPaymentCompleted request to inform the App the result of the
requestPayment in case asynchronism requestPayment.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 8
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Step Description

6 The APP processes the requestPaymentCompleted request and sends a response to the SDP.

1.2.2 RequestPayment

Function
The App (functioning as the client) invokes the requestPayment API to debit mobile money from subscribers
account.
Partners must code the App based on the API field requirements so that the App can send correct requests to
the SDP. The SDP must send a response within 180 seconds by default in synchronous process, or 30
seconds by default in asynchronous process.

Request URI
The request URI is the destination URI of requestPayment messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/ThirdPartyServiceUMMImpl/UMMServiceService/RequestPayment/v17
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

1.2.3 Request for RequestPayment

The App functions as the client and sends a requestPaymentRequest message to the SDP for bill payment.

Example
POST /ThirdPartyServiceUMMImpl/UMMServiceService/RequestPayment/v17 HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:b2b="http://b2b.mobilemoney.mtn.zm_v1.0">
<soapenv:Header>
<RequestSOAPHeader xmlns="http://www.huawei.com.cn/schema/common/v2_1">
<spId>35000001</spId>
<spPassword>de96d901b3bad1db2aab76b7b0b202f2</spPassword>
<bundleID>256000039</bundleID>
<serviceId>35000001000035</serviceId>
<timeStamp>20100727</timeStamp>
</RequestSOAPHeader>
</soapenv:Header>
<soapenv:Body>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 9
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<b2b:processRequest>
<serviceId>200</serviceId>
<parameter>
<name>DueAmount</name>
<value>10</value>
</parameter>
<parameter>
<name>MSISDNNum</name>
<value>13132132000</value>
</parameter>
<parameter>
<name>ProcessingNumber</name>
<value>555</value>
</parameter>
<parameter>
<name>serviceId</name>
<value>200</value>
</parameter>
<parameter>
<name>AcctRef</name>
<value>112233</value>
</parameter>
<parameter>
<name>AcctBalance</name>
<value>555</value>
</parameter>
<parameter>
<name>MinDueAmount</name>
<value>121212</value>
</parameter>
<parameter>
<name>Narration</name>
<value>121212</value>
</parameter>
<parameter>
<name>PrefLang</name>
<value>121212121</value>
</parameter>
<parameter>
<name>OpCoID</name>
<value>0</value>
</parameter>
<parameter>
<name>CurrCode</name>
<value>USD</value>
</parameter>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 10
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

</b2b:processRequest>
</soapenv:Body>
</soapenv:Envelope>

Message HTTP Header Parameters

Table 1-11 Describes parameters in a requestPaymentRequest message HTTP header.
Table 1-11 Parameters in a requestPaymentRequest message HTTP header

Header Paramet Type Length Level of Description

Field er Requirement

Cookie sessioni String - Conditional The session id is used as a cookie in the HTTP header
d in the requests towards the Mobile Money Manager
when the Partner use Login/Logout mode.
[Example]
default8fcee064690b45faa9f8f6c7e21c5e5a
NOTE
Cookie is valid only for ECW and not for fundamo.

Message SOAP Header Parameters

Table 1-12 describes parameters in a requestPaymentRequest message SOAP header.
Table 1-12 Parameters in a requestPaymentRequest message SOAP header

Parameter Type Length Level of Description

Requirement

spId xsd: string 21 Mandatory Partner ID.

The ID is automatically allocated by the SDP to
partners after successful registration. To obtain the ID:
A service Partner and API Partner can log in to the
SDP management portal and query account
information.
A Developer can log in to the Developer Portal and
query account information.
[Example]
000201

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 11
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Description

Requirement

spPassword xsd: string 100 Conditional Authentication key for the SDP to authenticate
partners.
The SDP supports authentication by SP ID +
Password, SP ID + IP address + Password, or SP
ID + IP address. Partners select an authentication
mode during registration. If a partner selects
authentication by SP ID + Password or SP ID + IP
address + Password, this parameter is mandatory in
requests sent by this partner.
The value is a character string encrypted. The
encryption formula is as follows:
SHA-256: spPassword = Base64(SHA-256(spId +
Password + timeStamp))
MD5: spPassword = MD5(spId + Password +
timeStamp)
In the formula:
spId and timeStamp: authentication ID and
timestamp.
Password: password for partners to access the
SDP.
A service Partner and API Partner can obtain
the password from the email notification
received after successful registration.
A Developer can log in to the Developer
Portal, choose Member Center > Account >
Registration Information > Invoke
Password, and set the password.

To retain features of earlier versions, the SP uses the MD5

algorithm in the connection to the SDP, which might cause
security risks.
[Example]e6434ef249df55c7a21a0b45758a39bb

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 12
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Description

Requirement

bundleID xsd: string 21 Conditional Bundle ID.

When SDP creates a capability bundle, SDP allocates
a bundleID to capability bundle.
The bundleID must not be contained during
invocation of a service interface developed by service
partners and other partners, and must be contained
during invocation of a capability interface developed
by API partners, other partners, and developers.
[Example]
256000039

serviceId xsd: string 21 Conditional Service ID.

The ID is automatically allocated by the SDP to
services after successful release. A service Partner
can log in to the SDP management portal and query
service information for the ID.
The serviceId must be contained during invocation of
a service interface developed by service partners and
other partners, and must not be contained during
invocation of a capability interface developed by API
partners, other partners, and developers.
[Example]
35000001000001

timestamp xsd: string 14 Conditional Timestamp (UTC time).

The value is used in MD5 encryption of spPassword.
This parameter is mandatory when the spPassword
parameter is required.
[Format]
yyyyMMddHHmmss
[Example]
20100731064245

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 13
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Message Body Parameters

Table 1-13 describes parameters in a requestPaymentRequest message body.
Table 1-13 Parameters in a requestPaymentRequest message body

Parameter Type Length Level of Description

Requirement

serviceId xsd: string 4 Mandatory Holds the identification number to identify the service
request.
This is set as 200.

parameter Parameter[0 - Optional Holds the request parameter details in the form of
..20] name/value pair to identify the service details.
Valid parameter names are:
DueAmount
MSISDNNum
ProcessingNumber
serviceId
AcctRef
AcctBalance
MinDueAmount
Narration
PrefLang
OpCoID
CurrCode
For the detailed parameter name information, see
Table 1-15.
The parameter parameter is of the Parameter[0..20]
type and contains multiple sub-parameters. For details
about the Parameter[0..20] type, see Table 1-14.

Table 1-14 describes the parameter structure of the Parameter[0..20] type.

Table 1-14 Parameter structure of the Parameter[0..20] type

Parameter Type Length Level of Description

Requirement

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 14
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-15 describes the parameter name lists.

Table 1-15 Parameter name lists

name value

Parameter Type Length Level of Description

Requirement

DueAmount xsd:int 4 Mandatory The amount that the subscriber is due to pay on the
App system.

MSISDNNum xsd:string 30 Mandatory An Id to uniquely identify the subscriber on the App

system.
Subscriber's MSISDN number or Fake ID.
[Format]
Mobile number: [Country code][Mobile number]
Fake ID: [Prefix]-[opcoid]-[sequence].
[Example]
Mobile number: 8612312345678
Fake ID: f-245-11900000007639
ProcessingNu xsd:string 140 Mandatory An Id to uniquely identify the transaction on the App
mber system.

serviceId xsd:string 140 Mandatory This relates to the Code configured in the Mobile
Money system. Properties file is used to uniquely
identify each service provided.

AcctRef xsd:string 140 Mandatory Subscriber's account number on the App system.
If the subscriber does not have account on the App
system, you need confirm it with the Mobile Money
system.

AcctBalance xsd:int 4 Mandatory Subscriber's balance on the App system.

If there is no subscriber's balance on the App system,
you need confirm it with the Mobile Money system.
MinDueAmou xsd:int 4 Mandatory The minimum amount that the subscriber is due to pay
nt on the App system.
If there is no minimum due on App system, you need
confirm it with the Mobile Money system.

Narration xsd:string 140 Optional Any text that the vendor would like to display to the
subscriber.
PrefLang xsd:string 140 Optional The language locale to be used.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 15
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

name value

Parameter Type Length Level of Description

Requirement

OpCoID xsd:string 140 Mandatory Identifier of the country local to be used. Please refer
to 3.3 OpCoID List.
CurrCode xsd:string 3 Optional The currency, as an ISO 4217 formatted string.

1.2.4 Response for RequestPayment

The SDP functions as the server, processes requestPaymentRequest messages received from the App, and
sends requestPaymentResponse messages to the App.
This topic provides a success response example. If a request fails, the SDP sends an error response that
contains an error code. For details about error responses, see 1.7 API Error Responses.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:processRequestResponse xmlns:ns1="http://b2b.mobilemoney.mtn.zm_v1.0">
<return>
<name>ProcessingNumber</name>
<value>555</value>
</return>
<return>
<name>ThirdPartyAcctRef</name>
<value>444</value>
</return>
<return>
<name>senderID</name>
<value>MOM</value>
</return>
<return>
<name>StatusCode</name>
<value>222</value>
</return>
<return>
<name>StatusDesc</name>
<value>333</value>
</return>
<return>
<name>MOMTransactionID</name>
<value>111</value>
</return>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 16
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

</ns1:processRequestResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-16 describes parameters in a requestPaymentResponse message body.
Table 1-16 Parameters in a requestPaymentResponse message body

Parameter Type Length Level of Description

Requirement

return Return[0..20 - Mandatory Holds the response parameter details in the form of
] name/value pair to identify the service details.
Valid parameter names are:
ProcessingNumber
ThirdPartyAcctRef
SenderID
StatusCode
StatusDesc
MOMTransactionID
For the detailed parameter name information, see
Table 1-18.
The return parameter is of the Return[0..20] type and
contains multiple sub-parameters. For details about
the Return[0..20] type, see Table 1-17.

Table 1-17 describes the parameter structure of the Return[0..20] type.

Table 1-17 Parameter structure of the Return[0..20] type

Parameter Type Length Level of Description

Requirement

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-18 describes the return name lists.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 17
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-18 Return name lists

name value

Parameter Type Length Level of Description

Requirement

ProcessingNu xsd:string 140 Optional An Id to uniquely identify the transaction on the App
mber system.

ThirdPartyAcc xsd:string 140 Mandatory Subscriber's account number on the App system.
tRef The SDP will fill this parameter as the same value
which was received from AcctRef in the request.

SenderID xsd:string 140 Optional An Id to identify sender.

This is set as MOM.

StatusCode xsd:int 2 Mandatory A predetermined code to determine the status of the

transaction.

StatusDesc xsd:string 140 Optional The Mobile Money system supplied description of the
response code.
MOMTransac xsd:string 140 Optional An Id to uniquely identify the transaction on the Mobile
tionID Money system. The SDP will forward this parameter to
the App system.

1.2.5 Error Codes for RequestPayment

Table 1-19 describes requestPayment error codes that the SDP may return upon an exception. For details
about the error codes, see the SDP Solution Error Code Reference.

Table 1-19 requestPayment error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Fundamo userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 18
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

100 General failure.

Get addr route info failed!the baseScfType = %1,the sourceAddr = %2,the destAddr = %3.
NOTE
ScfType refers to Service Capability Function Type.

MDSP AuthPrice failed, result code is %1.

NOTE
The MDSP is composed of the Mobile Data Control Center (MDCC) subsystem and peripheral functional
subsystems such as the Portal and Mobile Data Management Center (MDMC). The MDCC subsystem consists of
core modules such as the Short Message Push Agent (SMPA), Network Management System (NMS) proxy, and
BOSS interface machine. The MDSP is connected to the NMS, BOSS system, Service Control Point (SCP),
customer service center, and service gateways. The MDSP can implement the functions such as external entity
access, mobile data management, user and service authentication, and charging.

Waiting for response timed out, message type is %1.

Cannot find route policy, the policy identifier is %1.

The service status is unknown.

Service %1 is in blacklist!
The API %1 is not existed.

Service ID %1 is not exist!

The service status is suspended.

The service status is pre-deregistered.

The service status is deregistered.

The API status is disabled.

SP status is locked.

The sp's Status is forbidden.

The sp's status is pause.

The RemotePassword of NE %1 is empty!
NOTE
NE refers to network element, such as SMSC, MMSC.

NEInfo id %1 not in SAG.

NOTE
The SAG provides open interfaces for third-party partners. It authenticates and authorizes the partners, and
controls the Service Level Agreement policies when it receives third-party service requests.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 19
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

The ScfType %1 is inactive!

NOTE
ScfType refers to Service Capability Function Type.

The ScfType %1 is uninstalled!

NOTE
ScfType refers to Service Capability Function Type.

The service status is configuring.

The Created is null.

SP ip is null!

Sp password is null!

The Nonce is null.

Authentication Failed, cause by SP, because of timestamp expired.

Service ID is null!

Sp password is null!

Timestamp is empty in soapheader.

Service ID %1 is invalid!

The PasswordDigest is not accepted.

The sp's Status is pre-deregistered.

The sp's Status is deregistered.

The sp's Status is unknown.

SP %1 is in blacklist!

SPID %1 is not exist!

Sp password is not accepted!

Sp ip %1 is not accepted!

local SP password is null!

The authentication type is unknown!

Authentication Failed, cause by SP, because of timestamp is not valid.

Minimum Amount per Transaction

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 20
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

%1 is null.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

%1 is null.

103 Duplicate transaction id.

104 Authorization declined.

105 Account holder is not active.

106 Deposit Transfer not processed: Source & destination accounts are same

108 Deposit Transfer not processed: Insufficient funds

109 Deposit Transfer not processed: Daily limit has been exceeded.

110 Deposit Transfer not processed: Sender account not active

111 Deposit Transfer not processed: Target account not active

501 DATEFORMAT_INVALID

502 FRI_INVALID

503 IDENTITY_INVALID

504 INVALID_FIELD_VALUE

505 MANDATORY_FIELD_MISSING
506 OTHER_FINANCIAL_ERROR

507 PREAPPROVAL_NOT_FOUND

508 REFERENCE_ID_NOT_FOUND
509 REQUIRED_FIELD_MISSING

510 SERVICE_TEMPORARILY_UNAVAILABLE

511 SESSION_INVALID
512 TRANSACTION_ID_OR_ORIGINAL_TRANSACTION_ID_MISSING

513 TRANSACTION_NOT_COMPLETED

514 TRANSFER_TYPE_AND_ACCOUNT_DO_NOT_MATCH
515 ACCOUNTHOLDER_WITH_FRI_NOT_FOUND

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 21
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

516 ACCOUNTHOLDER_WITH_MSISDN_NOT_FOUND

517 AUTHORIZATION_INVALID_ACCOUNT_TYPE_COMBINATION

518 COULD_NOT_PERFORM_OPERATION

519 EXPIRED_OR_INVALID_TRANSACTION_ID

520 INCORRECT_PASSWORD
521 NOT_AUTHORIZED

522 AMOUNT_INVALID

523 CURRENCY_NOT_SUPPORTED

524 INVALID_CURRENCY

525 RESOURCE_NOT_ACTIVE

526 SOURCE_NOT_FOUND

527 RESOURCE_NOT_FOUND

529 TARGET_AUTHORIZATION_ERROR

530 This account is already a member of this group

531 Account could not be removed from Bank domain

532 The specified account holder's additional information name already exist

The specified account holder's additional information name cannot be deleted because it is in
533
use

534 This account holder is already a member of this group

535 AccountHolder does not exist

536 This operation requires the user to be logged in

537 AccountHolder profile does not have requested account

538 AccountHolder status should be blocked or active

539 Account not found

Could not create account route since Account route with provided account route reference and
540
currency already exists

Could not delete account route since Account route with provided account route reference and
541
currency does not exists

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 22
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

542 Account type is not supported

543 The account holder already has a connection to the specified account

544 Activation of account holder failed

545 Could not perform operation since at least one of the mandatory field is required

546 Could not perform operation since at least one of the mandatory field is required
547 Could not perform operation since at least one of the mandatory field is required

548 Could not perform operation since at least one of the mandatory field is required

549 Could not perform operation since at least one of the mandatory field is required

550 Account holder could not be found

551 Operation requires account holder to have an MSISDN identity but it has none

552 Account holder is inactive

553 A specified account holder was not a child to another specified account holder

554 Account holder could not be found

555 The settings for this account holder already exists

556 Account holder settings are mandatory

557 Account holder settings not found

Account holder could not be registered because an account holder with submitted Alias already
558
exists

Account holder could not be registered because an account holder with submitted E-mail
559
already exists

560 Account holder with given e-mail could not be found

Account holder cannot have the same employee id as another employee working under the
561
same employer

Account holder could not be registered because an account holder with submitted External ID
562
already exists
563 Account holder IMSI could not be updated because it already exists

Account holder could not be registered because an account holder with submitted MSISDN
564
already exists

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 23
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Account holder could not be registered because an account holder with submitted Username
565
already exists

566 Adjustments from account not allowed

567 Adjustments not allowed on account

568 Adjustments to account not allowed

569 No Alias with this name was found in the system

570 Could not perform operation since the resource already belongs to another Bank domain

571 The FRI refers to more than one account

572 Account holder is not allowed to perform this operation

573 Account holder is already activated

574 Insufficient amount

575 Setting an account holder as its own parent or a creating a cycle in the hierarchy is not allowed

576 Authorization failed

577 Maximum transfer account throughput amount including fee threshold exceeded

578 Maximum transfer account throughput amount including fee threshold exceeded for receiver

579 Maximum transfer account throughput amount including fee threshold exceeded for sender

580 Maximum transfer amount threshold exceeded

581 Maximum transfer amount including fee threshold exceeded

582 Maximum transfer amount including fee threshold exceeded for receiver

583 Maximum transfer amount including fee threshold exceeded for sender
584 Maximum transfer amount threshold exceeded for receiver

585 Maximum transfer amount threshold exceeded for sender

586 Maximum transfer counter threshold exceeded

587 Maximum send amount threshold exceeded

588 Authorization failed. Maximum threshold limit reached for Approver

589 Amount below minimum amount threshold

590 Amount below minimum amount threshold for account

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 24
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

591 Amount below minimum amount threshold for account reference

592 Account holder is not registered

593 Receivers account does not allow deposit

594 Could not perform operation because amount is below minimum first deposit amount threshold

595 Maximum balance threshold for receiver exceeded

596 Receivers account is not active

597 Receiving account is unavailable

598 Withdrawal from recipient account not allowed

599 Minimum balance threshold for sender exceeded

600 Sending account is unavailable

601 A bank account with given bank code and account number could not be found

602 A route to the wanted bank account could not be found

603 No bank domain set in the system.

604 Bank domain with given ID was not found

605 Could not perform operation since the Bank domain is currently in use

606 Could not perform operation since Bank domain with given name already exists

607 Account could not be blocked

608 Receiving account holder has insufficient permission to receive cashin

609 Receiving account holder has insufficient permission to receive cashout

610 Certificate already updated for the user

611 Certificate credentials already exist

612 Certificate credentials do not exist

613 Account could not be closed

614 The company information already exist

615 The company information does not exist

616 Contact was not added since it already exists

617 Contact with given FRI could not be found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 25
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

618 Could not create account holder

619 Could not perform add account operation

620 Failed to approve the operation, please retry the initial operation again

621 ATM partial reversal operation could not be performed

622 ATM redeem voucher operation could not be performed

623 ATM rollback voucher operation could not be performed

624 Could not perform the operation, the account has to be linked with sp account.

625 Receive remittance failed

626 Could not perform update of account holder settings

627 Could not perform update of pending payment status

628 The specified counter configuration does not exist.

629 The credential is not in the expected suspended state

630 Operation not allowed because credential not in active state

631 Repeated secrets does not match each other

632 Given credential type does not exist in the system

633 For this operation currency conversion is not allowed

634 Custody Account already exists

635 Custody account certificate already exist

636 Custody account certificate could not deleted

637 Custody account certificate could not be empty

638 Custody account certificate could not be used for non-repudiation

639 Custody account certificate does not exist

640 Custody account certificate error

641 Unsupported algorithm for custody account certificate

642 Custody account certificate with same id already exist

643 Name and Bank Domain are same as before

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 26
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Could not find CustodyAccount since Custody Account with provided account number and bank
644
code does not exists

645 Custody account still contains money

646 This Custody account still have pending transaction

647 Could not update custody account as name and bank domain both are missing

648 Account holder and account must belong to the same bank domain

649 The document does not exist

650 The document rules has been incorrectly configured in the system

651 This document URL is invalid

652 This document URL is not allowed

653 End date can not occur in the future

654 This error originates from an external system

655 External service provider with given User name could not be found

656 Netting report error

657 Financial Configuration does not exist

Neither transaction with transaction ID nor original transaction with original transaction ID could
658
be found

659 Using first name in password is not allowed

660 The specified float transfer exemption rule already exists

661 Setting multiple owners of an FRI is not allowed

662 FRI Reference not found.

663 Operation requires that start date has to occur before end date

664 Could not perform operation since the Group is already used by another Bank domain

665 Group member could not be removed from group

666 Group member could not be removed from Bank domain

667 Group member with given ID could not be found in this group

668 Group used by Bank domain is not allowed to be removed

669 It's not possible to mirror a High Contention account in SDP since it doesn't have a balance.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 27
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

670 Home charging region with given ID was not found

671 Could not perform operation since the home charging region is currently in use

672 Could not perform operation since Home Charging Region with given name already exists

673 Length of identification is not within length boundaries

674 Duplicate identification

675 ID type not supported by ISO 20022

676 The credential status change is illegal

677 Format of IMSI is invalid

678 Inactive receiver account

679 Incorrect pin code

680 Security answer was not correct

681 Transaction state is incorrect for this operation

682 An internal error caused the operation to fail

683 Could not find Internal Loan Account with given Id

684 Amount Min cannot be larger than Amount Max

685 The state of this Internal Loan Application is not valid for this operation

686 Could not find Internal Loan Application

687 Maximum number of Internal Loan Applications reached

688 Internal Loan Product already exist

689 The Internal Loan Product status is not active

690 The given Internal Loan Product is not allowed to be used

691 Could not find Internal Loan Product with given identity and product code

692 Internal Loan Provider already exist

693 Could not find Internal Loan Provider with given identity

694 The FRI must be of account type

695 The specified account holder's additional information name is not valid or does not exist
696 Account holder settings are invalid

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 28
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

697 Approval transaction has invalid state

698 Invalid ATM operation

699 Certificate is invalid

700 Invalid Delivery method

701 Profile validation

702 Profile counter validation

703 Profile name validation

704 Profile threshold validation

705 Invalid receiving end user

706 Incorrect remittance status

707 A transaction can only be scheduled from a future date

708 Invalid scheduled transaction status for the requested operation

709 Settlement deposit with given ID could not be found

710 Settlement with given ID could not be found

711 The provided signature is not correct

712 Current status is not as expected

713 Invalid Transaction type

714 Invalid User (or financial) approval type or not registered

715 Bank domain could not be removed since it is the last remaining

716 Limited retries are not allowed for the specified service provider
717 Could not find Loan Application with given approval ID

718 Could not find Loan Provider with given name

719 Reached limit for max accounts

720 Maximum number of contacts threshold exceeded

721 Maximum number of documents exceeded

722 Actor MSISDN is missing

723 Exchange rate for conversion between currencies does not exist.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 29
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

724 More than one of a set of optional but mutual parameters were set.

725 Given msisdn alread used by a point of sale

726 User has no access permission

727 Using non ASCII characters in password is not allowed

728 Non-digit characters in pin code

729 It is not allowed to change bank domain for an account holder

730 One custody account must exist

731 Only one refund per debit is allowed

732 Operation not supported on external account

733 Operation not supported on a migrated account

734 Request did not contain any OTP

735 Request did not contain any OTP

736 Request did not contain any OTP

737 Format of OTP is invalid

738 OTP not found, has expired or is used for the wrong operation

739 Password has already been used before

740 Password too short

741 Could not find Pending Commission

742 Pickup with given MTCN could not be found

743 PIN code has already been used

744 PIN code denied by matching birth date

745 PIN code denied by matching identification number

746 PIN code denied by matching MSISDN

747 PIN code denied by matching regular expression

748 Wrong profile

749 Pin code too long

750 Pin code too short

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 30
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

751 The point of sale with given msisdn is not acquired.

752 No pre-approvals found

753 Profile name validation

754 Json File validation

A profile mismatch between for example a provided counter configuration (belonging to one
755
profile) and provided profile reference (having a different profile)

756 Profile not found

757 Profile type validation

758 Profile version validation

759 Profile version validation

760 Tag was not found

761 Provider Category can not be deleted as it is linked with account holder

762 No provider category with this name was found in the system

763 Request is queued for approval

764 Quote has already been used

765 Quote has expired

766 Quote not found

767 Quote is not supported with the combination of parameters

768 Quote is already processing

769 Account could not be re-activated

770 Failed to process reconciliation file.

771 Recurring scheduled transaction can only be scheduled a limited number of days into the future

772 Refund amount cannot be larger than the debit amount

773 The relative does not exist

774 Remittance Id does not exist in dbase

775 Remittance not found, Invalid provider name or remittance id

776 Remittance not possible because given data is invalid.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 31
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

777 Password criteria configuration invalid

778 FRI not available

779 Required resource is temporarily locked

780 Reversal has already been performed on this transaction

781 Reversal is not allowed on this type of transaction

782 Reversal not possible since sub transaction is invalid

783 Using reversed user id in password is not allowed

784 Transaction could not be performed since neither of the parties supports rollback

785 Transaction can only be scheduled a limited number of days into the future

786 The requested scheduled transaction could not be found

787 This self service notification aready exists.

788 The notification limit exceeds the hard limit

789 Self service notificaiton not found.

790 Max number of self serviced notifications reached, cannot create another.

791 The response amount does not match with the amount in the Payment Instruction

792 Another settlement task is ongoing.

Balance reconcilation failed. Provided closing balance does not match with the expected closing
793
balance of custody account

794 Certificate does not exist for custody account not able to verify signature of settlement file

795 Custody account already exists with settlement configuration

796 Could not find settlement Configuration for custody account

797 Settlement configuration for identifier already exists

798 Instruction formatter class not found

799 Settlement configuration not found

800 Settlement parser class not found

801 Unable to remove custody account id from settlement configuration

802 Currency does not match with custody account's currency.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 32
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

803 Settlement process failed because the custody accounts information do not match.

804 The deposit has already been reversed.

805 The deposit is in an invalid state.

806 The deposit was not found.

807 The transaction details of the deposit where not found.

808 Duplicated deposit or reverse deposit record found.

809 Digest does not exist or digest verification failed for settlement file

810 Error in parsing settlement file

811 Signature does not exist or signature verification failed for settlement file

812 Payment Instruction Response caller identifier mismatch

813 Settlement identifier not found

814 Invalid or no amount in Payment Instruction Response.

Settlement error due to invalid receiver.There is no such account holder or custody account
815
exists.

816 Settlement is in wrong state

817 Online settlement not enabled for custody account

818 Opening Balance reconcilation failed

819 Wrong state for Settlement PaymentInstruction.

820 Settlement PaymentInstruction not found.

821 Failed to process settlement file.

822 The receiver account does not match

823 Wrong state for Settlement CustodyAccountsTransfers.

824 Using surname in password is not allowed

825 Not possible to put account in suspended state

826 Tag could not be created because a Tag with submitted name already exists

827 Tag was not found

828 Tax report not found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 33
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

829 The specified threshold configuration does not exist.

830 Too few lower case alphabetic characters in password

831 Too few digits in password

832 Too few special characters in password

833 Too few upper case alphabetic characters in password

834 Too few upper or lower case alphabetic characters in password

835 Too many consecutive digits in PIN code

836 Too many identical consecutive characters in password

837 Too many repeated digits in PIN code

838 Transaction not found

839 Transaction timed out

840 Operation is not supported for this account

841 Account holder could not be created

842 Interest tier could not be created

843 Interest tier could not be modified

844 Interest tier could not be removed

845 Account could not be un-blocked

846 Unresolved Remittance Id does not exist in dbase

847 The maximum attempts of credential unsuspend for the given account holder has been reached

848 Using user id in password is not allowed

849 The data provided in the request failed the validation check

850 Voucher date of birth has been set

851 Voucher has expired

852 Voucher external id has been set

853 Voucher first name has been set

854 Voucher is no longer active

855 Voucher with given identity could not be found in the system

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 34
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

856 Voucher secret contains letters that has been excluded through system configuration

857 Voucher secret contains characters that is not legal according to system configuration

858 Voucher secret contains non ASCII characters

859 Voucher secret can not contain digits

860 Voucher secret is not correct

861 Voucher secret element is empty

862 Voucher secret can not contain letters

863 The voucher secret rules has been incorrectly configured in the system

864 Voucher secret is longer than system configured maximum length

865 Too many redeem voucher attempts with incorrect secret has been performed

866 Voucher secret is shorter than system configured minimum length

867 Voucher surname has been set

868 Wrong profile

869 Number of coupons allowed on the offer for the user has already been reached

870 User is not eligible for offer

871 User profile does not exist

1000 Pending

1.3 Bill Payment API Initiated by Subscriber

1.3.1 Process
Figure 1-5 shows the process of bill payment confirmation.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 35
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Figure 1-5 Process of bill payment confirmation

Table 1-20 describes the process.

Table 1-20 Description for the process of payment confirmation

Step Description

1 The SDP sends bill payment confirmation request to the App.

2 The App parses the bill payment confirmation request and sends a response to
the SDP.

1.3.2 ConfirmThirdPartyPayment

Function
The subscriber through ECW initiates the ConfirmThirdPartyPayment API to pay their Bill on third party
system.
Partners must code the App based on the API field requirements so that the App can correctly parse and
respond to requests received from the SDP. The App must send a response to the SDP within 30 seconds.

Request URI
The request URI is the destination URI of ConfirmThirdPartyPaymentRequest messages sent by the SDP to
the App. The URI is defined by the App.

1.3.3 Request for ConfirmThirdPartyPayment

The SDP functions as the client and sends a ConfirmThirdPartyPaymentRequest message to the App to
payment confirmation.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 36
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<ns1:NotifySOAPHeader xmlns:ns1="http://www.huawei.com.cn/schema/common/v2_1">
<ns1:traceUniqueID>504021505821207281129180006002</ns1:traceUniqueID>
</ns1:NotifySOAPHeader>
</soapenv:Header>
<soapenv:Body>
<ns2:processRequest xmlns:ns2="http://b2b.mobilemoney.mtn.zm_v1.0/">
<serviceId>101</serviceId>
<parameter>
<name>ProcessingNumber</name>
<value>12121212</value>
</parameter>
<parameter>
<name>senderID</name>
<value>MOM</value>
</parameter>
<parameter>
<name>AcctRef</name>
<value>112233</value>
</parameter>
<parameter>
<name>RequestAmount</name>
<value>1212</value>
</parameter>
<parameter>
<name>paymentRef</name>
<value>12121</value>
</parameter>
<parameter>
<name>ThirdPartyTransactionID</name>
<value>12112</value>
</parameter>
<parameter>
<name>MOMAcctNum</name>
<value>121212</value>
</parameter>
<parameter>
<name>CustName</name>
<value>121212</value>
</parameter>
<parameter>
<name>TXNType</name>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 37
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<value>12121</value>
</parameter>
<parameter>
<name>StatusCode</name>
<value>12121</value>
</parameter>
<parameter>
<name>OpCoID</name>
<value>0</value>
</parameter>
<parameter>
<name>MerchantName</name>
<value>dstv1</value>
</parameter>
<parameter>
<name>CurrCode</name>
<value>USD</value>
</parameter>
</ns2:processRequest>
</soapenv:Body>
</soapenv:Envelope>

Message Header Parameters

Table 1-21 describes parameters in a ConfirmThirdPartyPaymentRequest message header.
Table 1-21 Parameters in a ConfirmThirdPartyPaymentRequest message header

Parameter Type Length Level of Description

Requirement

traceUniqueI xsd:string 30 Mandatory Transaction ID.

D The ID is automatically generated by the SDP and is
used only to trace messages during the SDP
commissioning. The App ignores this parameter.
[Example]
100001200101110623021721000011

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 38
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Message Body Parameters

Table 1-22 describes parameters in a ConfirmThirdPartyPaymentRequest message body.
Table 1-22 Parameters in a ConfirmThirdPartyPaymentRequest message body

Parameter Type Length Level of Description

Requirement

serviceId xsd: string 4 Mandatory Holds the identification number to identify the service
request.
This is set as 101.

parameter Parameter[0 - Optional Holds the request parameter details in the form of
..20] name/value pair to identify the service details.
Valid parameter names are:
ProcessingNumber
SenderID
AcctRef
RequestAmount
PaymentRef
ThirdPartyTransactionID
MOMAcctNum
CustName
TXNType
StatusCode
OpCoID
MerchantName
CurrCode
For the detailed parameter name information, see
Table 1-24.
NOTE
Fields RequestAmount and PaymentRef are mandatory only
for serviceId 101.
The currency is the main currency of the country where the
OpCo node is located. The minimum current unit is used. For
the currencies and their units in the OpCo countries, see 3.1 The
Currency and Atomic Charging Unit of each OpCo country.
The parameter parameter is of the Parameter[0..20]
type and contains multiple sub-parameters. For details
about the Parameter[0..20] type, see Table 1-23.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 39
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-23 describes the parameter structure of the Parameter[0..20] type.

Table 1-23 Parameter structure of the Parameter[0..20] type

Parameter Type Length Level of Description

Requirement

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-24 describes the parameter lists.

Table 1-24 Parameter name lists

name value

Parameter Type Length Level of Description

Requirement

ProcessingNu xsd:string 140 Mandatory An Id to uniquely identify the transaction on the App
mber system.

SenderID xsd:string 140 Optional An Id to identify sender.

This is set as MOM.

AcctRef xsd:string 140 Mandatory Subscriber's account number on the App system.
If the subscriber does not have account on the App
system, you need confirm it with the Mobile Money
system.

RequestAmo xsd:int 4 Mandatory The value of the amount to be paid to the App system.
unt

PaymentRef xsd:string 140 Optional A description the subscriber provides of the payment.
The SDP will forward this parameter to the App
system.
ThirdPartyTra xsd:string 140 Optional An Id to uniquely identify the transaction on the App
nsactionID system. This parameter is left blank in this instance.
This is the ID sent by the App system in
requestPayment request ProcessingNumber
parameter.

MOMAcctNu xsd:string 140 Mandatory Subscriber's Mobile Money account number.

m

CustName xsd:string 140 Optional The name of the subscriber.

TXNType xsd:string 140 Optional A code value to identify the type of transaction being
executed.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 40
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

name value

Parameter Type Length Level of Description

Requirement

StatusCode xsd:int 4 Mandatory A predetermined code to determine the status of the

transaction.
OpCoID xsd:string 140 Optional Identifier of the country local to be used. Please refer
to 3.3 OpCoID List.
MerchantNam xsd:string 30 Optional It indicates the name of the destination partner.
e
CurrCode xsd:string 3 Optional The currency, as an ISO 4217 formatted string.

1.3.4 Response for ConfirmThirdPartyPayment

The App functions as the server, processes ConfirmThirdPartyPaymentRequest messages received from the
SDP, and sends ConfirmThirdPartyPaymentResponse messages to the SDP.
This topic provides a success response example. If a request fails, the SDP sends an error response that
contains an error code. For details about error responses, see 1.7 API Error Responses.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:b2b="http://b2b.mobilemoney.mtn.zm_v1.0/">
<soapenv:Header/>
<soapenv:Body>
<b2b:processRequestResponse>
<return>
<name>ProcessingNumber</name>
<value>121212</value>
</return>
<return>
<name>StatusCode</name>
<value>121212</value>
</return>
<return>
<name>StatusDesc</name>
<value>5131</value>
</return>
<return>
<name>ThirdPartyAcctRef</name>
<value>121212</value>
</return>
<return>
<name>Token</name>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 41
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<value>121212</value>
</return> </b2b:processRequestResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-25 describes parameters in a ConfirmThirdPartyPaymentResponse message body.
Table 1-25 Parameters in a ConfirmThirdPartyPaymentResponse message body

Parameter Type Length Level of Description

Requirement

return Return[0..20 - Mandatory Holds the response parameter details in the form of
] name/value pair to identify the service details.
Valid parameter names are:
ProcessingNumber
StatusCode
StatusDesc
ThirdPartyAcctRef
Token
For the detailed parameter name information, see
Table 1-27.
The return parameter is of the Return[0..20] type and
contains multiple sub-parameters. For details about
the Return[0..20] type, see Table 1-26.

Table 1-26 describes the parameter structure of the Return[0..20] type.

Table 1-26 Parameter structure of the Return[0..20] type

Parameter Type Length Level of Description

Requirement

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 42
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-27 describes the return name lists.

Table 1-27 Return name lists

name value

Parameter Type Length Level of Description

Requirement

ProcessingNu xsd:string 140 Mandatory An Id to uniquely identify the transaction on the Mobile
mber Money system.

StatusCode xsd:int 2 Mandatory A predetermined code to determine the status of the

transaction.
StatusDesc xsd:string 140 Optional The Mobile Money system supplied description of the
response code.

ThirdPartyAcc xsd:string 140 Mandatory Subscriber's account number on the App system.
tRef The SDP will fill this parameter as the same value
which was received from AcctRef in the request.

Token xsd:string 140 Optional A 32 character token representing the prepaid airtime
or electricity bought.

1.3.5 Error Codes for ConfirmThirdPartyPayment

The App returns error codes to the SDP when an exception occurs in response to
ConfirmThirdPartyPaymentRequest messages. The error codes are defined by partners.
The following table describes ConfirmThirdPartyPayment error codes that the partners may return upon an
exception.
Table 1-28 ConfirmThirdPartyPayment error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Fundamo userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 43
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 44
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

1.4 Deposit APIs

1.4.1 Process
Figure 1-6 shows the process of deposit.
Figure 1-6 Process of deposit

Table 1-29 describes the process.

Table 1-29 Description for the process of deposit

Step Description

1 The App invokes the depositMobileMoney API to deposit mobile money in Subscriber
s mobile money account.
2 The SDP performs authentication and service level agreement (SLA) control based
on fields in the request.
The SDP sends deposit response to the App.

1.4.2 DepositMobileMoney

Function
The App invokes the depositMobileMoney API to deposit money in Subscriber s mobile money account.
Partners must code the App based on the API field requirements so that the App can send correct requests to
the SDP. The SDP must send a response within 180 seconds by default.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 45
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Request URI
The request URI is the destination URI of depositMobileMoney messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/ThirdPartyServiceUMMImpl/UMMServiceService/DepositMobileMoney/v17
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

1.4.3 Request for DepositMobileMoney

The App functions as the client and sends a depositMobileMoneyRequest message to the SDP to deposit
money in Subscriber s mobile money account.

Example
POST /ThirdPartyServiceUMMImpl/UMMServiceService/DepositMobileMoney/v17 HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:b2b="http://b2b.mobilemoney.mtn.zm_v1.0/">
<soapenv:Header>
<RequestSOAPHeader xmlns="http://www.huawei.com.cn/schema/common/v2_1">
<spId>35000001</spId>
<spPassword>de96d901b3bad1db2aab76b7b0b202f2</spPassword>
<bundleID>256000039</bundleID>
<serviceId>35000001000035</serviceId>
<timeStamp>20100727</timeStamp>
</RequestSOAPHeader>
</soapenv:Header>
<soapenv:Body>
<b2b:processRequest>
<serviceId>201</serviceId>
<parameter>
<name>ProcessingNumber</name>
<value>555</value>
</parameter>
<parameter>
<name>serviceId</name>
<value>102</value>
</parameter>
<parameter>
<name>SenderID</name>
<value>MOM</value>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 46
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

</parameter>
<parameter>
<name>PrefLang</name>
<value>121212121</value>
</parameter>
<parameter>
<name>OpCoID</name>
<value>0</value>
</parameter>
<parameter>
<name>MSISDNNum</name>
<value>13132132000</value>
</parameter>
<parameter>
<name>Amount</name>
<value>10</value>
</parameter>
<parameter>
<name>Narration</name>
<value>121212</value>
</parameter>
<parameter>
<name>IMSINum</name>
<value>86</value>
</parameter>
<parameter>
<name>OrderDateTime</name>
<value>20100727</value>
</parameter>
<parameter>
<name>CurrCode</name>
<value>USD</value>
</parameter>
</b2b:processRequest>
</soapenv:Body>
</soapenv:Envelope>

Message HTTP Header Parameters

Table 1-30 Describes parameters in a depositMobileMoneyRequest message HTTP header.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 47
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-30 Parameters in a depositMobileMoneyRequest message HTTP header

Header Paramet Type Length Level of Description

Field er Requirement

Cookie sessioni String - Conditional The session id is used as a cookie in the HTTP header
d in the requests towards the Mobile Money Manager
when the Partner use Login/Logout mode.
[Example]
default8fcee064690b45faa9f8f6c7e21c5e5a
NOTE
Cookie is valid only for ECW and not for fundamo.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 48
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Message SOAP Header Parameters

Table 1-31 describes parameters in a depositMobileMoneyRequest message SOAP header.
Table 1-31 Parameters in a depositMobileMoneyRequest message SOAP header

Parameter Type Length Level of Description

Requirement

spId xsd: string 21 Mandatory Partner ID.

The ID is automatically allocated by the SDP to partners
after successful registration. To obtain the ID:
A service Partner and API Partner can log in to the
SDP management portal and query account
information.
A Developer can log in to the Developer Portal and
query account information.
[Example]
000201

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 49
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Description

Requirement

spPassword xsd: string 100 Conditional Authentication key for the SDP to authenticate partners.
The SDP supports authentication by SP ID + Password,
SP ID + IP address + Password, or SP ID + IP address.
Partners select an authentication mode during
registration. If a partner selects authentication by SP ID +
Password or SP ID + IP address + Password, this
parameter is mandatory in requests sent by this partner.
The value is a character string encrypted. The encryption
formula is as follows:
SHA-256: spPassword = Base64(SHA-256(spId +
Password + timeStamp))
MD5: spPassword = MD5(spId + Password +
timeStamp)
In the formula:
spId and timeStamp: authentication ID and
timestamp.
Password: password for partners to access the SDP.
A service Partner and API Partner can obtain the
password from the email notification received
after successful registration.
A Developer can log in to the Developer Portal,
choose Member Center > Account >
Registration Information > Invoke Password,
and set the password.

To retain features of earlier versions, the SP uses the MD5

algorithm in the connection to the SDP, which might cause security
risks.
[Example]e6434ef249df55c7a21a0b45758a39bb

bundleID xsd: string 21 Conditional Bundle ID.

When SDP creates a capability bundle, SDP allocates a
bundleID to capability bundle.
The bundleID must not be contained during invocation of
a service interface developed by service partners and
other partners, and must be contained during invocation
of a capability interface developed by API partners, other
partners, and developers.
[Example]
256000039

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 50
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Description

Requirement

serviceId xsd: string 21 Conditional Service ID.

The ID is automatically allocated by the SDP to services
after successful release. A service Partner can log in to
the SDP management portal and query service
information for the ID.
The serviceId must be contained during invocation of a
service interface developed by service partners and other
partners, and must not be contained during invocation of
a capability interface developed by API partners, other
partners, and developers.
[Example]
35000001000001

timeStamp xsd: string 14 Conditional Timestamp (UTC time).

The value is used in MD5 encryption of spPassword.
This parameter is mandatory when the spPassword
parameter is required.
[Format]
yyyyMMddHHmmss
[Example]
20100731064245

Message Body Parameters

Table 1-32 describes parameters in a depositMobileMoneyRequest message body.
Table 1-32 Parameters in a depositMobileMoneyRequest message body

Parameter Type Length Level of Requirement Description

serviceId xsd: string 4 Mandatory Holds the identification number to identify the
service request.
This is set as 201.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 51
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Requirement Description

parameter Parameter[0 - Optional Holds the request parameter details in the form
..20] of name/value pair to identify the service
details.
Valid parameter names are:
ProcessingNumber
serviceId
SenderID
PrefLang
OpCoID
MSISDNNum
Amount
Narration
IMSINum
OrderDateTime
CurrCode
For the detailed parameter name information,
see Table 1-34.
The parameter parameter is of the
Parameter[0..20] type and contains multiple
sub-parameters. For details about the
Parameter[0..20] type, see Table 1-33.

Table 1-33 describes the parameter structure of the Parameter[0..20] type.

Table 1-33 Parameter structure of the Parameter[0..20] type

Parameter Type Length Level of Requirement Description

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-34 describes the parameter name lists.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 52
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-34 Parameter name lists

name value

Parameter Type Length Level of Description

Requirement

ProcessingNumber xsd:string 140 Mandatory An Id to uniquely identify the transaction on the

App system.

serviceId xsd:string 140 Mandatory This relates to the Code configured in the Mobile
Money system. Properties file is used to uniquely
identify each service provided.
SenderID xsd:string 140 Optional An Id to identify sender.

PrefLang xsd:string 140 Optional The language locale to be used.

OpCoID xsd:int 140 Mandatory Identifier of the country local to be used. Please
refer to 3.3 OpCoID List.

MSISDNNum xsd:string 30 Mandatory An Id to uniquely identify the subscriber on the

App system.
Subscriber's MSISDN number or Fake ID.
[Format]
Mobile number: [Country code][Mobile number]
Fake ID: [Prefix]-[opcoid]-[sequence].
[Example]
Mobile number: 8612312345678
Fake ID: f-245-11900000007639.
Amount xsd:int 4 Mandatory The value of the amount to be deposited into the
subscriber's Mobile Money account.

Narration xsd:string 140 Mandatory A descriptive message for receiver's transaction

history.
If present, it will also be added to the notification
text sent to the receiver.
IMSINum xsd:string 140 Optional Subscriber's IMSI number.

OrderDateTime xsd:dateTim 140 Optional Time when subscriber ordered the service.
e

CurrCode xsd:string 3 Optional The currency, as an ISO 4217 formatted string.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 53
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

1.4.4 Response for DepositMobileMoney

The SDP functions as the server, processes depositMobileMoneyRequest messages received from the App,
and sends depositMobileMoneyResponse messages to the App.
This topic provides a success response example. If a request fails, the SDP sends an error response that
contains an error code. For details about error responses, see 1.7 API Error Responses.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:processRequestResponse xmlns:ns1="http://b2b.mobilemoney.mtn.zm_v1.0/">
<return>
<name>ProcessingNumber</name>
<value>123</value>
</return>
<return>
<name>SenderID</name>
<value>MOM</value>
</return>
<return>
<name>StatusCode</name>
<value>234</value>
</return>
<return>
<name>StatusDesc</name>
<value>345</value>
</return>
<return>
<name>OpCoID</name>
<value>0</value>
</return>
<return>
<name>IMSINum</name>
<value>86</value>
</return>
<return>
<name>MSISDNNum</name>
<value>13132132000</value>
</return>
<return>
<name>OrderDateTime</name>
<value>20100727</value>
</return>
<return>
<name>ThirdPartyAcctRef</name>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 54
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<value>121212</value>
</return>
<return>
<name>MOMTransactionID</name>
<value>456</value>
</return>
</ns1:processRequestResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-35 describes parameters in a depositMobileMoneyResponse message body.
Table 1-35 Parameters in a depositMobileMoneyResponse message body

Parameter Type Length Level of Requirement Description

return Return[0..20] - Mandatory Holds the response parameter details in the

form of name/value pair to identify the
service details.
Valid parameter names are:
ProcessingNumber
SenderID
StatusCode
StatusDesc
OpCoID
IMSINum
MSISDNNum
OrderDateTime
ThirdPartyAcctRef
MOMTransactionID
For the detailed parameter name
information, see Table 1-37.
The return parameter is of the Return[0..20]
type and contains multiple sub-parameters.
For details about the Return[0..20] type, see
Table 1-36.

Table 1-36 describes the parameter structure of the Return[0..20] type.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 55
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-36 Parameter structure of the Return[0..20] type

Parameter Type Length Level of Requirement Description

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-37 describes the return name lists.

Table 1-37 Return name lists

name value

Parameter Type Length Level of Requirement Description

ProcessingNu xsd:string 140 Mandatory An Id to uniquely identify the transaction on

mber the App system.

SenderID xsd:string 140 Optional An Id to identify sender.

It is set as MOM.

StatusCode xsd:int 2 Mandatory A predetermined code to determine the

status of the transaction.

StatusDesc xsd:string 140 Optional The Mobile Money system supplied

description of the response code.
OpCoID xsd:string 140 Mandatory Identifier of the country local to be used.
Please refer to 3.3 OpCoID List.

IMSINum xsd:string 140 Optional Subscriber's IMSI number.

MSISDNNum xsd:string 30 Mandatory Subscriber's MSISDN number or Fake ID.

OrderDateTi xsd:dateTime 140 Optional Time when subscriber ordered the service.
me

ThirdPartyAcc xsd:string 140 Optional Subscriber's account number on the App

tRef system.
The SDP will fill this parameter as the
same value which was received from
AcctRef in the request.

MOMTransac xsd:string 140 Optional An Id to uniquely identify the transaction on

tionID the Mobile Money system. The SDP will
forward this parameter to the App system.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 56
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

1.4.5 Error Codes for DepositMobileMoney

Table 1-38 describes depositMobileMoney error codes that the SDP may return upon an exception. For
details about the error codes, see the SDP Solution Error Code Reference.
Table 1-38 depositMobileMoney error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Fundamo userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

Get addr route info failed!the baseScfType = %1,the sourceAddr = %2,the

destAddr = %3.
NOTE
ScfType refers to Service Capability Function Type.

MDSP AuthPrice failed, result code is %1.

NOTE
The MDSP is composed of the Mobile Data Control Center (MDCC) subsystem and
peripheral functional subsystems such as the Portal and Mobile Data Management Center
(MDMC). The MDCC subsystem consists of core modules such as the Short Message Push
Agent (SMPA), Network Management System (NMS) proxy, and BOSS interface machine.
The MDSP is connected to the NMS, BOSS system, Service Control Point (SCP), customer
service center, and service gateways. The MDSP can implement the functions such as
external entity access, mobile data management, user and service authentication, and
charging.

Waiting for response timed out, message type is %1.

Cannot find route policy, the policy identifier is %1.

The service status is unknown.

Service %1 is in blacklist!

The API %1 is not existed.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 57
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Service ID %1 is not exist!

The service status is suspended.

The service status is pre-deregistered.

The service status is deregistered.

The API status is disabled.

SP status is locked.

The sp's Status is forbidden.

The sp's status is pause.

The RemotePassword of NE %1 is empty!

NOTE
NE refers to network element, such as SMSC, MMSC.

NEInfo id %1 not in SAG.

NOTE
The SAG provides open interfaces for third-party partners. It authenticates and authorizes
the partners, and controls the Service Level Agreement policies when it receives third-party
service requests.

The ScfType %1 is inactive!

NOTE
ScfType refers to Service Capability Function Type.

The ScfType %1 is uninstalled!

NOTE
ScfType refers to Service Capability Function Type.

The service status is configuring.

The Created is null.

SP ip is null!
Sp password is null!

The Nonce is null.

Authentication Failed, cause by SP, because of timestamp expired.

Service ID is null!

Sp password is null!

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 58
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Timestamp is empty in soapheader.

Service ID %1 is invalid!

The PasswordDigest is not accepted.

The sp's Status is pre-deregistered.

The sp's Status is deregistered.

The sp's Status is unknown.

SP %1 is in blacklist!

SPID %1 is not exist!

Sp password is not accepted!

Sp ip %1 is not accepted!

local SP password is null!

The authentication type is unknown!

Authentication Failed, cause by SP, because of timestamp is not valid.

Minimum Amount per Transaction

%1 is null.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

%1 is null.

103 Duplicate transaction id.

104 Authorization declined.

105 Account holder is not active.

106 Deposit Transfer not processed: Source & destination accounts are same

108 Deposit Transfer not processed: Insufficient funds

109 Deposit Transfer not processed: Daily limit has been exceeded.

110 Deposit Transfer not processed: Sender account not active

111 Deposit Transfer not processed: Target account not active

501 DATEFORMAT_INVALID

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 59
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

502 FRI_INVALID

503 IDENTITY_INVALID

504 INVALID_FIELD_VALUE

505 MANDATORY_FIELD_MISSING

506 OTHER_FINANCIAL_ERROR
507 PREAPPROVAL_NOT_FOUND

508 REFERENCE_ID_NOT_FOUND

509 REQUIRED_FIELD_MISSING

510 SERVICE_TEMPORARILY_UNAVAILABLE

511 SESSION_INVALID

512 TRANSACTION_ID_OR_ORIGINAL_TRANSACTION_ID_MISSING

513 TRANSACTION_NOT_COMPLETED

514 TRANSFER_TYPE_AND_ACCOUNT_DO_NOT_MATCH

515 ACCOUNTHOLDER_WITH_FRI_NOT_FOUND

516 ACCOUNTHOLDER_WITH_MSISDN_NOT_FOUND

517 AUTHORIZATION_INVALID_ACCOUNT_TYPE_COMBINATION

518 COULD_NOT_PERFORM_OPERATION
519 EXPIRED_OR_INVALID_TRANSACTION_ID

520 INCORRECT_PASSWORD

521 NOT_AUTHORIZED
522 AMOUNT_INVALID

523 CURRENCY_NOT_SUPPORTED

524 INVALID_CURRENCY
525 RESOURCE_NOT_ACTIVE

526 SOURCE_NOT_FOUND

527 RESOURCE_NOT_FOUND
529 TARGET_AUTHORIZATION_ERROR

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 60
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

530 This account is already a member of this group

531 Account could not be removed from Bank domain

532 The specified account holder's additional information name already exist

The specified account holder's additional information name cannot be

533
deleted because it is in use

534 This account holder is already a member of this group

535 AccountHolder does not exist

536 This operation requires the user to be logged in

537 AccountHolder profile does not have requested account

538 AccountHolder status should be blocked or active

539 Account not found

Could not create account route since Account route with provided account
540
route reference and currency already exists

Could not delete account route since Account route with provided account
541
route reference and currency does not exists

542 Account type is not supported

543 The account holder already has a connection to the specified account

544 Activation of account holder failed

Could not perform operation since at least one of the mandatory field is
545
required

Could not perform operation since at least one of the mandatory field is
546
required
Could not perform operation since at least one of the mandatory field is
547
required
Could not perform operation since at least one of the mandatory field is
548
required
Could not perform operation since at least one of the mandatory field is
549
required
550 Account holder could not be found

Operation requires account holder to have an MSISDN identity but it has

551
none

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 61
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

552 Account holder is inactive

A specified account holder was not a child to another specified account

553
holder

554 Account holder could not be found

555 The settings for this account holder already exists

556 Account holder settings are mandatory

557 Account holder settings not found

Account holder could not be registered because an account holder with

558
submitted Alias already exists

Account holder could not be registered because an account holder with

559
submitted E-mail already exists

560 Account holder with given e-mail could not be found

Account holder cannot have the same employee id as another employee

561
working under the same employer

Account holder could not be registered because an account holder with

562
submitted External ID already exists

563 Account holder IMSI could not be updated because it already exists

Account holder could not be registered because an account holder with

564
submitted MSISDN already exists

Account holder could not be registered because an account holder with

565
submitted Username already exists

566 Adjustments from account not allowed

567 Adjustments not allowed on account

568 Adjustments to account not allowed

569 No Alias with this name was found in the system

Could not perform operation since the resource already belongs to another
570
Bank domain
571 The FRI refers to more than one account

572 Account holder is not allowed to perform this operation

573 Account holder is already activated

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 62
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

574 Insufficient amount

Setting an account holder as its own parent or a creating a cycle in the

575
hierarchy is not allowed

576 Authorization failed

Maximum transfer account throughput amount including fee threshold

577
exceeded
Maximum transfer account throughput amount including fee threshold
578
exceeded for receiver

Maximum transfer account throughput amount including fee threshold

579
exceeded for sender

580 Maximum transfer amount threshold exceeded

581 Maximum transfer amount including fee threshold exceeded

582 Maximum transfer amount including fee threshold exceeded for receiver

583 Maximum transfer amount including fee threshold exceeded for sender

584 Maximum transfer amount threshold exceeded for receiver

585 Maximum transfer amount threshold exceeded for sender

586 Maximum transfer counter threshold exceeded

587 Maximum send amount threshold exceeded

588 Authorization failed. Maximum threshold limit reached for Approver

589 Amount below minimum amount threshold

590 Amount below minimum amount threshold for account

591 Amount below minimum amount threshold for account reference

592 Account holder is not registered

593 Receivers account does not allow deposit

Could not perform operation because amount is below minimum first deposit
594
amount threshold

595 Maximum balance threshold for receiver exceeded

596 Receivers account is not active

597 Receiving account is unavailable

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 63
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

598 Withdrawal from recipient account not allowed

599 Minimum balance threshold for sender exceeded

600 Sending account is unavailable

A bank account with given bank code and account number could not be
601
found

602 A route to the wanted bank account could not be found

603 No bank domain set in the system.

604 Bank domain with given ID was not found

605 Could not perform operation since the Bank domain is currently in use

Could not perform operation since Bank domain with given name already
606
exists

607 Account could not be blocked

608 Receiving account holder has insufficient permission to receive cashin

609 Receiving account holder has insufficient permission to receive cashout

610 Certificate already updated for the user

611 Certificate credentials already exist

612 Certificate credentials do not exist

613 Account could not be closed

614 The company information already exist

615 The company information does not exist

616 Contact was not added since it already exists

617 Contact with given FRI could not be found

618 Could not create account holder

619 Could not perform add account operation

620 Failed to approve the operation, please retry the initial operation again

621 ATM partial reversal operation could not be performed

622 ATM redeem voucher operation could not be performed

623 ATM rollback voucher operation could not be performed

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 64
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Could not perform the operation, the account has to be linked with sp
624
account.

625 Receive remittance failed

626 Could not perform update of account holder settings

627 Could not perform update of pending payment status

628 The specified counter configuration does not exist.

629 The credential is not in the expected suspended state

630 Operation not allowed because credential not in active state

631 Repeated secrets does not match each other

632 Given credential type does not exist in the system

633 For this operation currency conversion is not allowed

634 Custody Account already exists

635 Custody account certificate already exist

636 Custody account certificate could not deleted

637 Custody account certificate could not be empty

638 Custody account certificate could not be used for non-repudiation

639 Custody account certificate does not exist

640 Custody account certificate error

641 Unsupported algorithm for custody account certificate

642 Custody account certificate with same id already exist

643 Name and Bank Domain are same as before

Could not find CustodyAccount since Custody Account with provided account
644
number and bank code does not exists

645 Custody account still contains money

646 This Custody account still have pending transaction

Could not update custody account as name and bank domain both are
647
missing
648 Account holder and account must belong to the same bank domain

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 65
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

649 The document does not exist

650 The document rules has been incorrectly configured in the system

651 This document URL is invalid

652 This document URL is not allowed

653 End date can not occur in the future

654 This error originates from an external system

655 External service provider with given User name could not be found

656 Netting report error

657 Financial Configuration does not exist

Neither transaction with transaction ID nor original transaction with original

658
transaction ID could be found

659 Using first name in password is not allowed

660 The specified float transfer exemption rule already exists

661 Setting multiple owners of an FRI is not allowed

662 FRI Reference not found.

663 Operation requires that start date has to occur before end date

Could not perform operation since the Group is already used by another
664
Bank domain
665 Group member could not be removed from group

666 Group member could not be removed from Bank domain

667 Group member with given ID could not be found in this group
668 Group used by Bank domain is not allowed to be removed

It's not possible to mirror a High Contention account in SDP since it doesn't
669
have a balance.
670 Home charging region with given ID was not found

Could not perform operation since the home charging region is currently in
671
use

Could not perform operation since Home Charging Region with given name
672
already exists

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 66
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

673 Length of identification is not within length boundaries

674 Duplicate identification

675 ID type not supported by ISO 20022

676 The credential status change is illegal

677 Format of IMSI is invalid

678 Inactive receiver account

679 Incorrect pin code

680 Security answer was not correct

681 Transaction state is incorrect for this operation

682 An internal error caused the operation to fail

683 Could not find Internal Loan Account with given Id

684 Amount Min cannot be larger than Amount Max

685 The state of this Internal Loan Application is not valid for this operation

686 Could not find Internal Loan Application

687 Maximum number of Internal Loan Applications reached

688 Internal Loan Product already exist

689 The Internal Loan Product status is not active

690 The given Internal Loan Product is not allowed to be used

691 Could not find Internal Loan Product with given identity and product code

692 Internal Loan Provider already exist

693 Could not find Internal Loan Provider with given identity

694 The FRI must be of account type

The specified account holder's additional information name is not valid or

695
does not exist

696 Account holder settings are invalid

697 Approval transaction has invalid state

698 Invalid ATM operation

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 67
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

699 Certificate is invalid

700 Invalid Delivery method

701 Profile validation

702 Profile counter validation

703 Profile name validation

704 Profile threshold validation

705 Invalid receiving end user

706 Incorrect remittance status

707 A transaction can only be scheduled from a future date

708 Invalid scheduled transaction status for the requested operation

709 Settlement deposit with given ID could not be found

710 Settlement with given ID could not be found

711 The provided signature is not correct

712 Current status is not as expected

713 Invalid Transaction type

714 Invalid User (or financial) approval type or not registered

715 Bank domain could not be removed since it is the last remaining
716 Limited retries are not allowed for the specified service provider

717 Could not find Loan Application with given approval ID

718 Could not find Loan Provider with given name

719 Reached limit for max accounts

720 Maximum number of contacts threshold exceeded

721 Maximum number of documents exceeded

722 Actor MSISDN is missing

723 Exchange rate for conversion between currencies does not exist.

724 More than one of a set of optional but mutual parameters were set.
725 Given msisdn alread used by a point of sale

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 68
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

726 User has no access permission

727 Using non ASCII characters in password is not allowed

728 Non-digit characters in pin code

729 It is not allowed to change bank domain for an account holder

730 One custody account must exist

731 Only one refund per debit is allowed

732 Operation not supported on external account

733 Operation not supported on a migrated account

734 Request did not contain any OTP

735 Request did not contain any OTP

736 Request did not contain any OTP

737 Format of OTP is invalid

738 OTP not found, has expired or is used for the wrong operation

739 Password has already been used before

740 Password too short

741 Could not find Pending Commission

742 Pickup with given MTCN could not be found

743 PIN code has already been used

744 PIN code denied by matching birth date

745 PIN code denied by matching identification number

746 PIN code denied by matching MSISDN

747 PIN code denied by matching regular expression

748 Wrong profile

749 Pin code too long

750 Pin code too short

751 The point of sale with given msisdn is not acquired.

752 No pre-approvals found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 69
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

753 Profile name validation

754 Json File validation

A profile mismatch between for example a provided counter configuration

755 (belonging to one profile) and provided profile reference (having a different
profile)

756 Profile not found

757 Profile type validation

758 Profile version validation

759 Profile version validation

760 Tag was not found

761 Provider Category can not be deleted as it is linked with account holder

762 No provider category with this name was found in the system

763 Request is queued for approval

764 Quote has already been used

765 Quote has expired

766 Quote not found

767 Quote is not supported with the combination of parameters

768 Quote is already processing

769 Account could not be re-activated

770 Failed to process reconciliation file.

Recurring scheduled transaction can only be scheduled a limited number of

771
days into the future

772 Refund amount cannot be larger than the debit amount

773 The relative does not exist

774 Remittance Id does not exist in dbase

775 Remittance not found, Invalid provider name or remittance id

776 Remittance not possible because given data is invalid.

777 Password criteria configuration invalid

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 70
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

778 FRI not available

779 Required resource is temporarily locked

780 Reversal has already been performed on this transaction

781 Reversal is not allowed on this type of transaction

782 Reversal not possible since sub transaction is invalid

783 Using reversed user id in password is not allowed

Transaction could not be performed since neither of the parties supports

784
rollback

785 Transaction can only be scheduled a limited number of days into the future

786 The requested scheduled transaction could not be found

787 This self service notification aready exists.

788 The notification limit exceeds the hard limit

789 Self service notificaiton not found.

790 Max number of self serviced notifications reached, cannot create another.

The response amount does not match with the amount in the Payment
791
Instruction

792 Another settlement task is ongoing.

Balance reconcilation failed. Provided closing balance does not match with
793
the expected closing balance of custody account

Certificate does not exist for custody account not able to verify signature of
794
settlement file

795 Custody account already exists with settlement configuration

796 Could not find settlement Configuration for custody account

797 Settlement configuration for identifier already exists

798 Instruction formatter class not found

799 Settlement configuration not found

800 Settlement parser class not found

801 Unable to remove custody account id from settlement configuration

802 Currency does not match with custody account's currency.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 71
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

Settlement process failed because the custody accounts information do not

803
match.

804 The deposit has already been reversed.

805 The deposit is in an invalid state.

806 The deposit was not found.

807 The transaction details of the deposit where not found.

808 Duplicated deposit or reverse deposit record found.

809 Digest does not exist or digest verification failed for settlement file

810 Error in parsing settlement file

811 Signature does not exist or signature verification failed for settlement file

812 Payment Instruction Response caller identifier mismatch

813 Settlement identifier not found

814 Invalid or no amount in Payment Instruction Response.

Settlement error due to invalid receiver.There is no such account holder or

815
custody account exists.

816 Settlement is in wrong state

817 Online settlement not enabled for custody account

818 Opening Balance reconcilation failed

819 Wrong state for Settlement PaymentInstruction.

820 Settlement PaymentInstruction not found.

821 Failed to process settlement file.

822 The receiver account does not match

823 Wrong state for Settlement CustodyAccountsTransfers.

824 Using surname in password is not allowed

825 Not possible to put account in suspended state

826 Tag could not be created because a Tag with submitted name already exists

827 Tag was not found

828 Tax report not found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 72
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

829 The specified threshold configuration does not exist.

830 Too few lower case alphabetic characters in password

831 Too few digits in password

832 Too few special characters in password

833 Too few upper case alphabetic characters in password

834 Too few upper or lower case alphabetic characters in password

835 Too many consecutive digits in PIN code

836 Too many identical consecutive characters in password

837 Too many repeated digits in PIN code

838 Transaction not found

839 Transaction timed out

840 Operation is not supported for this account

841 Account holder could not be created

842 Interest tier could not be created

843 Interest tier could not be modified

844 Interest tier could not be removed

845 Account could not be un-blocked

846 Unresolved Remittance Id does not exist in dbase

The maximum attempts of credential unsuspend for the given account holder
847
has been reached
848 Using user id in password is not allowed

849 The data provided in the request failed the validation check

850 Voucher date of birth has been set

851 Voucher has expired

852 Voucher external id has been set

853 Voucher first name has been set

854 Voucher is no longer active

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 73
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Error Code Description

855 Voucher with given identity could not be found in the system

Voucher secret contains letters that has been excluded through system
856
configuration

Voucher secret contains characters that is not legal according to system

857
configuration

858 Voucher secret contains non ASCII characters

859 Voucher secret can not contain digits

860 Voucher secret is not correct

861 Voucher secret element is empty

862 Voucher secret can not contain letters

863 The voucher secret rules has been incorrectly configured in the system

864 Voucher secret is longer than system configured maximum length

Too many redeem voucher attempts with incorrect secret has been
865
performed

866 Voucher secret is shorter than system configured minimum length

867 Voucher surname has been set

868 Wrong profile

Number of coupons allowed on the offer for the user has already been
869
reached
870 User is not eligible for offer

871 User profile does not exist

1.5 APIs for Querying Subscriber Account Balances

1.5.1 Process
Figure 1-7 shows the process of querying subscriber account balance.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 74
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Figure 1-7 Process of querying subscriber account balance

Table 1-39 describes the process.

Table 1-39 Description for the process of querying subscriber account balance

Step Description

1 The SDP sends querying subscriber account balance request to query the
balance of subscriber on third party system.

2 The third party APP parses the querying subscriber account balance request
and sends a response to the SDP.

1.5.2 QueryThirdPartyAccount

Function
The SDP invokes the QueryThirdPartyAccount API to query subscriber account balance on third party
system.
Partners must code the App based on the API field requirements so that the App can correctly parse and
respond to requests received from the SDP. The App must send a response to the SDP within 30 seconds.

Request URI
The request URI is the destination URI of QueryThirdPartyAccountRequest messages sent by the SDP to the
App. The URI is defined by the App.

1.5.3 Request for QueryThirdPartyAccount

The SDP functions as the client and sends a QueryThirdPartyAccountRequest message to the App to query
subscriber account balance.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 75
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<ns1:NotifySOAPHeader xmlns:ns1="http://www.huawei.com.cn/schema/common/v2_1">
<ns1:traceUniqueID>504021505821207271704550002002</ns1:traceUniqueID>
</ns1:NotifySOAPHeader>
</soapenv:Header>
<soapenv:Body>
<ns2:processRequest xmlns:ns2="http://b2b.mobilemoney.mtn.zm_v1.0/">
<serviceId>100</serviceId>
<parameter>
<name>ProcessingNumber</name>
<value>1212121</value>
</parameter>
<parameter>
<name>senderID</name>
<value>MOM</value>
</parameter>
<parameter>
<name>AcctRef</name>
<value>112233</value>
</parameter>
<parameter>
<name>OpCoID</name>
<value>0</value>
</parameter>
</ns2:processRequest>
</soapenv:Body>
</soapenv:Envelope>

Message Header Parameters

Table 1-40 describes parameters in a QueryThirdPartyAccountRequest message header.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 76
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-40 Parameters in a QueryThirdPartyAccountRequest message header

Parameter Type Length Level of Requirement Description

traceUniqueID xsd:string 30 Mandatory Transaction ID.

The ID is automatically generated by
the SDP and is used only to trace
messages during the SDP
commissioning. The App ignores this
parameter.
[Example]
100001200101110623021721000011

Message Body Parameters

Table 1-41 describes parameters in a QueryThirdPartyAccountRequest message body.
Table 1-41 Parameters in a QueryThirdPartyAccountRequest message body

Parameter Type Length Level of Requirement Description

serviceId xsd: string 4 Mandatory Holds the identification number to

identify the service request.
This is set as 100.

parameter Parameter[0.. - Optional Holds the request parameter details in

20] the form of name/value pair to identify
the service details.
Valid parameter names are:
ProcessingNumber
SenderID
AcctRef
PrefLang
OpCoID
For the detailed parameter name
information, see Table 1-43.
The parameter parameter is of the
Parameter[0..20] type and contains
multiple sub-parameters. For details
about the Parameter[0..20] type, see
Table 1-42.

Table 1-42 describes the parameter structure of the Parameter[0..20] type.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 77
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-42 Parameter structure of the Parameter[0..20] type

Parameter Type Length Level of Requirement Description

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-43 describes the parameter lists.

Table 1-43 Parameter name lists

name value

Parameter Type Length Level of Requirement Description

ProcessingNumbe xsd:string 140 Mandatory An Id to uniquely identify the

r transaction on the App system.

SenderID xsd:string 140 Mandatory An Id to identify sender.

This is set as MOM.

AcctRef xsd:string 140 Mandatory Subscriber's account number on the

App system.
If the subscriber does not have
account on the App system, you need
confirm it with the Mobile Money
system.

PrefLang xsd:string 140 Optional The language locale to be used.

OpCoID xsd:string 140 Optional Identifier of the country local to be

used. Please refer to 3.3 OpCoID List.

1.5.4 Response for QueryThirdPartyAccount

The App functions as the server, processes QueryThirdPartyAccountRequest messages received from the
SDP, and sends QueryThirdPartyAccountResponse messages to the SDP.
This topic provides a success response example. If a request fails, the SDP sends an error response that
contains an error code. For details about error responses, see 1.7 API Error Responses.

Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:b2b="http://b2b.mobilemoney.mtn.zm_v1.0/">
<soapenv:Header/>
<soapenv:Body>
<b2b:processRequestResponse>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 78
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<return>
<name>DueAmount</name>
<value>121212</value>
</return>
<return>
<name>BalanceAmount</name>
<value>2121</value>
</return>
<return>
<name>MinDueAmount</name>
<value>121212</value>
</return>
<return>
<name>Narration</name>
<value>121212</value>
</return>
<return>
<name>ProcessingNumber</name>
<value>121212</value>
</return>
<return>
<name>StatusCode</name>
<value>121212</value>
</return>
<return>
<name>ThirdPartyAcctRef</name>
<value>121212</value>
</return>
<return>
<name>StatusDesc</name>
<value>121212</value>
</return>
<return>
<name>CurrCode</name>
<value>USD</value>
</return>
</b2b:processRequestResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-44 describes parameters in a QueryThirdPartyAccountResponse message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 79
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-44 Parameters in a QueryThirdPartyAccountResponse message body

Parameter Type Length Level of Requirement Description

return Return[0..20] - Mandatory Holds the response parameter details

in the form of name/value pair to
identify the service details.
Valid parameter names are:
DueAmount
BalanceAmount
MinDueAmount
Narration
ProcessingNumber
StatusCode
ThirdPartyAcctRef
StatusDesc
CurrCode
For the detailed parameter name
information, see Table 1-46.
The return parameter is of the
Return[0..20] type and contains
multiple sub-parameters. For details
about the Return[0..20] type, see
Table 1-45.

Table 1-45 describes the parameter structure of the Return[0..20] type.

Table 1-45 Parameter structure of the Return[0..20] type

Parameter Type Length Level of Requirement Description

name xsd:string - Mandatory Holds the parameter name.

value xsd:string - Mandatory Holds the parameter value.

Table 1-46 describes the return name lists.

Table 1-46 Return name lists

name value

Parameter Type Length Level of Requirement Description

DueAmount xsd:int 4 Mandatory The amount that the subscriber is due

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 80
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

name value

Parameter Type Length Level of Requirement Description

to pay on the App system.

BalanceAmount xsd:int 4 Mandatory Subscriber's balance on the App

system.
If there is no subscriber's balance on
the App system, you need confirm it
with the Mobile Money system.

MinDueAmount xsd:int 4 Mandatory The minimum amount that the

subscriber is due to pay on the App
system.
If there is no minimum due on App
system, you need confirm it with the
Mobile Money system.
Narration xsd:string 140 Optional Any text that the vendor would like to
display to the subscriber.

ProcessingNumbe xsd:string 140 Mandatory The identifier of the transaction

r echoed back.
StatusCode xsd:int 2 Mandatory A predetermined code to determine
the status of the transaction.

ThirdPartyAcctRef xsd:string 140 Mandatory Subscriber's account number on the

App system.
The SDP will fill this parameter as the
same value which was received from
AcctRef in the request.

StatusDesc xsd:string 140 Optional The App system supplied description

of the response code.
CurrCode xsd:string 3 Optional The currency, as an ISO 4217
formatted string.

1.5.5 Error Codes for QueryThirdPartyAccount

The App returns error codes to the SDP when an exception occurs in response to
QueryThirdPartyAccountRequest messages. The error codes are defined by partners.
The following table describes QueryThirdPartyAccount error codes that the partners may return upon an
exception.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 81
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-47 QueryThirdPartyAccount error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Fundamo userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

1.6 APIs for notifying requestPaymentCompleted

1.6.1 Process
Figure 1-8 shows the process of notifying requestPayment completed.
Figure 1-8 Process of notifying requestPayment completed

Table 1-48 describes the process.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 82
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-48 Description for the process of notifying requestPayment completed

Step Description

1 The SDP sends requestPaymentCompleted request to inform the App the result of the
requestPayment in case asynchronism requestPayment.

2 The APP processes the requestPaymentCompleted request and sends a response to the SDP.

1.6.2 requestPaymentCompleted

Function
The SDP invokes the requestPaymentCompleted API to inform the App the result of the requestPayment.
Partners must code the App based on the API field requirements so that the App can correctly parse and
respond to requests received from the SDP. The App must send a response to the SDP within 30 seconds.

Request URI
The request URI is the destination URI of requestPaymentCompleted messages sent by the SDP to the App.
The URI is defined by the App.

1.6.3 Request for requestPaymentCompleted

The SDP functions as the client and sends a requestPaymentCompleted request message to the App to
inform the App the result of the requestPayment.

Example
POST / HTTP/1.1
SOAPAction: ""
Content-Type: text/xml; charset=UTF-8
Host: 10.135.163.33:17309
Connection: close
Content-Length: 880

<?xml version="1.0" encoding="utf-8" ?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Header>
<ns1:NotifySOAPHeader xmlns:ns1="http://www.huawei.com.cn/schema/common/v2_1">
<ns2:traceUniqueID
xmlns:ns2="http://www.csapi.org/schema/momopayment/local/v1_0">504021503411410281818220013006</n
s2:traceUniqueID>
</ns1:NotifySOAPHeader>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 83
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

</soapenv:Header>
<soapenv:Body>
<ns3:requestPaymentCompleted
xmlns:ns3="http://www.csapi.org/schema/momopayment/local/v1_0">
<ns3:ProcessingNumber>2713500010003</ns3:ProcessingNumber>
<ns3:MOMTransactionID>2713500010002</ns3:MOMTransactionID>
<ns3:StatusCode>01</ns3:StatusCode>
<ns3:StatusDesc>This is a respone Message!</ns3:StatusDesc>
<ns3:ThirdPartyAcctRef>http://www.qwe.com</ns3:ThirdPartyAcctRef>
</ns3:requestPaymentCompleted>
</soapenv:Body>
</soapenv:Envelope>

Message Header Parameters

Table 1-49 describes parameters in a requestPaymentCompleted message header.
Table 1-49 Parameters in a requestPaymentCompleted message header

Parameter Type Length Level of Requirement Description

traceUniqueID xsd:string 30 Mandatory Transaction ID.

The ID is automatically generated by
the SDP and is used only to trace
messages during the SDP
commissioning. The App ignores this
parameter.
[Example]
100001200101110623021721000011

Message Body Parameters

Table 1-50 describes parameters in a requestPaymentCompleted request message body.
Table 1-50 Parameters in a requestPaymentCompleted request message body

Parameter Type Length Level of Requirement Description

ProcessingNumbe xsd: string 140 Mandatory ProcessingNumber which came in

r requestPayment request.

xsd: string 140 Mandatory An Id to uniquely identify the

MOMTransactionI transaction on the Mobile Money
D system.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 84
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Parameter Type Length Level of Requirement Description

xsd: string 10 Mandatory A predetermined code to determine

StatusCode the status of the transaction.

xsd: string 140 Optional The Mobile Money system supplied

StatusDesc description of the response code.
xsd: string 140 Mandatory AcctRef which came in
ThirdPartyAcctRef requestPayment request.

extensionInfo NamedParam - Optional Extended parameter. Reversed, not

eterList used now.

Table 1-51 describes the parameter structure of the NamedParameterList type.

Table 1-51 Parameter structure of the NamedParameterList type

Parameter Type Length Level of Requirement Description

item NamedParam - Optional List of extended parameters.

eter[ ]

Table 1-52 describes the parameter structure of the NamedParameter type.

Table 1-52 Parameter structure of the NamedParameter type

Parameter Type Length Level of Requirement Description

key xsd:string 100 Mandatory Name of the extended parameter.

value xsd:string 512 Mandatory Value of the extended parameter.

1.6.4 Response for requestPaymentCompleted

The App functions as the server, processes requestPaymentCompleted messages received from the SDP,
and sends requestPaymentCompletedResponse messages to the SDP.
This topic provides a success response example. If a request fails, the SDP sends an error response that
contains an error code. For details about error responses, see 1.7 API Error Responses.

Example
HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 1142
SOAPAction: ""

<?xml version="1.0" encoding="utf-8"?>

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 85
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<soapenv:Body>
<requestPaymentCompletedResponse
xmlns="http://www.csapi.org/schema/momopayment/local/v1_0">
<result>
<resultCode xmlns="">00000000</resultCode>
<resultDescription xmlns="">success</resultDescription>
</result>
<extensionInfo>
<item xmlns="">
<key>result</key>
<value>success</value>
</item>
</extensionInfo>
</requestPaymentCompletedResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-53 describes parameters in a requestPaymentCompletedResponse message body.
Table 1-53 Parameters in a requestPaymentCompletedResponse message body

Parameter Type Length Level of Requirement Description

result Result - Mandatory Result

extensionInfo NamedParam - Optional Extended parameter. Reversed, not

eterList used now.

Table 1-54 describes the parameter structure of the Result type.

Table 1-54 Parameter structure of the Result type

Parameter Type Length Level of Requirement Description

resultCode xsd:string 10 Mandatory Return code; 00000000 means

success.
resultDescription xsd:string 512 Optional the description of the resultCode

1.6.5 Error Codes for requestPaymentCompleted

The App returns error codes to the SDP when an exception occurs in response to requestPaymentCompleted
messages. The error codes are defined by partners.
Table 1-55 describes requestPaymentCompleted error codes that the partners may return upon an exception.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 86
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

Table 1-55 requestPaymentCompleted error codes

Error Code Description

00000000 Success

00000001 No data found

10000001 Authentication failed

10000002 Invalid Parameter:%1.

%1 indicates parameter name

10000003 Request Rate Limited

10000099 Service Error

1.7 API Error Responses

When an error occurs, the server sends an error response to the client. This topic provides an error response
example and describes parameters in the response.
Example
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:processRequestResponse xmlns:ns1="http://b2b.mobilemoney.mtn.zm_v1.0">
<return>
<name>ProcessingNumber</name>
<value>555</value>
</return>
<return>
<name>ThirdPartyAcctRef</name>
<value>444</value>
</return>
<return>
<name>senderID</name>
<value>MOM</value>
</return>
<return>
<name>StatusCode</name>
<value>222</value>
</return>
<return>
<name>StatusDesc</name>
<value>333</value>
</return>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 87
SDP Solution API Reference (MobileMoney)

1 SOAP APIs

<return>
<name>MOMTransactionID</name>
<value>111</value>
</return>
</ns1:processRequestResponse>
</soapenv:Body>
</soapenv:Envelope>

Message Body Parameters

Table 1-16, Table 1-25, Table 1-35, Table 1-44 and Table 1-53 define the fields in an error response sent by
the server to the client.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 88
2 HTTP APIs

HTTP APIs
2.1 Overviews
02
Following APIs are applicable only for OpCos where Ericsson Mobile Money Platform exists.

2.1.1 MT Message Header

Request Message Header Parameters
rd
Table 2-1 describes the parameters in a MT request message header. When the 3 Party invokes APIs
exposed by the SDP, MT Message Header must present. MT Message Header is not available for following
APIs: getfinancialresourceinformation, preapprovalcompleted, verifyfinancialresourceinformation, withdraw.
Table 2-1 parameters in a MT request message header

Header Paramet Type Length Level of Description

Field er Requirement

Authoriza / String 10 Mandatory Authentication mode.

tion The SDP uses the WSSE authentication mode, in
which the realm and profile parameters are involved.
NOTE
The Authorization value indicates the policy used by the
SDP to perform authentication at the application layer. The
SDP authenticates a third-party in WSSE UsernameToken
mode.
[Example]
WSSE

realm String 20 Mandatory Set it to SDP.

[Example]
SDP

profile String 20 Mandatory SDP access mechanism. Set it to UsernameToken.

[Example]
UsernameToken

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 89
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

X-WSSE / String 30 Mandatory WSSE authentication flag.

To enable the SDP to perform authentication at the
application layer in the WSSE UsernameToken mode,
set this parameter to UsernameToken.
[Example]
UsernameToken
Usernam String 21 Mandatory Partner ID.
e The ID is automatically allocated by the SDP to
partners after successful registration. To obtain the ID:
A service Partner and API Partner can log in to the
SDP Management Portal and query account
information, or log in to the mailbox used for
registration and view the email notification received
after successful registration.
A Developer can log in to the Developer Portal and
query account information, or log in to the mailbox
used for registration and view the email notification
received after successful registration.
[Example]
2340110001412

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 90
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

Passwor String 100 Mandatory Authentication key for the SDP to authenticate
dDigest partners.
The value is a character string encrypted. The
encryption formula is as follows:
SHA-256: PasswordDigest =
Base64(SHA-256(Nonce + Created + Password))
SHA-1: PasswordDigest = Base64(SHA-1(Nonce +
Created + Password))
In the formula:
Nonce and Created: random number and its
generation time.
Password: password for partners to access the
SDP.
A service Partner and API Partner can obtain
the password from the email notification
received after successful registration.
A Developer can log in to the Developer
Portal, choose Member Center > Account >
Registration Information > Invoke
Password, and set the password.

To retain features of earlier versions, the SP uses the SHA-1

algorithm in the connection to the SDP, which might cause
security risks.
[Example]
206D88BB7F3D154B130DD6E1E0B8828B

Nonce String 30 Mandatory Random number generated by SDP when sending a

message.
[Example]
66C92B11FF8A425FB8D4CCFE0ED9ED1F

Created String 20 Mandatory UTC time when the Nonce value is generated.
[Format]
yyyy-MM-dd'T'HH:mm:ss'Z'
[Example]
2011-03-22T13:47:56Z

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 91
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

X-Reque / String 10 Mandatory Type of the message sent by a third party.

stHeader Set it to request.
[Example]
request

ServiceId String 21 Conditional Service ID.

The ID is automatically allocated by the SDP to
services after successful release. A service Partner
can log in to the SDP management portal and query
service information for the ID.
The serviceId must be contained during invocation of
a service interface developed by service partners and
other partners, and must not be contained during
invocation of a capability interface developed by API
partners, other partners, and developers.
[Example]
35000001000001

TransId String 30 Mandatory Transaction ID.

The ID is automatically generated by the SDP and is
used only to trace messages during the SDP
commissioning. The App ignores this parameter.
[Example]
100001200101110623021721000011

LinkId String 20 Conditional Service order ID.

The ID is automatically generated by the SDP when a
user orders a service in the SDP. This parameter is
mandatory during service ordering by SMS message.
[Example]
12345678901111
FA xsd:strin 30 Mandatory Mobile number or the fake ID of the charged party.
g [Example]
Mobile number: 8612312345678
Fake ID: f-245-11900000007639

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 92
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

Cookie sessioni String - Conditional The session id is used as a cookie in the HTTP header
d in the requests towards the Mobile Money Manager
when the Partner use Login/Logout mode.
[Example]
default8fcee064690b45faa9f8f6c7e21c5e5a
NOTE
Cookie is valid only for ECW and not for fundamo.

Msisdn / String Mandatory A valid unique MSISDN of the user.

[Format]
Countrycode + MSISDN number
[Example]
23415905193050

X-HW-Ex / / / Optional Extension field.

tension [Format]
key1=value1;key2=value2

destPartn / String 21 Conditional For an A2A scenario, it indicates the identifier of the
erId destination partner.

Response Message Header Parameters

Table 2-2 describes the parameters in a MT response message header.
Table 2-2 parameters in a MT response message header

Header Paramet Type Length Level of Description

Field er Requirement

WWW-A / String 10 Mandatory Authentication mode.

uthentica The SDP uses the WSSE authentication mode, in
te which the realm and profile parameters are involved.
NOTE
The Authorization value indicates the policy used by the
SDP to perform authentication at the application layer. The
SDP authenticates a third-party in WSSE UsernameToken
mode.
[Example]
WSSE

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 93
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

realm String 20 Mandatory Set it to SDP.

[Example]
SDP
profile String 20 Mandatory SDP access mechanism. Set it to UsernameToken.
[Example]
UsernameToken
Set-Cook sessionid String Conditional The Cookie of the response message when the
ie Partner invokes the Login interface.
[Example]
default1937332605ff4d27a1108f424ade0715
Signature / String Conditional Signature.
The field indicates the summary when the Partner
uses HMAC security mode.
[Example]
43AD232FD45FF
X-HW-Ex / / / Optional Extension field.
tension [Format]
key1=value1;key2=value2

2.1.2 MO Message Header

Request Message Header Parameters
Table 2-3 describes the parameters in a MO request message header. When the SDP sends notification
rd
messages to the 3 party, MO Message Header will present. MO Message Header is only available for
following APIs: getfinancialresourceinformation, preapprovalcompleted, verifyfinancialresourceinformation,
withdraw.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 94
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-3 parameters in a MO request message header

Header Paramet Type Length Level of Description

Field er Requirement

Authoriza / String 10 Mandatory Authentication mode.

tion The SDP uses the WSSE authentication mode, in
which the realm and profile parameters are involved.
NOTE
The Authorization value indicates the policy used by the
SDP to perform authentication at the application layer. The
SDP authenticates a third-party in WSSE UsernameToken
mode.
[Example]
WSSE

realm String 20 Mandatory Set it to SDP.

[Example]
SDP

profile String 20 Mandatory SDP access mechanism. Set it to UsernameToken.

[Example]
UsernameToken

X-WSSE / String 30 Mandatory WSSE authentication flag.

To enable the SDP to perform authentication at the
application layer in the WSSE UsernameToken mode,
set this parameter to UsernameToken.
[Example]
UsernameToken

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 95
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

Usernam String 21 Mandatory Partner ID.

e The ID is automatically allocated by the SDP to
partners after successful registration. To obtain the ID:
A service Partner and API Partner can log in to the
SDP Management Portal and query account
information, or log in to the mailbox used for
registration and view the email notification received
after successful registration.
A Developer can log in to the Developer Portal and
query account information, or log in to the mailbox
used for registration and view the email notification
received after successful registration.
[Example]
2340110001412

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 96
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

Passwor String 100 Mandatory Authentication key for the SDP to authenticate
dDigest partners.
The value is a character string encrypted. The
encryption formula is as follows:
SHA-256: PasswordDigest =
Base64(SHA-256(Nonce + Created + Password))
SHA-1: PasswordDigest = Base64(SHA-1(Nonce +
Created + Password))
In the formula:
Nonce and Created: random number and its
generation time.
Password: password for partners to access the
SDP.
A service Partner and API Partner can obtain
the password from the email notification
received after successful registration.
A Developer can log in to the Developer
Portal, choose Member Center > Account >
Registration Information > Invoke
Password, and set the password.

To retain features of earlier versions, the SP uses the SHA-1

algorithm in the connection to the SDP, which might cause
security risks.
[Example]
206D88BB7F3D154B130DD6E1E0B8828B

Nonce String 30 Mandatory Random number generated by SDP when sending a

message.
[Example]
66C92B11FF8A425FB8D4CCFE0ED9ED1F

Created String 20 Mandatory UTC time when the Nonce value is generated.
[Format]
yyyy-MM-dd'T'HH:mm:ss'Z'
[Example]
2011-03-22T13:47:56Z

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 97
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

X-NotifyH / String 10 Mandatory Type of the message sent by the SDP.

eader Set it to notify.
[Example]
notify

TransId String 30 Mandatory Transaction ID.

The ID is automatically generated by the SDP and is
used only to trace messages during the SDP
commissioning. The App ignores this parameter.
[Example]
100001200101110623021721000011

LinkId String 20 Conditional Service order ID.

The ID is automatically generated by the SDP when a
user orders a service in the SDP. This parameter is
mandatory during service ordering by SMS message.
[Example]
12345678901111

X-HW-Ex / / / Optional Extension field.

tension [Format]
key1=value1;key2=value2

Response Message Header Parameters

Table 2-4 describes the parameters in a MO response message header.
Table 2-4 parameters in a MO response message header

Header Paramet Type Length Level of Description

Field er Requirement

WWW-A / String 10 Mandatory Authentication mode.

uthentica The SDP uses the WSSE authentication mode, in
te which the realm and profile parameters are involved.
NOTE
The Authorization value indicates the policy used by the
SDP to perform authentication at the application layer. The
SDP authenticates a third-party in WSSE UsernameToken
mode.
[Example]
WSSE

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 98
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Header Paramet Type Length Level of Description

Field er Requirement

realm String 20 Mandatory Set it to SDP.

[Example]
SDP
profile String 20 Mandatory SDP access mechanism. Set it to UsernameToken.
[Example]
UsernameToken
Signature / String Conditional Signature.
The field indicates the summary when the Partner
uses HMAC security mode.
[Example]
43AD232FD45FF

X-HW-Ex / / / Optional Extension field.

tension [Format]
key1=value1;key2=value2

2.1.3 MO Message Header for A2A Scenario

For A2A scenario, when the 3rd Party invokes APIs exposed by the SDP, these headers must present. These
headers are only available for following APIs:
validateaccountholder,getfinancialresourceinformation,verifyfinancialresourceinformation,preapprovalcomplet
ed,withdraw
Request Message Header Parameters
Paramet Type Length Level of Description
er Requirement

version String 5 Mandatory Protocol version number.

Set this parameter to 1.0.

traceUniq String 30 Mandatory Message ID.

ueID Value of traceUniqueID is in the format
AAAAAAAXXXXBBBBBBBBBBBBCCCCDDD, which
consists of 30 digits.
AAAAAAA indicates the type of the first component or
module that generates traceUniqueID. The value of
AAAAAAA is the same as the ID of the product module.
Prefix the module ID of less than 7 digits with zeros.
XXXX: identifies a node of the component that
generates traceUniqueID if the component is

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 99
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Paramet Type Length Level of Description

er Requirement
deployed in a cluster. The value is the sum of the
four octets of the IP address for the node. Assume
that the IP address of a node is 192.168.10.2. The
value of XXXX is 0372.
BBBBBBBBBBBB: dynamically generated by the
first component that generates traceUniqueID. The
entry component must ensure that the value of
traceUniqueID is unique in different messages. It is
recommended that BBBBBBBBBBBB should be
generated as YYMMDDHHMMSS, where YY
indicates the year, such as 09; the first MM indicates
the month, such as 08; DD indicates the day, such
as 31; HH indicates the hour, such as 13; the
second MM indicates the minute, such as 31; SS
indicates the second, such as 31.
CCCC: indicates the serial number that begins with
0001. The component that generates
traceUniqueID needs to check whether the first 23
digits of a service process are the same. If yes, the
component distinguishes the service process by
using CCCC. The value of CCCC ranges from 0001
to 9999 (assume that a maximum of 9999 service
operations can be performed in a second).
DDD: indicates the serial number of the message.
The value of DDD in traceUniqueID generated by
the first component is 001. Otherwise, increase the
value of DDD in traceUniqueID by 1.

sourceDe Int4 4 Mandatory SP type. This parameter has a fixed value of 110000.
viceType

sourceDe String 21 Mandatory SP ID.

viceCode
destDevi Int4 4 Mandatory SAG type. This parameter has a fixed value of 1000.
ceType
destDevi String 21 Mandatory SAG ID. This parameter has a fixed value of 1000.
ceCode
authentic String 256 Optional Access password of the SP. The password encryption
atorSour formula is as follows:
ce MD5(SPID+PASSWORD+TIMESTAMP)
timeStam String 14 Optional Time stamp in the format YYYYMMDDHHMMSS. The

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 100
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Paramet Type Length Level of Description

er Requirement
p time must be UTC time.

destPartn String 10 Mandatory For an A2A scenario, it indicates the identifier of the
erId destination partner.
extension String 100 Optional Extended field.
[Format]
key1=value1;key2=value2

2.2 Account Validation & Information

2.2.1 login
Process
Figure 2-1 Process of login

Function
Identifying oneself to the system by entering ones credential.

Request URI
The request URI is the destination URI of login messages sent by the App to the SDP. The URI is provided by
the SDP in the following format:
http://IP:Port/mom/mt/login

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 101
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/login HTTP/1.1
Content-Type:text/xml
Content-Length:1069
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:loginrequest xmlns:ns2="http://www.ericsson.com/lwac">
<identity>sp1</identity>
<credential>
<secret>ABc123456!</secret>
<type>password</type>
</credential>
</ns2:loginrequest>

Message Body Parameters

Table 2-5 describes parameters in a message body.
Table 2-5 Parameters in a message body

Parameter Type Length Level of Requirement Description

identity string Mandatory Identity of user.

credential credential Mandatory Credential used to verify the users
identity.
newcredential credential Optional Used if the credential shall be
replaced during login.

Table 2-6 describes parameters of credential.

Table 2-6 Parameters of credential

Parameter Type Length Level of Requirement Description

secret string Mandatory Credential secret

type string Mandatory Credential type

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 102
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Response
An empty response indicates success.
A success response example:
HTTP/1.1 200 OK
Signature:43AD232FD45FF
Content-Length: 0
Server: Jetty(7.5.4.v20111024)

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

2.2.2 Logout
Process
Figure 2-12 shows the process of logout request.
Figure 2-2 Process of logout request

Function
The APP (functioning as the client) invokes the Logout API to log out to the SDP (functioning as the server).

Request URI
The request URI is the destination URI of logout messages sent by the App to the SDP. The URI is provided
by the SDP in the following format:
http://IP:Port/mom/mt/logout

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 103
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request
The SDP functions as the client and sends a Logout message to the App.

Message Body Example

The message body is empty.
POST /mom/mt/logout HTTP/1.1
Content-Type:text/xml
Content-Length:1069
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

Message Body Parameters

None

Response
An empty response indicates success.
A success response example:
HTTP/1.1 200 OK
Signature:43AD232FD45FF
Content-Length: 0
Server: Jetty(7.5.4.v20111024)

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 104
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.2.3 validateaccountholder
Process
Figure 2-3 Process of validateaccountholder

Function
This operation is used by the Partner to check if an account holder is registered and active in the system.

Request URI
The request URI is the destination URI of validateaccountholder messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/validateaccountholder
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/validateaccountholder HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 105
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<ns2:validateaccountholderrequest xmlns:ns2="http://www.ericsson.com/em/emm/sp/backend">
<accountholderid>ID:20200009999/MSISDN</accountholderid>
</ns2:validateaccountholderrequest>

Message Body Parameters

Table 2-7 describes parameters in a validateaccountholder message body.
Table 2-7 Parameters in a validateaccountholder message body

Parameter Type Length Level of Requirement Description

accountholderid string Mandatory The identity of the account holder to

validate.
Parameter cannot be NULL.
[Example]
ID:46733491234/MSISDN.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<ns2:validateaccountholderresponse xmlns:ns2="http://www.ericsson.com/em/emm/sp/backend">
<valid>true</valid>
</ns2:validateaccountholderresponse>

Table 2-8 describes parameters in a response message body.

Table 2-8 Parameters in a validateaccountholder response message body

Parameter Type Length Level of Description

Requirement

valid boolean Mandatory TRUE means that requested identity is an account

holder that can receive any transaction.
FALSE: Means that identity either not found or it is not
able to receive any transaction.
Parameter cannot be NULL.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 106
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.2.4 getfinancialresourceinformation
Process
Figure 2-4 Process of getfinancialresourceinformation

Function
This operation is used to fetch generic data for a specific resource for a customer in the Partner system. The
information returned can be any data, such as loan information, electricity meter status, TV subscription
details. This can be used as a complement to the getbalance operation, since it only returns a balance. The
information in the response is just passed through the system to the end-user requesting it.

Request URI
The request URI is the destination URI of getfinancialresourceinformation messages sent by the SDP to the
App. The URI is defined by the App.

Request Message Body Example

POST /mom/mo/getreversetransactiondetails HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-NotifyHeader: notify TransId=" 200903241230451000000123456789" , LinkId="A15Y89Z32T99"
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<getfinancialresourceinformationrequest xmlns ="http://www.ericsson.com/em/emm/sp/backend" >
<resource>123</resource>
<accountholderid>ID:4673349175/MSISDN</accountholderid>
<extension>11</extension>
</getfinancialresourceinformationrequest>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 107
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Message Body Parameters

Table 2-9 describes parameters in a message body.
Table 2-9 Parameters in a message body

Parameter Type Length Level of Requirement Description

resource string Mandatory The Financial Resource Identifier of

the sending account.
Parameter cannot be NULL.

accountholderid string Mandatory The MSISDN identity of the account

holder that is performing the
operation.
For example:
ID:46733491234/MSISDN

extension extensiontype - Optional Used for sending any additional

information to Partner.
For details about extensiontype, see
Table 2-32.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<getfinancialresourceinformationresponse xmlns ="http://www.ericsson.com/em/emm/sp/backend" >
<message>11</message>
<extension>11</extension>
</getfinancialresourceinformationresponse>

Table 2-10 describes parameters in a response message body.

Table 2-10 Parameters in a response message body

Parameter Type Length Level of Description

Requirement

message string - Optional The list of sub transactions for the requested
transaction. Contains information describing a single
financial instruction
For more details about financialinstructiondetails, see
Table 2-36.

extension extensiontype Optional Any additional information received from Partner.

For details about extensiontype, see Table 2-32.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 108
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Error Codes
The App returns error codes to the SDP when an exception occurs in response to
getfinancialresourceinformation messages. The error codes are defined by partners.
Table 2-11 describes getfinancialresourceinformation error codes that the partners may return upon an
exception.
Table 2-11 getfinancialresourceinformation error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Mobile Money platform userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

2.2.5 verifyfinancialresourceinformation
Process
Figure 2-5 Process of verifyfinancialresourceinformation

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 109
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Function
This operation is used to ask the Partner if the account in their system may be linked to the account holders
eWallet in the Mobile Money Manager. This is primarily relevant for micro finance services, like loans and
savings accounts. Once the Partner confirms the link, this external account is added to the account holder in
system, and they can start using this account through operations such as BalanceRequest and
Withdrawrequest.

Request URI
The request URI is the destination URI of verifyfinancialresourceinformation messages sent by the SDP to the
App. The URI is defined by the App.

Request Message Body Example

POST /mom/mo/getreversetransactiondetails HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-NotifyHeader: notify TransId=" 200903241230451000000123456789" , LinkId="A15Y89Z32T99"
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<ns2:verifyfinancialresourceinformationrequest
xmlns:ns2="http://www.ericsson.com/em/emm/sp/backend">
<resource>FRI:[email protected]/SP</resource>
<accountholderid>ID:20200009999/MSISDN</accountholderid>
</ns2:verifyfinancialresourceinformationrequest>

Message Body Parameters

Table 2-12 describes parameters in a message body.
Table 2-12 Parameters in a message body

Parameter Type Length Level of Description

Requirement

resource string Mandatory The FRI of the account, bill or user in the partner system.
Parameter cannot be NULL.
For example,
FRI:[email protected]/SP.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 110
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

accounthold string Mandatory The MSISDN identity of the account holder.

erid Parameter cannot be NULL.
For example:
ID:46733491234/MSISDN
extension extensio - Optional Used for sending any additional information to Partner.
ntype For details about extensiontype, see Table 2-32.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<ns4:verifyfinancialresourceinformationresponse
xmlns:ns4="http://www.ericsson.com/em/emm/sp/backend">
<valid>true</valid>
<extension/>
</ns4:verifyfinancialresourceinformationresponse>

Table 2-13 describes parameters in a response message body.

Table 2-13 Parameters in a response message body

Parameter Type Length Level of Description

Requirement

valid boolean Mandatory True if account holder and service resource is valid in
Partner system.
Parameter cannot be NULL.
extension extensiontype Optional Any additional information received from Partner.
For details about extensiontype, see Table 2-32.

Error Codes
The App returns error codes to the SDP when an exception occurs in response to
verifyfinancialresourceinformation messages. The error codes are defined by partners.
Table 2-14 describes verifyfinancialresourceinformation error codes that the partners may return upon an
exception.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 111
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-14 verifyfinancialresourceinformation error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Mobile Money platform userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

2.2.6 getaccountholderidentification
Process
Figure 2-6 Process of getaccountholderidentification

Mobile
App SDP
Money
getaccountholderidentification
Request
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId
getaccountholderidentification
Request
3
getaccountholderidentification
Response
4
getaccountholderidentification API message
Response
2 Key parameters during
internal processing

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 112
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Function
This operation is used by the Partner to query the account holders identification.

Request URI
The request URI is the destination URI of getaccountholderidentification messages sent by the App to the
SDP. The URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/getaccountholderidentification
In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getaccountholderidentification HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 256772712580
X-HW-Extension: k1=v1;k2=v2

<ns2:getaccountholderidentificationrequest
xmlns:ns2="http://www.ericsson.com/em/emm/provisioning/v1_0">
<identity>ID:256772712580/MSISDN</identity>
</ns2:getaccountholderidentificationrequest>

Message Body Parameters

Table 2-15 describes parameters in a getaccountholderidentification message body.
Table 2-15 Parameters in a getaccountholderidentification message body

Parameter Type Length Level of Requirement Description

identity String Optional A valid identity associated with the

account holder. Validated with
IsIdentity. This shall be users
MSISDN.

Response
A success response example:

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 113
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<?xml version="1.0" encoding="UTF-8"?>

<n1:getaccountholderidentificationresponse
xmlns:n1="http://www.ericsson.com/em/emm/provisioning/v1_0">
<identifications>
<identification>
<Id>a</Id>
<IdTp>PASS</IdTp>
</identification>
<identification>
<Id>a</Id>
<IdTp>PASS</IdTp>
</identification>
</identifications>
</n1:getaccountholderidentificationresponse>

Table 2-16 describes parameters in a response message body.

Table 2-16 Parameters in a getaccountholderidentification response message body

Parameter Type Length Level of Description

Requirement

identifications Identification - Optional

[0unboun
ded]

Table 2-17 describes parameters in a Identification.

Table 2-17 Parameters in Identification structure

Parameter Type Length Level of Description

Requirement

Id xsd:string 35 Mandatory

IdTp xsd:string 4 Optional Possible values are:

PASS
CPFA
SRSA
NRIN
OTHR
DRLC
SOCS
AREG
IDCD
EMID

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 114
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

XtndedIdTp xsd:string 350 Optional Either IdTp or XtndedIdTp will present.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.
2.2.7 getaccountholderinfo
Process
Figure 2-7 Process of getaccountholderinfo

Mobile
App SDP
Money

getaccountholderinfo
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId

getaccountholderinfo
3
getaccountholderinfoResponse
4
getaccountholderinfoResponse API message
2 Key parameters during
internal processing

Function
This operation is used by the Partner to query the account holders information.

Request URI
The request URI is the destination URI of getaccountholderinfo messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/getaccountholderinfo
In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getaccountholderinfo HTTP/1.1
Content-Type:text/xml
Content-Length:569

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 115
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789",
LinkId="A15Y89Z32T99", FA="8613912345678"
Signature:43AD232FD45FF
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 256772712580
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns2:getaccountholderinforequest xmlns:ns2="http://www.ericsson.com/em/emm/provisioning/v1_1">
<identity>ID:256772712580/MSISDN</identity>
</ns2:getaccountholderinforequest>

Message Body Parameters

Table 2-18 describes parameters in a getaccountholderinfo message body.
Table 2-18 Parameters in a getaccountholderinfo message body

Parameter Type Length Level of Requirement Description

identity String Optional A valid identity associated with the

account holder. Validated with
IsIdentity. This shall be users
MSISDN.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<n1:getaccountholderinforesponse xmlns:n1="http://www.ericsson.com/em/emm/provisioning/v1_0">
<accountholderbasicinfo>
<msisdn>20200009999</msisdn>
<firstname>lili</firstname>
<surname>Li</surname>
</accountholderbasicinfo>
</n1:getaccountholderidentificationresponse>

Table 2-19 describes parameters in a response message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 116
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-19 Parameters in a getaccountholderinfo response message body

Parameter Type Length Level of Description

Requirement

accountholder accounthold - Optional

basicinfo erbasicinfoT
ype

Table 2-20 describes parameters in the accountholderbasicinfoType.

Table 2-20 Parameters in accountholderbasicinfoType structure

Parameter Type Length Level of Description

Requirement

msisdn xsd:string 35 Optional The account holder number.

firstname xsd:string 30 Optional The firstname of the account holder

surname xsd:string 30 Optional The surname of the account holder

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 117
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.3 Approval
2.3.1 preapproval
Process
Figure 2-8 Process of preapproval

Function
A pre-approval enables a Partner to debit an account holder without the user having to approve each
operation separately.

Request URI
The request URI is the destination URI of preapproval messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/mom/mt/preapproval
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 118
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Request Message Body Example

POST /mom/mt/preapproval HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<ns2:preapprovalrequest xmlns:ns2="http://www.ericsson.com/em/emm/sp/backend">
<fromfri>ID:2341305205559/MSISDN</fromfri>
<tofri>ID:2341305205559/MSISDN</tofri>
<message>abc</message>
</ns2:preapprovalrequest>

Message Body Parameters

Table 2-21 describes parameters in a preapproval message body.
Table 2-21 Parameters in a preapproval message body

Parameter Type Length Level of Requirement Description

fromfri string Mandatory The Financial Resource Identifier of

the sending account.
Parameter cannot be NULL.

tofri string Mandatory The Financial Resource Identifier of

the receiving account.
Parameter cannot be NULL.
message string Mandatory Message to the end user.
Parameter cannot be NULL.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<preapprovalresponse xmlns="http://www.ericsson.com/em/emm/sp/backend">
<preapprovalid>123</preapprovalid>
<status>APPROVED</status>
</preapprovalresponse>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 119
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-22 describes parameters in a preapproval response message body.

Table 2-22 Parameters in a preapproval response message body

Parameter Type Length Level of Description

Requirement

preapprovalid long Mandatory The identity of the preapproval.

Parameter cannot be NULL.

status preapproval - Mandatory The status of the preapproval.

status Parameter cannot be NULL.
[Enumeration]
PENDING
APPROVED
REJECTED
EXPIRED

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

2.3.2 getPreApprovalStatus
Process
Figure 2-9 Process of getPreApprovalStatus

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 120
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Function
It is used by the Partner to fetch the status of a previously sent getPreApprovalStatus.

Request URI
The request URI is the destination URI of getPreApprovalStatus messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/getPreApprovalStatus
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getPreApprovalStatus HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<ns2:getpreapprovalstatusrequest xmlns:ns2=" http://www.ericsson.com/em/emm">

<preapprovalid>12.23</preapprovalid>
<fromfri>REPORT</fromfri>
<tofri>SUMMARY</tofri>
</ns2:getpreapprovalstatusrequest>

Message Body Parameters

Table 2-23 describes parameters in a message body.
Table 2-23 Parameters in a message body

Parameter Type Length Level of Requirement Description

preapprovalid long Mandatory ID of the pre-approval request.

Parameter cannot be NULL.

fromfri string Mandatory The Financial Resource Identifier of

the sending account.
Parameter cannot be NULL. Validated
with IsFRI.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 121
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

tofri string Mandatory The Financial Resource Identifier of

the receiving account. Parameter
cannot be NULL.
Validated with IsFRI.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<getpreapprovalstatusresponse xmlns=http://www.ericsson.com/em/emm>
<status>1</status>
</getpreapprovalstatusresponse>

Table 2-24 describes parameters in a response message body.

Table 2-24 Parameters in a response message body

Parameter Type Length Level of Requirement Description

status preapproval - Mandatory Current status of the preapproval.

status Parameter cannot be NULL.
[Enumeration]
PENDING
APPROVED
REJECTED
EXPIRED

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 122
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.3.3 preapprovalcompleted
Process
Figure 2-10 Process of preapprovalcompleted

Function
The Mobile Money Manager will send this request to the Service Provider when the user has confirmed the
approval, or if the pre-approval has expired.

Request URI
The request URI is the destination URI of preapprovalcompleted messages sent by the SDP to the App. The
URI is defined by the App.

Request Message Body Example

POST /mom/mo/getreversetransactiondetails HTTP/1.1
Content-Type:text/xml
Content-Length:569

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 123
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-NotifyHeader: notify TransId=" 200903241230451000000123456789" , LinkId="A15Y89Z32T99"
X-HW-Extension: k1=v1;k2=v2

<preapprovalcompletedrequest xmlns=" http://www.ericsson.com/em/emm/sp/backend">

<preapprovalid>1.2</preapprovalid>
<status>PENDING</status>
<receiverinfo>
<fri>123</fri>
<name>12</name>
<msisdn>12</msisdn>
<emailadresses>
<email>12</email>
</emailadresses>
</receiverinfo>
</preapprovalcompletedrequest>

Message Body Parameters

Table 2-25 describes parameters in a message body.
Table 2-25 Parameters in a message body

Parameter Type Length Level of Requirement Description

preapprovalid long Mandatory ID of the preapproval.

Parameter cannot be NULL.

status preapproval Mandatory Current status of the preapproval.

status Parameter cannot be NULL.
[Enumeration]
PENDING
APPROVED
REJECTED
EXPIRED

receiverinfo receiverinfo - Mandatory Information about the receiving party.

Parameter cannot be NULL.
For more details about receiverinfo, see Table
2-26.

Table 2-26 describes parameters in receiverinfo.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 124
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-26 Parameters in receiverinfo

Parameter Type Length Level of Requirement Description

fri string Mandatory FRI for receivers account to which the

amount was credited.

name string Optional Name of receiving party.

msisdn string - Optional MSISDN of receiving party.

email list<emailaddr Optional Email addresses of receiving party.

ess> For more details about
list<emailaddress>, see Table 2-27.
language string Optional Preferred language code.

Table 2-27 describes parameters in list<emailaddress>.

Table 2-27 Parameters in list<emailaddress>

Parameter Type Length Level of Requirement Description

address string - Optional Validated with IsEmail.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<preapprovalcompletedresponse xmlns="http://www.ericsson.com/em/emm/sp/backend"/>

Error Codes
The App returns error codes to the SDP when an exception occurs in response to preapprovalcompleted
messages. The error codes are defined by partners.
Table 2-28 describes preapprovalcompleted error codes that the partners may return upon an exception.
Table 2-28 Preapprovalcompleted error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

04 Payment below minimum.

05 Invalid Mobile Money platform userid/password.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 125
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Error Code Description

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

2.3.4 cancelpreapproval
Process
Figure 2-11 Process of cancelpreapproval

Mobile
App SDP
Money

cancelpreapprovalRequest
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId

cancelpreapprovalRequest
3
cancelpreapprovalResponse
4
cancelpreapprovalResponse API message
2 Key parameters during
internal processing

Function

The App can invoke this API to cancel one or all pre-approvals for the logged in account holder.

Request URI
The request URI is the destination URI of cancelpreapproval messages sent by the App to the SDP. The URI
is provided by the SDP in the following format:
http://IP:Port/mom/mt/cancelPreApproval

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 126
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/cancelPreApproval HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-NotifyHeader: notify TransId=" 200903241230451000000123456789" , LinkId="A15Y89Z32T99"
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<fr:cancelpreapprovalrequest
xmlns:fr="http://www.ericsson.com/em/emm/serviceprovider/v1_0/frontend" version="1.0">
<identity>identity0</identity>
<fri>fri0</fri>
<preapprovalid>preapprovalid0</preapprovalid>
</fr:cancelpreapprovalrequest>

Message Body Parameters

Table 2-29 describes parameters in a message body.
Table 2-29 Parameters in a message body

Parameter Type Length Level of Requirement Description

identity string Optional The account holder's internal identity.

If set, all pre-approvals for this
account holder will be cancelled. Only
a logged in user with permission
ROLE_CANCEL_ANY_PREAPPRO
VAL can cancel all pre-approvals for a
specific account holder.
fri string Optional The FRI to cancel all pre-approvals
from. If no FRI, and no pre-approval
identity is supplied, then all
pre-approvals for the logged in user
are cancelled.
preapprovalid string Optional Omit to cancel more than one
pre-approval.

Response
A success response example:

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 127
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<?xml version="1.0" encoding="UTF-8"?>

<fr:cancelpreapprovalresponse
xmlns:fr="http://www.ericsson.com/em/emm/serviceprovider/v1_0/frontend"/>

Error Codes
For details about the error codes, see 2.7 API Error Response.

2.4 Transaction Details

2.4.1 Paymentcompleted
Process
Figure 2-12 shows the process of notifying about the completion of a previously initiated payment request.
Figure 2-12 Process of notifying about the completion of a previously initiated payment request

Function
The APP (functioning as the client) invokes the Paymentcompleted API to notify about the completion of a
previously initiated payment request to the SDP (functioning as the server).
Partners must code the App based on the API field requirements so that the App can send correct requests to
the SDP. The SDP must send a response within 180 seconds by default.

Request URI
The request URI is the destination URI of Paymentcompleted messages sent by the App to the SDP. The URI
is provided by the SDP in the following format:
http://IP:Port/mom/mt/paymentcompleted

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 128
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request
The SDP functions as the client and sends a Paymentcompleted message to the App to query account
balance.

Message Body Example

POST /mom/mt/paymentcompleted HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns4:paymentcompletedrequest xmlns:ns4="http://www.ericsson.com/em/emm/sp/backend">
<transactionid>2110266</transactionid>
<providertransactionid>1351061132147</providertransactionid>
<newbalance>
<amount>110</amount>
<currency>RWF</currency>
</newbalance>
<paymenttoken>ABCDEF</paymenttoken>
<message>Your payment has been performed.</message>
<status>COMPLETED</status>
</ns4:paymentcompletedrequest>

Message Body Parameters

Table 2-30 describes parameters in a Paymentcompleted message body.
Table 2-30 Parameters in a Paymentcompleted message body

Parameter Type Length Level of Requirement Description

transactionid long Mandatory System internal transaction id.

Parameter cannot be NULL.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 129
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

providertransactio string Mandatory Service provider transaction id.

nid

newbalance moneydetailst - Optional Balance of the account at the Partner.

ype For details about moneydetailstype,
see Table 2-31.

paymenttoken string Optional Partner payment token.

message string Optional A message to the account holder that

made the payment.

status paymentstatu - Mandatory The status of the payment. Parameter

s cannot be NULL.
[Enumeration]
PENDING
COMPLETED
FAILED

extension extensiontype - Optional Used for sending any additional

information to front end access
module.
For details about extensiontype, see
Table 2-32.

Table 2-31 describes the parameter structure of the moneydetailstype.

Table 2-31 Parameter structure of moneydetailstype

Parameter Type Length Level of Requirement Description

amount decimal Mandatory The monetary amount. Parameter

cannot be NULL.
currency string Mandatory The currency, as an ISO 4217
formatted string. Parameter can not
be NULL.

Table 2-32 describes the extensiontype.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 130
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-32 Parameter extensiontype

name value

Parameter Type Length Level of Requirement Description

any list<object> - Optional Use to send any other information.

Response
An empty response indicates success.
HTTP/1.1 200 OK
Signature:43AD232FD45FF
Content-Length: xxx
Server: Jetty(7.5.4.v20111024)

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns4:paymentcompletedresponse xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:op="http://www.ericsson.com/em/emm/common"
xmlns:ns4="http://www.ericsson.com/em/emm/sp/backend"/>

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

2.4.2 gettransactionstatus
Process
Figure 2-13 Process of gettransactionstatus

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 131
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Function
This section describes the operation used to check debit status.

Request URI
The request URI is the destination URI of gettransactionstatus messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/gettransactionstatus
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/gettransactionstatus HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<ns2:gettransactionstatusrequest xmlns:ns2="http://www.ericsson.com/em/emm">
<referenceid>12.23</referenceid>
<identity>REPORT</identity>
</ns2:gettransactionstatusrequest>

Message Body Parameters

Table 2-33 describes parameters in a gettransactionstatus message body.
Table 2-33 Parameters in a gettransactionstatus message body

Parameter Type Length Level of Requirement Description

referenceid string Mandatory Reference Id which has been entered

by user, while initiating the
transaction.
Parameter cannot be NULL.
identity string Optional A valid identity associated with the
account holder that performed the

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 132
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

requested transaction.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<n1:gettransactionstatusresponse xmlns:n1="http://www.ericsson.com/em/emm">
<transactionid>2147483647</transactionid>
<status>SUCCESSFUL</status>
</n1:gettransactionstatusresponse>

Table 2-34 describes parameters in a gettransactionstatus response message body.

Table 2-34 Parameters in a gettransactionstatus response message body

Parameter Type Length Level of Description

Requirement

transactionid long Mandatory Transaction ID.

Parameter cannot be NULL.
status Financialtra - Mandatory Payment Status.
nsaction Parameter cannot be NULL.
status
[Enumeration]
SUCCESSFUL
PENDING
FAILED

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 133
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.4.3 reversetransaction
Process
Figure 2-14 Process of reversetransaction

Function
Reverses a transaction and all of its potential sub-transactions.

Request URI
The request URI is the destination URI of reversetransaction messages sent by the App to the SDP. The URI
is provided by the SDP in the following format:
http://IP:Port/mom/mt/reversetransaction
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/reversetransaction HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 134
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<ns1:reversetransactionrequest xmlns:ns1="http://www.ericsson.com/em/emm">
<financialtransactionid>1025684</financialtransactionid>
<comment>this is a comment</comment>
<financialinstructiondetails>
<date>Tue Aug 13 08:13:12 UTC 2013</date>
<fromfri>4673349175</fromfri>
<tofri>4673349176</tofri>
<financialinstructiontype>WITHDRAWAL</financialinstructiontype>
<transfertype>TRANSFER</transfertype>
<amount>10.0253654</amount>
<frommessage>this is a frommessage</frommessage>
<tomessage>hello</tomessage>
<externaltransactionid>00124545</externaltransactionid>
</financialinstructiondetails>
</ns1:reversetransactionrequest>

Message Body Parameters

Table 2-35 describes parameters in a message body.
Table 2-35 Parameters in a message body

Parameter Type Length Level of Description

Requirement

financialtransactio long Mandatory The financial transaction id of the original

nid transaction to reverse.
Parameter cannot be NULL.
comment string Mandatory A comment describing the reason for the
reversal. Validated with NotEmpty. Validated with
Length parameter(max=512). Validated with
IsRestrictedString.
financialinstruction list<financialin - Mandatory A list of instructions describing how to perform
details structiondetail the reversal.
s> Contains information describing a single financial
instruction.
Validated with NotEmpty.
For more details about financialinstructiondetails,
see Table 2-36.

Table 2-36 describes parameters in financialinstructiondetails.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 135
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-36 Parameters in financialinstructiondetails

Parameter Type Length Level of Description

Requirement

date date Mandatory The time and date of the sub transaction to
reverse.

fromfri string Mandatory The FRI to transfer from. Validated with IsFRI.
Parameter cannot be NULL.
tofri string - Mandatory The FRI to transfer to. Validated with IsFRI.
Parameter cannot be NULL.

financialinstruction financialinstru - Mandatory The type of financial instruction to perform.

type ctiontype Parameter cannot be NULL.
For more details about the
financialinstructiontype, see Financial
transaction type in the table below.

transfertype transfertype - Mandatory The type of transfer to perform.

Parameter cannot be NULL.

amount decimal Mandatory The amount to send.

Parameter cannot be NULL. Validated with
IsAmount.

frommessage string Optional A message for the sender. Validated with

IsRestrictedString.
tomessage string Optional A message for the receiver. Validated with
IsRestrictedString.
externaltransactio string Optional External id. Validated with Length
nid parameter(max=256). Validated with
IsExternalReferenceString.

Financial transaction type:

DEPOSIT
WITHDRAWAL
TRANSFER
CASH_IN
CASH_OUT
TRANSFER_TO_VOUCHER
TRANSFER_FROM_VOUCHER
PAYMENT_SEND

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 136
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

PAYMENT_RECEIVE
COMMISSIONING
FEE
PERIODIC_FEE
CANCEL_VOUCHER
VIEW_ACTIVE_TOKEN
VIEW_TOKEN
EXPIRE_VOUCHER
BALANCE_ENQUIRY
TRANSACTION_HISTORY_ENQUIRY
REMITTANCE
TRANSFER_TO_INVITATION
TRANSFER_FROM_INVITATION
CANCEL_INVITATION
TRANSFER_FROM_VOUCHER_ATM
PICKUP
REVERSAL
REVERSAL_FEE
REVERSAL_LOY
REVERSAL_COMMISSIONING
ADJUSTMENT
ADJUSTMENT_FEE
ADJUSTMENT_LOY
ADJUSTMENT_COMMISSIONING
BATCH_TRANSFER
RESOURCE_INFORMATION_ENQUIRY
DEBIT
RESOLVE_DEPOSIT
SUSPEND_DEPOSIT
PAYMENT
CUSTODY_ACCOUNTS_TRANSFER
EXTERNAL_TRANSFER
REFUND
INVITE_USER_REWARD
ACCEPT_INVITE_REWARD

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 137
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Response
An empty response indicates success.
<?xml version="1.0" encoding="UTF-8"?>
<reversetransactionresponse xmlns="http://www.ericsson.com/em/emm"/>

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

2.4.4 getreversetransactiondetails
Process
Figure 2-15 Process of getreversetransactiondetails

Function
Get status of previously initiated reversetransaction operation.

Request URI
The request URI is the destination URI of getreversetransactiondetails messages sent by the App to the SDP.
The URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/getreversetransactiondetails
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getreversetransactiondetails HTTP/1.1

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 138
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<ns2:getreversetransactiondetailsrequest xmlns:ns2="http://www.ericsson.com/em/emm">
<financialtransactionid>12.23</financialtransactionid>
</ns2:getreversetransactiondetailsrequest>

Message Body Parameters

Table 2-37 describes parameters in a message body.
Table 2-37 Parameters in a message body

Parameter Type Length Level of Requirement Description

financialtransactio long Mandatory The Financial Resource Identifier of

nid the sending account.
Parameter cannot be NULL.

Response
A success response example:

<?xml version="1.0" encoding="UTF-8"?>

<ns1:getreversetransactiondetailsresponse xmlns:n1="http://www.ericsson.com/em/emm">
<subtransactions>
<subtransaction>
<date>2013</date>
<fromfri>11</fromfri>
<tofri>11</tofri>
<financialinstructiontype>11</financialinstructiontype>
<transfertype>11</transfertype>
<amount>11</amount>
<frommessage>11</frommessage>
<tomessage>11</tomessage>
<externaltransactionid>11</externaltransactionid>
</subtransaction>
</subtransactions>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 139
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

</ns1:getreversetransactiondetailsresponse>

Table 2-38 describes parameters in a response message body.

Table 2-38 Parameters in a response message body

Parameter Type Length Level of Description

Requirement

subtransactio list<financial - Optional The list of sub transactions for the requested
ns instructiond transaction. Contains information describing a single
etails> financial instruction
For more details about financialinstructiondetails, see
Table 2-36.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

2.4.5 withdraw
Process
Figure 2-16 Process of withdraw

Function
The operation transfers money from the account holders account in the Partner system to an eWallet in the
Mobile Money Manager.

Request URI
The request URI is the destination URI of withdraw messages sent by the SDP to the App. The URI is defined
by the App.

Request Message Body Example

POST /mom/mo/getreversetransactiondetails HTTP/1.1
Content-Type:text/xml

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 140
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-NotifyHeader: notify TransId=" 200903241230451000000123456789" , LinkId="A15Y89Z32T99"
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<ns4:withdrawrequest xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:op="http://www.ericsson.com/em/emm/common"
xmlns:ns4="http://www.ericsson.com/em/emm/sp/backend">
<resource>FRI:[email protected]/SP</resource>
<accountholderid>ID:20200009999/MSISDN</accountholderid>
<amount>
<amount>130</amount>
<currency>RWF</currency>
</amount>
<transactionid>2110248</transactionid>
<message>Transfer to</message>
</ns4:withdrawrequest>

Message Body Parameters

Table 2-39 describes parameters in a message body.
Table 2-39 Parameters in a message body

Parameter Type Length Level of Requirement Description

resource string Mandatory The FRI of the account, bill or user in

the partner system.
For example,
FRI:[email protected]/SP

accountholderid string Mandatory The MSISDN identity of the account

holder that is performing the
operation.
For example:
ID:46733491234/MSISDN

amount moneydetailst - Mandatory Amount to be withdrawn.

ype Parameter cannot be NULL.
For details about moneydetailstype,
see Table 2-31.
transactionid long Mandatory System internal transaction id.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 141
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

Parameter cannot be NULL.
message string Optional A descriptive note for Partner.

extension extensiontype - Optional Used for sending any additional

information to Partner.
For details about extensiontype, see
Table 2-32.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns4:withdrawresponse xmlns:ns4="http://www.ericsson.com/em/emm/sp/backend">
<transactionid>2110248</transactionid>
<providertransactionid>1351000005264</providertransactionid>
<status>COMPLETED</status>
<newbalance>
<amount>270</amount>
<currency>RWF</currency>
</newbalance>
<message>THIS IS A MESSAGE TO THE END USER</message>
<extension/>
</ns4:withdrawresponse>

Table 2-40 describes parameters in a response message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 142
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-40 Parameters in a response message body

Parameter Type Length Level of Requirement Description

transactionid long Mandatory System Transaction ID. Parameter

can not be NULL.

providertransactio string Mandatory Transaction id from the service

nid provider system.

status status Mandatory Status of withdrawal operation.

Parameter can not be NULL.
Possible values are:
CREATED
PENDING
COMPLETED
FAILED
EXPIRED

newbalance moneydetailst Optional Balance of the account in the service

ype provider.
For details about moneydetailstype,
see Table 2-31.
message string - Optional A descriptive note for user.

extension extensiontype Optional Any additional information received

from Partner.
For details about extensiontype, see
Table 2-32.

Error Codes
The App returns error codes to the SDP when an exception occurs in response to withdraw messages. The
error codes are defined by partners.
Table 2-41 describes withdraw error codes that the partners may return upon an exception.
Table 2-41 withdraw error codes

Error Code Description

01 Successfully processed transaction.

02 Invalid account details.

03 Transaction not allowed.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 143
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Error Code Description

04 Payment below minimum.

05 Invalid Mobile Money platform userid/password.

06 Payment Entry not found.

07 Missing transaction/message ID.

08 Missing application version.

100 General failure.

101 Field length exceeded.

102 Subscriber could not be identified. (Invalid subscriberID).

103 Duplicate transaction id.

2.5 Batch Processing

2.5.1 startbatchtransfer
Process
Figure 2-17 Process of startbatchtransfer

Function
Start a batch by sending a file containing transaction detail in a multipart HTTP request.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 144
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Request URI
The request URI is the destination URI of startbatchtransfer messages sent by the App to the SDP. The URI
is provided by the SDP in the following format:
http://IP:Port/mom/mt/startbatchtransfer
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/startbatchtransfer HTTP/1.1
Content-Type:text/xml
Content-Length:899
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<ns2:startbatchtransferrequestheader xmlns:ns2= "http://www.ericsson.com/em/emm">

<batchtitle>12.23</batchtitle>
<fromaccountfri>abc</fromaccountfri>
<numberofrecords>123</numberofrecords>
<totalamount>
<amount>abc</amount>
<currency>abc</currency>
</totalamount>
<parsername>abc</parsername>
<parserarguments>
<argument>
<name>abc</name>
<value>abc</value>
</argument>
</parserarguments>
</ns2:startbatchtransferrequestheader>

Message Body Parameters

Table 2-42 describes parameters in a startbatchtransfer message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 145
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-42 Parameters in a startbatchtransfer message body

Parameter Type Length Level of Requirement Description

startbatchtransferr Startbatchtran - Optional See for more details.

equestheader sferrequesthe
ader

Table 2-43 describes parameters in a Startbatchtransferrequestheader message body.

Table 2-43 Parameters in a Startbatchtransferrequestheader message body

Parameter Type Length Level of Requirement Description

batchtitle string Optional The description of the batch, it is set

by the person creating the file.
The description will be present in the
result file. Validated with Length
parameter(max=128). Validated with
IsRestrictedString.

fromaccountfri string Optional The account where money is

transferred from specified as an FRI.
If not specified, the default account of
the logged in user is used. Validated
with IsFRI.

numberofrecords long Mandatory The number of transaction records in

the batch.
Parameter cannot be NULL.
Maximum value: 10000L.

totalamount decimal Mandatory Total sum of amount for all

transactions in transaction details file.
Must be greater than 0 (zero).
Parameter cannot be NULL. Validated
with IsAmount.

currency string Optional Amount currency. Validated with

IsCurrencyCode.
parsername string Optional Name of file parser that will be used to
parse the batch data. System default
parser will be used if this parameter is
not set. Validated with
IsSingleWordString.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 146
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

parserarguments list<propertyty - Optional Parser arguments. Contains the name

pe> and value of a property. For more
details about propertytype, see Table
2-44.

Table 2-44 describes parameters of propertytype.

Table 2-44 Parameters in propertytype

Parameter Type Length Level of Requirement Description

name string - Mandatory The name of the property. Validated with

NotBlank. Validated with
IsASCIISimpleString.

value string Mandatory The value of the property. Validated with

NotBlank. Validated with IsPropertyValue.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<tns:startbatchtransferresponse xmlns:tns="http://www.ericsson.com/em/emm">
<batchtransferid>2147483647</batchtransferid>
</tns:startbatchtransferresponse>

Table 2-45 describes parameters in a startbatchtransfer response message body.

Table 2-45 Parameters in a startbatchtransfer response message body

Parameter Type Length Level of Requirement Description

batchtransferi long Mandatory Numerical identification of the performed

d batch transfer.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 147
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.5.2 approvebatchtransfer
Process
Figure 2-18 Process of approvebatchtransfer

Function
Approves a batch transfer previously created with the startbatchtransfer operation.

Request URI
The request URI is the destination URI of approvebatchtransfer messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/approvebatchtransfer
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/approvebatchtransfer HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 148
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<approvebatchtransferrequest xmlns="http://www.ericsson.com/em/emm">
<batchid xmlns="">2147483647</batchid>
</approvebatchtransferrequest>

Message Body Parameters

Table 2-46 describes parameters in a approvalbatchtransfer message body.
Table 2-46 Parameters in a approvalbatchtransfer message body

Parameter Type Length Level of Requirement Description

batchid long Mandatory The batch id generated by Mobile Money

Manager when the batch was created.
Parameter cannot be NULL.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<approvebatchtransferresponse xmlns="http://www.ericsson.com/em/emm"/>

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 149
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.5.3 cancelbatchtransfer
Process
Figure 2-19 Process of cancelbatchtransfer

Function
Cancel an unprocessed batch transfer.

Request URI
The request URI is the destination URI of cancelbatchtransfer messages sent by the App to the SDP. The URI
is provided by the SDP in the following format:
http://IP:Port/mom/mt/cancelbatchtransfer
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/cancelbatchtransfer HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 150
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<cancelbatchtransferrequest xmlns="http://www.ericsson.com/em/emm">
<batchid xmlns="">2147483647</batchid>
</cancelbatchtransferrequest>

Message Body Parameters

Table 2-47 describes parameters in a message body.
Table 2-47 Parameters in a message body

Parameter Type Length Level of Requirement Description

batchid long Mandatory The batch transfer identification

number.
Parameter cannot be NULL.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<cancelbatchtransferresponse xmlns="http://www.ericsson.com/em/emm"/>

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 151
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.5.4 listbatchtransfer
Process
Figure 2-20 Process of listbatchtransfer

Function
Fetch batch transfers for a specific account, with possibility to also specify time interval and status.

Request URI
The request URI is the destination URI of listbatchtransfer messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/mom/mt/listbatchtransfer
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/listbatchtransfer HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 152
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<ns2:listbatchtransferrequest xmlns:ns2="http://www.ericsson.com/em/emm">
<fromaccountfri>456</fromaccountfri>
<numberofbatches>798</numberofbatches>
<startdate>654</startdate>
<enddate>abc</enddate>
<statuslist>
<status>CREATED</status>
</statuslist>
<extension>abc</extension>
</ns2:listbatchtransferrequest>

Message Body Parameters

Table 2-48 describes parameters in a message body.
Table 2-48 Parameters in a message body

Parameter Type Length Level of Requirement Description

fromaccountfri string Optional List batch transfers originating from this

account. If not specified, the default
account of the logged in user is used.
Validated with IsFRI.

numberofbatches integer Optional The maximum number of batch

transfers to be returned.

startdate string Optional If present, only batch transfers received

from this date and onwards will be
returned. Validated with IsDate
parameter(format=yyyy-MM-dd).

enddate string Optional If present, only batch transfers received

up to this date will be returned.
Validated with IsDate
parameter(format=yyyy-MM-dd).

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 153
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

status list<batchtransf - Optional Batch transfer status list. Contains the

erstatus> different status codes for a batch
transfer.
[Enumeration]
CREATED
APPROVED
ONGOING
COMPLETED
CANCELLED

Response
A success response example:

<?xml version="1.0" encoding="UTF-8"?>

<tns:listbatchtransferresponse xmlns:tns="http://www.ericsson.com/em/emm" >
<batchinfos>
<batchinfo>
<batchid>12</batchid>
<title>title</title>
<receivetimestamp>20130726111233</receivetimestamp>
<completedtimestamp>20130726111234</completedtimestamp>
<fromaccountfri>1</fromaccountfri>
<batchcreatormsisdn>1</batchcreatormsisdn>
<batchcreatorname>1</batchcreatorname>
<batchapprovermsisdn>1</batchapprovermsisdn>
<batchapprovername>1</batchapprovername>
<batchapprovable>1</batchapprovable>
<batchcancelledbymsisdn>1</batchcancelledbymsisdn>
<batchcancelledbyname>1</batchcancelledbyname>
<numberofrecords>1</numberofrecords>
<totalamount>1</totalamount>
<currency>1</currency>
<status>1</status>
<numberofsuccess>1</numberofsuccess>
<numberoffailure>1</numberoffailure>
<totalfee>1</totalfee>
<totaltransferedamount>1</totaltransferedamount>
<transactionrecords>
<transactionrecord>
<transactionidentifier>1</transactionidentifier>
<receiveridtype>1</receiveridtype>
<receiverid>1</receiverid>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 154
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<transactionid>1</transactionid>
<transactiondatetime>1</transactiondatetime>
<amount>1</amount>
<result>1</result>
<reason>1</reason>
<message>1</message>
<fee>1</fee>
<transferedamount>1</transferedamount>
</transactionrecord>
</transactionrecords>
</batchinfo>
</batchinfos>
</tns:listbatchtransferresponse>

Table 2-49 describes parameters in a response message body.

Table 2-49 Parameters in a response message body

Parameter Type Length Level of Requirement Description

batchinfos list<batchinfoty - Optional List of batch transfer information.

pe> Contains information about a batch transfer.
For more details about batchinfotype, see
Table 2-50.

Table 2-50 describes parameters in batchinfotype.

Table 2-50 Parameters in batchinfotype

Parameter Type Length Level of Description

Requirement

batchid long Mandatory Generated by the system when the batch is

accepted.

title string Optional Import CSV file header title.

Validated with IsMultiWordString.

fromaccountfri string Mandatory From account Financial Resource Identifier.

Validated with IsFRI.

batchcreatormsisdn string Mandatory Creator msisdn. Validated with IsMSISDN.

batchcreatorname string Optional Creator name. Validated with IsUsername.

batchapprovermsisdn string Optional Approver msisdn. Validated with IsMSISDN.

batchapprovername string Optional Approver name. Validated with IsUsername.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 155
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

batchapprovable boolean Optional Batch is approvable or not, present if status

is created.

batchcancelledbymsisd string Optional CancelledBy msisdn. Validated with

n IsMSISDN.
batchcancelledbyname string Optional CancelledBy name. Validated with
IsUsername.

receivetimestamp string Mandatory Time stamp when the system received the
start batch request. Validated with IsDate
parameter(format=yyyy-MM-dd HH:mm:ss).

numberofrecords long Mandatory Import CSV file number of records.

totalamount decimal Mandatory Import CSV file total amount.

currency string Mandatory Import CSV file currency. Validated with

IsCurrencyCode.

status string Mandatory Import CSV file status. Validated with

IsSingleWordString.
completedtimestamp string Mandatory Time stamp when the system completed the
batch request. Validated with IsDate
parameter(format=yyyy-MM-dd HH:mm:ss).

numberofsuccess long Optional The number of successfully executed

transfers. Present if status is completed.
numberoffailure long Optional The number of failed transfers.
Present if status is completed.
totalfee decimal Optional The totally withdrawn fee. Present if status is
completed.

totaltransferedamount decimal Optional The totally transferred amount.

Present if status is completed.
transactionrecords list<transacti - Optional List of batch transaction details.
onrecordtyp Contains details about a batch transaction.
e>
For more details about
transactionrecordtype, see Table 2-51.

Table 2-51 describes parameters in transactionrecordtype.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 156
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-51 Parameters in transactionrecordtype

Parameter Type Length Level of Description

Requirement

transactionidentifier string Mandatory The identifier of the transaction record.

Validated with IsExternalReferenceString.

receiveridtype string Mandatory The id type of the receiver, passport,

identification card etc. Validated with
IsRestrictedString.

receiverid string Mandatory The number of the receiver identification.

Validated with IsRestrictedString.

transactionid string Optional Transaction id. Validated with

IsNumericString.
transactiondatetime string Optional Time of transaction. Validated with IsDate
parameter(format=yyyy-MM-ddHH:mm:ss).

amount decimal Mandatory Transaction amount.

result string Mandatory The result of the transaction. Validated with

IsSingleWordString.

reason string Optional Free text. Validated with IsRestrictedString.

message string Optional Transaction message. Validated with
IsRestrictedString.

fee decimal Optional Transaction fee.

transferedamount decimal Optional The amount being transferred.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 157
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.5.5 getbatchtransfer
Process
Figure 2-21 Process of getbatchtransfer

Function
Retrieves information about a specific batch.

Request URI
The request URI is the destination URI of getbatchtransfer messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/mom/mt/getbatchtransfer
In the format, IP and Port indicate the service IP address and SOAP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getbatchtransfer HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 158
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<tns:getbatchtransferrequest xmlns:tns="http://www.ericsson.com/em/emm">
<batchid>2147483647</batchid>
<resulttype>SUMMARY_REPORT</resulttype>
</tns:getbatchtransferrequest>

Message Body Parameters

Table 2-52 describes parameters in a message body.
Table 2-52 Parameters in a message body

Parameter Type Length Level of Requirement Description

batchid long Mandatory The batch id generated by Mobile

Money Manager when the batch was
created.
Parameter cannot be NULL.

resulttype batchtransferr Optional Controls the level of information to

esulttype return.
[Enumeration]
SUMMARY_REPORT
FULL_REPORT
FULL_REPORT_ON_COMPLETED

Response
A success response example:

<?xml version="1.0" encoding="UTF-8"?>

<tns:getbatchtransferresponse xmlns:tns="http://www.ericsson.com/em/emm">
<batchinfo>
<batchid>123</batchid>
<title>11</title>
<receivetimestamp>11</receivetimestamp>
<completedtimestamp>11</completedtimestamp>
<fromaccountfri>11</fromaccountfri>
<batchcreatormsisdn>11</batchcreatormsisdn>
<batchcreatorname>11</batchcreatorname>
<batchapprovermsisdn>11</batchapprovermsisdn>
<batchapprovername>11</batchapprovername>
<batchapprovable>11</batchapprovable>
<batchcancelledbymsisdn>11</batchcancelledbymsisdn>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 159
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<batchcancelledbyname>11</batchcancelledbyname>
<numberofrecords>11</numberofrecords>
<totalamount>11</totalamount>
<currency>11</currency>
<status>11</status>
<numberofsuccess>11</numberofsuccess>
<numberoffailure>11</numberoffailure>
<totalfee>11</totalfee>
<totaltransferedamount>11</totaltransferedamount>
<transactionrecords>
<transactionrecord>
<transactionidentifier>11</transactionidentifier>
<receiveridtype>11</receiveridtype>
<receiverid>11</receiverid>
<transactionid>11</transactionid>
<transactiondatetime>11</transactiondatetime>
<amount>11</amount>
<result>11</result>
<reason>11</reason>
<message>11</message>
<fee>11</fee>
<transferedamount>11</transferedamount>
</transactionrecord>
</transactionrecords>
</batchinfo>
</tns:getbatchtransferresponse>

Table 2-53 describes parameters in a response message body.

Table 2-53 Parameters in a response message body

Parameter Type Length Level of Description

Requirement

batchinfo batchinfotyp - Mandatory Transfer Batch Info.

e For more details about batchinfotype, see Table 2-50.

Error Codes
SDP may return upon an exception. For details about the error codes, see 2.7 API Error Response.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 160
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

2.6 Financial
2.6.1 getTransactionhistory
Process
Figure 2-22 Process of getTransactionhistory
Mobile
App SDP
Money

getTransactionhistoryRequest
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId

getTransactionhistoryRequest
3
getTransactionhistoryResponse
4
getTransactionhistoryResponse API message
2 Key parameters during
internal processing

Function
A getTransactionhistory enables a Partner to query a list of transactions matching the parameters in the
request.

Request URI
The request URI is the destination URI of getTransactionhistory messages sent by the App to the SDP. The
URI is provided by the SDP in the following format:
http://IP:Port/mom/mt/getTransactionhistory
In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/getTransactionhistory HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 161
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,

LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<v1_0:gettransactionhistoryrequest xmlns:ns2="http://www.ericsson.com/em/emm/v1_1/common"
xmlns:fic="http://www.ericsson.com/em/emm/financial/v1_0/common"
xmlns:op="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:ns1="urn:iso:std:iso:20022:tech:xsd"
xmlns:v1_0="http://www.ericsson.com/em/emm/financial/v1_0" version="1.0">
<fri>fri0</fri>
<numoftransactions>50</numoftransactions>
<indexoffset>0</indexoffset>
<financialtransactionid>1111</financialtransactionid>
<externaltransactionid>externaltransactionid0</externaltransactionid>
<transactionstatus>SUCCESSFUL</transactionstatus>
<transactiontype>DEPOSIT</transactiontype>
<transactiontype>DEPOSIT</transactiontype>
<startdatefrom>2006-05-04T18:13:51.0Z</startdatefrom>
<startdateto>2006-05-04T18:13:51.0Z</startdateto>
<datefrom>2006-05-04T18:13:51.0Z</datefrom>
<dateto>2006-05-04T18:13:51.0Z</dateto>
<direction>IN</direction>
<otherfri>otherfri0</otherfri>
<quoteid>quoteid0</quoteid>
</v1_0:gettransactionhistoryrequest>

Message Body Parameters

Table 2-54 describes parameters in a getTransactionhistory message body.
Table 2-54 Parameters in a getTransactionhistory message body

Parameter Type Length Level of Requirement Description

fri string Optional The FRI to get the transactions for.

If not specified the default FRI of the
calling user will be used. Validated
with IsFRI.

numoftransactions int Optional The number of transactions to return

in the response. Default value: 50.
Minimum value: 1. Parameter can not
be NULL.
indexoffset int Optional Start retrieving transaction history
from this index.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 162
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

financialtransactio long Optional Retrieve transaction history with

nid this financial transaction ID.
Validated with IsPositiveLong
(allowZero=false).

externaltransactio string Optional Retrieve transaction history with this

nid external transaction ID. Validated
with IsExternalReferenceString.

transactionstatus string Optional Retrieve transaction history with this

status.
Possible values are:
SUCCESSFUL
PENDING
FAILED

transactiontype string[0unb Optional Retrieve transaction history with this

ounded] transaction type. It is possible to
have more than one transactiontype
element to filter on. Shows the
financial transaction type
Possible values are:
DEPOSIT
REVERSE_DEPOSIT
WITHDRAWAL
TRANSFER
CASH_IN
CASH_OUT
TRANSFER_TO_VOUCHER
TRANSFER_FROM_VOUCHER
PAYMENT_SEND
PAYMENT_RECEIVE
COMMISSIONING
FEE
PERIODIC_FEE
CANCEL_VOUCHER
VIEW_ACTIVE_TOKEN
VIEW_TOKEN
EXPIRE_VOUCHER

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 163
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

BALANCE_ENQUIRY
TRANSACTION_HISTORY_ENQUI
RY
REMITTANCE
TRANSFER_TO_INVITATION
TRANSFER_FROM_INVITATION
CANCEL_INVITATION
CASH_OUT_ATM
TRANSFER_FROM_VOUCHER_A
TM
PICKUP
REVERSAL
REVERSAL_FEE
REVERSAL_LOY
REVERSAL_COMMISSIONING
REVERSAL_TAX
REVERSAL_DISCOUNT
REVERSAL_PROMOTION
ADJUSTMENT
ADJUSTMENT_FEE
ADJUSTMENT_LOY
ADJUSTMENT_COMMISSIONING
ADJUSTMENT_TAX
ADJUSTMENT_DISCOUNT_PRO
MOTION
BATCH_TRANSFER
RESOURCE_INFORMATION_ENQ
UIRY
DEBIT
RESOLVE_DEPOSIT
SUSPEND_DEPOSIT
PAYMENT
CUSTODY_ACCOUNTS_TRANSF
ER
EXTERNAL_TRANSFER

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 164
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

REFUND
INVITE_USER_REWARD
ACCEPT_INVITE_REWARD
TAX
DECLINE_INVITATION
EXPIRED_INVITATION
FLOAT_TRANSFER
TRANSFER_TO_ANY_BANK_ACC
OUNT
TRANSFER_LOY
EXTERNAL_TRANSFER_LOY
PAYMENT_LOY
PAYMENT_SEND_LOY
PAYMENT_RECEIVE_LOY
DEBIT_LOY
REFUND_LOY
REVERSAL_USER_LOY
COUPONS_REDEEM_COUPON
COUPONS_ACQUIRE_COUPON
COUPONS_ISSUE_OFFER
COUPONS_REDEEMED_COUPO
N_RATE
DEPOSIT_NOTIFICATION
WITHDRAWAL_NOTIFICATION
REVERSAL_SENDER_NOTIFICAT
ION
REVERSAL_RECEIVER_NOTIFIC
ATION
LOAN_APPLICATION
VIEW_LOAN_REPAYMENTS
VIEW_LOAN_DETAILS
UNKNOWN

startdatefrom dateTime Optional Retrieve transaction history created

from this start date.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 165
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

startdateto dateTime Optional Retrieve transaction history created

until this stop date

datefrom dateTime Optional Retrieve transaction history finalized

(SUCCESSFUL, FAILED) from this
start date.

dateto dateTime Optional Retrieve transaction history finalized

(SUCCESSFUL, FAILED) until this
stop date.

direction string Optional Retrieve transaction history with the

specified direction, that is, incoming
or outgoing transfers.
Possible values are:
IN
OUT

otherfri string Optional The FRI of the other party in transfer,

could be from or to depending on
direction. Validated with IsFRI.

quoteid string Optional The ID of the quote to use.

Response
A success response example:

<?xml version="1.0" encoding="UTF-8"?>

<v1_0:gettransactionhistoryresponse xmlns:iso="urn:iso:std:iso:20022:tech:xsd"
xmlns:ns2="http://www.ericsson.com/em/emm/v1_1/common"
xmlns:fic="http://www.ericsson.com/em/emm/financial/v1_0/common"
xmlns:ns1="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:v1_0="http://www.ericsson.com/em/emm/financial/v1_0">
<totalcount>0</totalcount>
<historylist>
<entry>
<financialtransactionid>financialtransactionid0</financialtransactionid>
<transactionstatus>SUCCESSFUL</transactionstatus>
<transfertype>TRANSFER_FEE</transfertype>
<startdate>2006-05-04T18:13:51.0Z</startdate>
<commitdate>2006-05-04T18:13:51.0Z</commitdate>
<fxrate>0</fxrate>
<initiatinguser>initiatinguser0</initiatinguser>
<realuser>realuser0</realuser>
<initiatingaccountholder>initiatingaccountholder0</initiatingaccountholder>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 166
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<realaccountholder>realaccountholder0</realaccountholder>
<from>from0</from>
<fromaccount>fromaccount0</fromaccount>
<fromamount>
<amount>0</amount>
<currency>currency0</currency>
</fromamount>
<fromfee>
<amount>0</amount>
<currency>currency1</currency>
</fromfee>
<fromexternalfee>
<amount>0</amount>
<currency>currency2</currency>
</fromexternalfee>
<fromdiscount>
<amount>0</amount>
<currency>currency3</currency>
</fromdiscount>
<frompromotion>
<amount>0</amount>
<currency>currency4</currency>
</frompromotion>
<fromloyfee>0</fromloyfee>
<fromloyreward>0</fromloyreward>
<frompromotionrefund>
<amount>0</amount>
<currency>currency5</currency>
</frompromotionrefund>
<fromnote>fromnote0</fromnote>
<fromavailablebalance>
<amount>0</amount>
<currency>currency6</currency>
</fromavailablebalance>
<fromtotalbalance>
<amount>0</amount>
<currency>currency7</currency>
</fromtotalbalance>
<fromcommittedbalance>
<amount>0</amount>
<currency>currency8</currency>
</fromcommittedbalance>
<fromaccountholder>fromaccountholder0</fromaccountholder>
<to>to0</to>
<toaccount>toaccount0</toaccount>
<toamount>
<amount>0</amount>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 167
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<currency>currency9</currency>
</toamount>
<tofee>
<amount>0</amount>
<currency>currency10</currency>
</tofee>
<toexternalfee>
<amount>0</amount>
<currency>currency11</currency>
</toexternalfee>
<topromotion>
<amount>0</amount>
<currency>currency12</currency>
</topromotion>
<toloyfee>0</toloyfee>
<toloyreward>0</toloyreward>
<topromotionrefund>
<amount>0</amount>
<currency>currency13</currency>
</topromotionrefund>
<todiscountrefund>
<amount>0</amount>
<currency>currency14</currency>
</todiscountrefund>
<tomessage>tomessage0</tomessage>
<toavailablebalance>
<amount>0</amount>
<currency>currency15</currency>
</toavailablebalance>
<tototalbalance>
<amount>0</amount>
<currency>currency16</currency>
</tototalbalance>
<tocommittedbalance>
<amount>0</amount>
<currency>currency17</currency>
</tocommittedbalance>
<maininstructionid>-1073741773</maininstructionid>
<instructionid>-1073741773</instructionid>
<externaltransactionid>externaltransactionid0</externaltransactionid>
<transactiontext>transactiontext0</transactiontext>
<tofeerefund>
<amount>0</amount>
<currency>currency18</currency>
</tofeerefund>
<fromfeerefund>
<amount>0</amount>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 168
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<currency>currency19</currency>
</fromfeerefund>
<toaccountholder>toaccountholder0</toaccountholder>
</entry>
<entry>
<financialtransactionid>financialtransactionid1</financialtransactionid>
<transactionstatus>SUCCESSFUL</transactionstatus>
<transfertype>TRANSFER_FEE</transfertype>
<startdate>2006-05-04T18:13:51.0Z</startdate>
<commitdate>2006-05-04T18:13:51.0Z</commitdate>
<fxrate>0</fxrate>
<initiatinguser>initiatinguser1</initiatinguser>
<realuser>realuser1</realuser>
<initiatingaccountholder>initiatingaccountholder1</initiatingaccountholder>
<realaccountholder>realaccountholder1</realaccountholder>
<from>from1</from>
<fromaccount>fromaccount1</fromaccount>
<fromamount>
<amount>0</amount>
<currency>currency20</currency>
</fromamount>
<fromfee>
<amount>0</amount>
<currency>currency21</currency>
</fromfee>
<fromexternalfee>
<amount>0</amount>
<currency>currency22</currency>
</fromexternalfee>
<fromdiscount>
<amount>0</amount>
<currency>currency23</currency>
</fromdiscount>
<frompromotion>
<amount>0</amount>
<currency>currency24</currency>
</frompromotion>
<fromloyfee>0</fromloyfee>
<fromloyreward>0</fromloyreward>
<frompromotionrefund>
<amount>0</amount>
<currency>currency25</currency>
</frompromotionrefund>
<fromnote>fromnote1</fromnote>
<fromavailablebalance>
<amount>0</amount>
<currency>currency26</currency>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 169
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

</fromavailablebalance>
<fromtotalbalance>
<amount>0</amount>
<currency>currency27</currency>
</fromtotalbalance>
<fromcommittedbalance>
<amount>0</amount>
<currency>currency28</currency>
</fromcommittedbalance>
<fromaccountholder>fromaccountholder1</fromaccountholder>
<to>to1</to>
<toaccount>toaccount1</toaccount>
<toamount>
<amount>0</amount>
<currency>currency29</currency>
</toamount>
<tofee>
<amount>0</amount>
<currency>currency30</currency>
</tofee>
<toexternalfee>
<amount>0</amount>
<currency>currency31</currency>
</toexternalfee>
<topromotion>
<amount>0</amount>
<currency>currency32</currency>
</topromotion>
<toloyfee>0</toloyfee>
<toloyreward>0</toloyreward>
<topromotionrefund>
<amount>0</amount>
<currency>currency33</currency>
</topromotionrefund>
<todiscountrefund>
<amount>0</amount>
<currency>currency34</currency>
</todiscountrefund>
<tomessage>tomessage1</tomessage>
<toavailablebalance>
<amount>0</amount>
<currency>currency35</currency>
</toavailablebalance>
<tototalbalance>
<amount>0</amount>
<currency>currency36</currency>
</tototalbalance>

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 170
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

<tocommittedbalance>
<amount>0</amount>
<currency>currency37</currency>
</tocommittedbalance>
<maininstructionid>-1073741773</maininstructionid>
<instructionid>-1073741773</instructionid>
<externaltransactionid>externaltransactionid1</externaltransactionid>
<transactiontext>transactiontext1</transactiontext>
<tofeerefund>
<amount>0</amount>
<currency>currency38</currency>
</tofeerefund>
<fromfeerefund>
<amount>0</amount>
<currency>currency39</currency>
</fromfeerefund>
<toaccountholder>toaccountholder1</toaccountholder>
</entry>
</historylist>
<loyalty>
<generated>0</generated>
<consumed>0</consumed>
<newbalance>0</newbalance>
</loyalty>
</v1_0:gettransactionhistoryresponse>

Table 2-55 describes parameters in a getTransactionhistory response message body.

Table 2-55 Parameters in a getTransactionhistory response message body

Parameter Type Length Level of Description

Requirement

totalcount integer - Optional Total amount of transaction history entries available

with the specified condition.
entry gettransacti - Optional Contains a list of transactions, each transaction
onhistoryent contains type, amount,date and so on. Contains the
rytype[0u main summary of a transaction history event.
nbounded]

loyalty loyalty - Optional

Table 2-56 describes parameters in a gettransactionhistoryentrytype response message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 171
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-56 Parameters in a gettransactionhistoryentrytype response message body

Parameter Type Length Level of Description

Requirement

financialtrans string Optional The financial transaction ID.

actionid Its a number, in ASCII digits. Digit groups may be
separated by hyphen characters
(-, ASCII code number 45). An empty string is allowed.
transactionsta string Optional The status of the transaction.
tus Possible values are:
SUCCESSFUL
PENDING
sFAILED

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 172
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

transfertype string Optional The transfer type.

Possible values are:
DEPOSIT
REVERSE_DEPOSIT
WITHDRAWAL
TRANSFER
CASH_IN
CASH_OUT
TRANSFER_TO_VOUCHER
TRANSFER_FROM_VOUCHER
PAYMENT_SEND
PAYMENT_RECEIVE
COMMISSIONING
FEE
PERIODIC_FEE
CANCEL_VOUCHER
VIEW_ACTIVE_TOKEN
VIEW_TOKEN
EXPIRE_VOUCHER
BALANCE_ENQUIRY
TRANSACTION_HISTORY_ENQUIRY
REMITTANCE
TRANSFER_TO_INVITATION
TRANSFER_FROM_INVITATION
CANCEL_INVITATION
CASH_OUT_ATM
TRANSFER_FROM_VOUCHER_ATM
PICKUP
REVERSAL
REVERSAL_FEE
REVERSAL_LOY
REVERSAL_COMMISSIONING
REVERSAL_TAX
REVERSAL_DISCOUNT
REVERSAL_PROMOTION
ADJUSTMENT
ADJUSTMENT_FEE
Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 173
ADJUSTMENT_LOY
ADJUSTMENT_COMMISSIONING
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

startdate dateTime - Optional The start date and time of the

transaction.
commitdate dateTime - Optional The date and time at which the
transaction was completed.
fxrate decimal - Optional The foreign exchange rate.

initiatinguser string Optional The execution ID of the user that initiated the
transaction.
Its a string, containing any number of letters or digits,
at-signs, hyphens,underscores or periods (full stop).
Other whitespace or punctuation characters are not
allowed. An empty string is not allowed.
realuser string Optional The execution ID of the real user that initiated the
transaction. Its a string, containing any number of
letters or digits, at-signs, hyphens,underscores or
periods (full stop). Other whitespace or punctuation
characters are not allowed. An empty string is not
allowed.
initiatingacco string Optional The Identity of the account holder that initiated the
untholder transaction if it
was initiated by an account holder
realaccountho string Optional The Identity of the real account holder that is effected
lder by the
transaction if it was initiated by an account holder.
from string Optional The sending user's default FRI.

fromaccount string Optional The sending account FRI.

fromamount moneydetail - Optional The amount withdrawn from the sending account.
stype
fromfee moneydetail - Optional The fee charged from the sending account.
stype

fromexternalf moneydetail - Optional The external fee charged from the sending account.
ee stype
fromdiscount moneydetail - Optional The discount amount that has been applied on the
stype sending account.

frompromotio moneydetail - Optional The promotion amount that has been applied on the
n stype sending account

fromloyfee decimal - Optional The sender's loyalty points fee charged for the
transaction.
fromloyrewar decimal - Optional The sender's loyalty points reward earned for the
d transaction.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 174
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

fromnote string Optional The sender's note.

fromavailable moneydetail - Optional The sending account's available balance after the
balance stype transaction was completed.

fromtotalbala moneydetail - Optional The sending account's total balance after the
nce stype transaction was completed.

fromcommitte moneydetail - Optional The sending account's committed balance after the
dbalance stype transaction was
completed.
fromaccounth string Optional The Identity of the sending accountholder.
older

to string Optional The receiving user's FRI or the receiving account's

FRI.
toaccount string Optional The receiving account FRI.

toamount moneydetail - Optional The amount deposited into the receiving account.
stype

tofee moneydetail - Optional The fee charged from the receiving account.
stype

toexternalfee moneydetail - Optional The external fee charged from the receiving account.
stype
topromotion moneydetail - Optional The promotion amount that has been applied on the
stype receiving account.

toloyfee decimal - Optional The receiver's loyalty points fee charged for the
transaction.
toloyreward decimal - Optional The receiver's loyalty points reward earned for the
transaction.
tomessage string Optional The receiver's message.

toavailablebal moneydetail - Optional The receiving account's available balance after the
ance stype transaction was
completed.
tocommittedb moneydetail - Optional The receiving account's committed balance after the
alance stype transaction was completed.

instructionid long - Optional The financial instruction ID

maininstructio long - Optional The main instruction ID

nid
externaltrans string Optional External transaction ID for the operation.
actionid

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 175
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Description

Requirement

transactiontex string Optional Text describing the transaction.

t

tototalbalance moneydetail - Optional The receiving account's total balance after the
stype transaction was completed.

tofeerefund moneydetail - Optional Previous fee that was refunded to the receiver during
stype this transaction.

fromfeerefund moneydetail - Optional Previous fee that was refunded to the sender during
stype this transaction

frompromotio moneydetail - Optional Previous sender promotion that was refunded to the
nrefund stype system during this transaction.

topromotionre moneydetail - Optional Previous receiver promotion that was refunded to the
fund stype system during this transaction.

todiscountrefu moneydetail - Optional Previous receiver discount that was refunded to the
nd stype system during this transaction.

toaccounthold string Optional The Identity of the receiving accountholder.

er

Table 2-57 describes parameters in a moneydetailstype type.

Table 2-57 Parameters in a moneydetailstype type.

Parameter Type Length Level of Description

Requirement

amount decimal - Mandatory The monetary amount. Validated with IsAmount

(allowNull=false).
currency string 3 Mandatory The currency, as an ISO 4217 formatted string.
Validated with IsCurrencyCode. Parameter cannot be
NULL.

Table 2-58 describes parameters in a loyalty type

Table 2-58 Parameters in a loyalty type

Parameter Type Length Level of Description

Requirement

generated decimal - Optional The rewarded loyalty, generated amount.

consumed decimal - Optional The loyalty fee, consumed amount.

newbalance decimal - Optional The loyalty balance after execution.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 176
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Error Codes
For details about the error codes, see 2.7 API Error Response.
2.6.2 queryBalance
Process
Figure 2-23 Process of queryBalance
Mobile
App SDP
Money

queryBalanceRequest
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId

queryBalanceRequest
3
queryBalanceResponse
4
queryBalanceResponse API message
2 Key parameters during
internal processing

Function
Obtain the balance for a specific account

Request URI
The request URI is the destination URI of queryBalance messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/mom/mt/queryBalance
In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/queryBalance HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 177
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,

LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<v1_0:getbalancerequest xmlns:ns1="urn:iso:std:iso:20022:tech:xsd"
xmlns:op="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:v1_0="http://www.ericsson.com/em/emm/financial/v1_0" version="1.0">
<fri>fri0</fri>
<quoteid>quoteid0</quoteid>
</v1_0:getbalancerequest>

Message Body Parameters

Table 2-59 describes parameters in a queryBalance message body.
Table 2-59 Parameters in a queryBalance message body

Parameter Type Length Level of Requirement Description

fri string Optional Used for a specific account, for

example commissioning account
balance.
quoteid string Optional The ID of the quote to use.

Response
A success response example:
<?xml version="1.0" encoding="UTF-8"?>
<v1_0:getbalanceresponse xmlns:ns1="urn:iso:std:iso:20022:tech:xsd"
xmlns:op="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:v1_0="http://www.ericsson.com/em/emm/financial/v1_0">
<balance>
<amount>0</amount>
<currency>currency0</currency>
</balance>
<loyalty>
<generated>0</generated>
<consumed>0</consumed>
<newbalance>0</newbalance>
</loyalty>
</v1_0:getbalanceresponse>

Table 2-60 describes parameters in a queryBalance response message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 178
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-60 Parameters in a queryBalance response message body

Parameter Type Length Level of Description

Requirement

balance long - Optional Account holder's available account balance. Refer to

Table-51
loyalty loyalty - Optional The loyalty information for the sender. Refer to
Table-52

Error Codes
For details about the error codes, see 2.7 API Error Response.
2.6.3 validatePayee
Process
Figure 2-24 Process of validatePayee
Mobile
App SDP
Money

validatePayeeRequest
1
Username Perform access
PasswordDigest authentication
Username Perform SLA control
serviceId
getaccountsRequest
2
getaccountsResponse
3
getaccountholderblackliststatu
sRequest
4
getaccountholderblackliststatusRespo
nse
5
getaccountholderpersonalinfor
mationRequest API message
6
getaccountholderpersonalinformationR Key parameters during
validatePayeeResponse esponse internal processing
8 7

3rd Party invokes the validatePayee interface towards SDP to validate if customer account is registered,
active and can transact. SDP will then invoke multiple APIs towards ECW, consolidate its responses and send
validatePayee response to partner.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 179
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Function
Validate the account holder information from 3rd party providers before executing a deposit or debiting
customer account.

Request URI
The request URI is the destination URI of validatePayee messages sent by the App to the SDP. The URI is
provided by the SDP in the following format:
http://IP:Port/mom/mt/validatePayee
In the format, IP and Port indicate the service IP address and HTTP port number of the API provided by the
SDP. Contact carriers to obtain the IP address and port number.

Request Message Body Example

POST /mom/mt/validatePayee HTTP/1.1
Content-Type:text/xml
Content-Length:569
Host:127.0.0.1
Authorization: WSSE realm="SDP", profile="UsernameToken"
X-WSSE: UsernameToken Username="bob", PasswordDigest=" weYI3nXd8LjMNVksCKFV8t3rgHh3Rw==", Nonce="
WScqanjCEAC4mQoBE07sAQ==", Created="2012-07-26T11:31:26Z"
X-RequestHeader: request ServiceId="35000001000012", TransId=" 200903241230451000000123456789" ,
LinkId="A15Y89Z32T99", FA="8613912345678"
Cookie: sessionid=default8fcee064690b45faa9f8f6c7e21c5e5a
Msisdn: 861111111
X-HW-Extension: k1=v1;k2=v2

<?xml version="1.0" encoding="UTF-8"?>

<v1_0:validatepayeerequest xmlns:ns1="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:prc="http://www.ericsson.com/em/emm/provisioning/v1_0/common"
xmlns:ns2="urn:iso:std:iso:20022:tech:xsd"
xmlns:v1_0="http://www.ericsson.com/em/emm/provisioning/v1_0">
<identity>identity0</identity>
<extension>
</extension>
</v1_0:validatepayeerequest>

Message Body Parameters

Table 2-61 describes parameters in a validatePayee message body.
Table 2-61 Parameters in a validatePayee message body

Parameter Type Length Level of Requirement Description

identity string Mandatory A valid identity associated with the

account holder.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 180
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Parameter Type Length Level of Requirement Description

extension extensiontype - Optional Used for sending any additional

information to Partner.
For details about extensiontype, see
Table 2-32.

Response
A success response example:

<?xml version="1.0" encoding="UTF-8"?>

<v1_0:validatepayeeresponse xmlns:ns1="http://www.ericsson.com/em/emm/v1_0/common"
xmlns:prc="http://www.ericsson.com/em/emm/provisioning/v1_0/common"
xmlns:ns2="urn:iso:std:iso:20022:tech:xsd"
xmlns:v1_0="http://www.ericsson.com/em/emm/provisioning/v1_0">
<transactionStatus>false</transactionStatus>
<accountslist>
<account>
<accountstatus>ACTIVE</accountstatus>
<accounttype>MOBILE_MONEY</accounttype>
<profilename>profilename0</profilename>
<description>description0</description>
</account>
<account>
<accountstatus>ACTIVE</accountstatus>
<accounttype>MOBILE_MONEY</accounttype>
<profilename>profilename1</profilename>
<description>description1</description>
</account>
</accountslist>
<blackliststatus>BLACKLISTED</blackliststatus>
<information>
<birth>
<date>2006-05-04</date>
</birth>
</information>
<extension>
</extension>
</v1_0:validatepayeeresponse>

Table 2-62 describes parameters in a validatePayee response message body.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 181
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-62 Parameters in a validatePayee response message body

Parameter Type Length Level of Description

Requirement

transactionSt boolean - Mandatory True/False based on overall response.

atus

accountslist accountslist - Conditional Returns all accounts connected to a specific account

holder.
Mandatory for true/success response.
For details about accountslist, see Table 2-63.
blackliststatus blackliststat - Conditional Returns the black list status of the identity sent in the
us request.
Mandatory for true/success response.
String based enumeration, Possible values are:
BLACKLISTED
WHITELISTED
NONE

information personalinfo - Conditional Returns personal information connected to the identity

rmation sent in the request.
Mandatory for true/success response.
For details about personalinformation, see Table 2-65.
extension extensiontyp - Optional Used for sending any additional information to
e Partner.
For details about extensiontype, see Table 2-32.

Table 2-63 describes parameters in an accountslist type.

Table 2-63 Parameters in in an accountslist type

Parameter Type Length Level of Description

Requirement

account accountdeta - Optional Contains information about the account and its
ilstype[0u balance.
nbouned]
For details about accountdetailstype, see Table 2-64.

Table 2-64 describes parameters in an accountdetailstype type.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 182
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Table 2-64 Parameters in in an accountdetailstype type

Parameter Type Length Level of Description

Requirement

accountstatus accountstat Optional The status of the account.

us accountstatus is string based enumeration, Possible
values are:
ACTIVE
BLOCKED
CLOSED
UNAVAILABLE

accounttype accounttype Optional The type of account.

accounttype is string based enumeration, Possible
values are:
MOBILE_MONEY
COMMISSIONING
LOYALTY_POINTS
TAX
LOAN
UNKNOWN

profilename xs:string Optional The name of the profile of the account.

description xs:string Optional Description of the account.

Table 2-65 describes parameters in a personalinformation type.

Table 2-65 Parameters in in a personalinformation type

Parameter Type Length Level of Description

Requirement

birth birthinformat Optional The account holder's birth information.

ion For details about birthinformation, see Table 2-66.

Table 2-66 describes parameters in a birthinformation type.

Table 2-66 Parameters in in a birthinformation type

Parameter Type Length Level of Description

Requirement

date xs:date - Optional The account holder's birth date. minDate=1890-01-01

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 183
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

Error Codes
For details about the error codes, see 2.7 API Error Response.

2.7 API Error Response

When an error occurs, the server sends an error response to the client. This topic provides an error response
example and describes parameters in the response.
Example
<tns:errorResponse xmlns:tns="http://www.ericsson.com/lwac" errorcode="errorcode0">
<arguments name="name0" value="value0"/>
<arguments name="name1" value="value1"/>
</tns:errorResponse>

Error Code List

Table 2-67 defines the error code.
Table 2-67 Parameters in error response message body

errorCode arguments.name arguments.value Exception Scene

SYSTEM_OVERLOAD resource_name Name of the resource Dynamic flow control error

with dynamic flow control
errors, such as CPU,
memory, and queue.

SYSTEM_OVERLOAD item_name Name of the item with Static flow control error
static flow control errors,
such as SMS and MMS.

EXCEED_LICENSE item_name Name of the item with License control error

license control errors,
such as SMS and MMS.

SYSTEM_ERROR connection Error details, such as Internal message interaction error,

internal connection such as disconnection or timeout
broken or waiting
response timeout.

AUTHORIZATION_FAILE SPID SP ID, which is the value Access authentication failure

D of UserName in the
X-WSSE header.

NOT_AUTHORIZED SPID SP ID, service ID, or API Capability authentication failure

ServiceID name.
ApiName

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 184
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

MANDATORY_FIELD_MI Parameter_name Name of a parameter Parameter verification failure due to

SSING that fails to be verified. mandatory parameter missing

INVALID_PARAMETER Parameter_name Name of a parameter Parameter verification failure due to

that fails to be verified. incorrect format
VIOLATE_SLA SPID SP ID, service ID, or SLA SLA control failure
ServiceID ID.
SLAID
NO_ROUTE route Route information not Route query failure
found.

CONNECTION_ERROR connection External connection error External message interaction error,

details, such as such as disconnection or timeout
connection broken or
waiting response
timeout.

ACCOUNT_ALREADY_M - - This account is already a member of

EMBER_OF_GROUP this group

ACCOUNT_COULD_NOT - - Account could not be removed from

_BE_REMOVED_FROM_ Bank domain
BANKDOMAIN

ACCOUNT_HOLDER_AD - - The specified account holder's

DITIONAL_INFORMATIO additional information name already
N_NAME_ALREADY_EXI exist
ST
ACCOUNT_HOLDER_AD - - The specified account holder's
DITIONAL_INFORMATIO additional information name cannot
N_NAME_IN_USE be deleted because it is in use

ACCOUNT_HOLDER_AL - - This account holder is already a

READY_MEMBER_OF_G member of this group
ROUP

ACCOUNT_HOLDER_DO - - AccountHolder does not exist

ES_NOT_EXIST
ACCOUNT_HOLDER_NO - - This operation requires the user to
T_LOGGED_IN be logged in

ACCOUNT_HOLDER_PR - - AccountHolder profile does not have

OFILE_DOES_NOT_HAV requested account
E_REQUESTED_ACCOU
NT_TYPE

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 185
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

ACCOUNT_HOLDER_ST - - AccountHolder status should be

ATUS_IS_NOT_VALID_F blocked or active
OR_ADD_ACCOUNT_OP
ERATION

ACCOUNT_NOT_FOUND - - Account not found

ACCOUNT_ROUTE_ALR - - Could not create account route since

EADY_EXISTS Account route with provided account
route reference and currency
already exists

ACCOUNT_ROUTE_NOT - - Could not delete account route since

_FOUND Account route with provided account
route reference and currency does
not exists

ACCOUNT_TYPE_NOT_S - - Account type is not supported

UPPORTED

ACCOUNTHOLDER_ACC - - The account holder already has a

OUNT_REFERENCE_ALR connection to the specified account
EADY_EXISTS

ACCOUNTHOLDER_ACTI - - Activation of account holder failed

VATION_FAILED
ACCOUNTHOLDER_ANY - - Could not perform operation since at
_ONE_MANDATORY_FIE least one of the mandatory field is
LD_REQUIRED required

ACCOUNTHOLDER_CAN - - Could not perform operation since at

_NOT_REMOVE_EMAIL least one of the mandatory field is
required

ACCOUNTHOLDER_CAN - - Could not perform operation since at

_NOT_REMOVE_EXT_ID least one of the mandatory field is
required
ACCOUNTHOLDER_CAN - - Could not perform operation since at
_NOT_REMOVE_MSISDN least one of the mandatory field is
required

ACCOUNTHOLDER_CAN - - Could not perform operation since at

_NOT_REMOVE_USER_ least one of the mandatory field is
NAME required

ACCOUNTHOLDER_EUI_ - - Account holder could not be found

NOT_FOUND

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 186
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

ACCOUNTHOLDER_MSI - - Operation requires account holder to

SDN_NOT_FOUND have an MSISDN identity but it has
none

ACCOUNTHOLDER_NOT - - Account holder is inactive

_ACTIVE
ACCOUNTHOLDER_NOT - - A specified account holder was not a
_CHILD child to another specified account
holder

ACCOUNTHOLDER_NOT - - Account holder could not be found

_FOUND

ACCOUNTHOLDER_SET - - The settings for this account holder

TINGS_ALREADY_EXIST already exists
S

ACCOUNTHOLDER_SET - - Account holder settings are

TINGS_MANDATORY mandatory

ACCOUNTHOLDER_SET - - Account holder settings not found

TINGS_NOT_FOUND

ACCOUNTHOLDER_WIT - - Account holder could not be

H_ALIAS_ALREADY_EXI registered because an account
STS holder with submitted Alias already
exists

ACCOUNTHOLDER_WIT - - Account holder could not be

H_EMAIL_ALREADY_EXI registered because an account
STS holder with submitted E-mail already
exists
ACCOUNTHOLDER_WIT - - Account holder with given e-mail
H_EMAIL_NOT_FOUND could not be found

ACCOUNTHOLDER_WIT - - Account holder cannot have the

H_EMPLOYEE_ID_ALRE same employee id as another
ADY_EXISTS employee working under the same
employer
ACCOUNTHOLDER_WIT - - Account holder could not be
H_EXTERNALID_ALREA registered because an account
DY_EXISTS holder with submitted External ID
already exists

ACCOUNTHOLDER_WIT - - Account holder with given FRI could

H_FRI_NOT_FOUND not be found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 187
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

ACCOUNTHOLDER_WIT - - Account holder IMSI could not be

H_IMSI_ALREADY_EXIST updated because it already exists
S

ACCOUNTHOLDER_WIT - - Account holder could not be

H_MSISDN_ALREADY_E registered because an account
XISTS holder with submitted MSISDN
already exists

ACCOUNTHOLDER_WIT - - Account holder with given MSISDN

H_MSISDN_NOT_FOUND could not be found

ACCOUNTHOLDER_WIT - - Account holder could not be

H_USERNAME_ALREAD registered because an account
Y_EXISTS holder with submitted Username
already exists

ADJUSTMENTS_FROM_ - - Adjustments from account not

ACCOUNT_NOT_ALLOW allowed
ED

ADJUSTMENTS_NOT_AL - - Adjustments not allowed on account

LOWED

ADJUSTMENTS_TO_ACC - - Adjustments to account not allowed

OUNT_NOT_ALLOWED
ALIAS_NOT_FOUND - - No Alias with this name was found in
the system
ALREADY_MEMBER_IN_ - - Could not perform operation since
ANOTHER_BANKDOMAI the resource already belongs to
N another Bank domain
AMBIGUOUS_CURRENC - - The FRI refers to more than one
Y account

AMOUNT_INVALID - - Either amount and currency are

incompatible or currency is invalid
AUTHORIZATION_ACCO - - Account holder is not allowed to
UNT_NOT_ALLOWED_T perform this operation
O_PERFORM_ACTION
AUTHORIZATION_ACCO - - Account holder is already activated
UNTHOLDER_ALREADY_
ACTIVATED

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 188
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

AUTHORIZATION_ACCO - - Account holder is not active

UNTHOLDER_NOT_ACTI
VE

AUTHORIZATION_CURR - - Insufficient amount

ENT_BALANCE_TOO_LO
W

AUTHORIZATION_FAILE - - Authorization failed

D

AUTHORIZATION_INVALI - - Performing this operation with this

D_ACCOUNT_TYPE_CO account type combination is not
MBINATION allowed

AUTHORIZATION_INVALI - - Setting an account holder as its own

D_ACCOUNTHOLDER_HI parent or a creating a cycle in the
ERARCHY hierarchy is not allowed

AUTHORIZATION_INVALI - - Authorization failed

D_DEBIT

AUTHORIZATION_MAX_T - - Maximum transfer account

RANSFER_ACCOUNT_T throughput amount including fee
HROUGHPUT threshold exceeded

AUTHORIZATION_MAX_T - - Maximum transfer account

RANSFER_ACCOUNT_T throughput amount including fee
HROUGHPUT_RECEIVE threshold exceeded for receiver
R

AUTHORIZATION_MAX_T - - Maximum transfer account

RANSFER_ACCOUNT_T throughput amount including fee
HROUGHPUT_SENDER threshold exceeded for sender

AUTHORIZATION_MAX_T - - Maximum transfer amount threshold

RANSFER_AMOUNT exceeded

AUTHORIZATION_MAX_T - - Maximum transfer amount including

RANSFER_AMOUNT_FE fee threshold exceeded
E
AUTHORIZATION_MAX_T - - Maximum transfer amount including
RANSFER_AMOUNT_FE fee threshold exceeded for receiver
E_RECEIVER

AUTHORIZATION_MAX_T - - Maximum transfer amount including

RANSFER_AMOUNT_FE fee threshold exceeded for sender
E_SENDER

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 189
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

AUTHORIZATION_MAX_T - - Maximum transfer amount threshold

RANSFER_AMOUNT_RE exceeded for receiver
CEIVER

AUTHORIZATION_MAX_T - - Maximum transfer amount threshold

RANSFER_AMOUNT_SE exceeded for sender
NDER

AUTHORIZATION_MAX_T - - Maximum transfer counter threshold

RANSFER_TIMES exceeded

AUTHORIZATION_MAXIM - - Maximum receive amount threshold

UM_AMOUNT_ALLOWED exceeded
_TO_RECEIVE

AUTHORIZATION_MAXIM - - Maximum send amount threshold

UM_AMOUNT_ALLOWED exceeded
_TO_SEND

AUTHORIZATION_MAXIM - - Authorization failed. Maximum

UM_AMOUNT_TO_APPR threshold limit reached for Approver
OVE

AUTHORIZATION_MINIM - - Amount below minimum amount

UM_AMOUNT_ALLOWED threshold
_TO_SEND
AUTHORIZATION_MINIM - - Amount below minimum amount
UM_AMOUNT_ALLOWED threshold for account
_TO_SEND_ACCOUNT

AUTHORIZATION_MINIM - - Amount below minimum amount

UM_AMOUNT_ALLOWED threshold for account reference
_TO_SEND_ACCOUNT_R
EFERENCE
AUTHORIZATION_NOT_ - - Account holder is not registered
REGISTERED_STATUS
AUTHORIZATION_RECEI - - Receivers account does not allow
VER_ACCOUNT_NO_DE deposit
POSIT

AUTHORIZATION_RECEI - - Could not perform operation

VER_FIRST_DEPOSIT_M because amount is below minimum
INIMUM_AMOUNT_ACCO first deposit amount threshold
UNT

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 190
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

AUTHORIZATION_RECEI - - Maximum balance threshold for

VER_MAX_ALLOWED_B receiver exceeded
ALANCE

AUTHORIZATION_RECEI - - Receivers account is not active

VING_ACCOUNT_NOT_A
CTIVE

AUTHORIZATION_RECEI - - Receiving account is unavailable

VING_ACCOUNT_UNAVA
ILABLE

AUTHORIZATION_SEND - - Withdrawal from recipient account

ER_ACCOUNT_NO_WITH not allowed
DRAWAL

AUTHORIZATION_SEND - - Senders account is not active

ER_ACCOUNT_NOT_AC
TIVE

AUTHORIZATION_SEND - - Minimum balance threshold for

ER_MIN_ALLOWED_BAL sender exceeded
ANCE

AUTHORIZATION_SENDI - - Sending account is unavailable

NG_ACCOUNT_UNAVAIL
ABLE
BANK_ACCOUNT_NOT_ - - A bank account with given bank
REGISTERED code and account number could not
be found

BANK_ACCOUNT_ROUT - - A route to the wanted bank account

E_NOT_FOUND could not be found

BANKDOMAIN_MISSING - - No bank domain set in the system.

BANKDOMAIN_NOT_FOU - - Bank domain with given ID was not

ND found
BANKDOMAIN_USED - - Could not perform operation since
the Bank domain is currently in use

BANKDOMAIN_WITH_NA - - Could not perform operation since

ME_ALREADY_EXISTS Bank domain with given name
already exists

BLOCK_ACCOUNT_FAIL - - Account could not be blocked

ED

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 191
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

CAN_NOT_RECEIVE_CA - - Receiving account holder has

SHIN insufficient permission to receive
cashin

CAN_NOT_RECEIVE_CA - - Receiving account holder has

SHOUT insufficient permission to receive
cashout

CERTIFICATE_ALREADY - - Certificate already updated for the

_UPDATED user

CERTIFICATE_CREDENT - - Certificate credentials already exist

IALS_ALREADY_EXIST

CERTIFICATE_CREDENT - - Certificate credentials do not exist

IALS_NOT_FOUND

CLOSE_ACCOUNT_FAIL - - Account could not be closed

ED

COMPANY_INFORMATIO - - The company information already

N_ALREADY_EXIST exist

COMPANY_INFORMATIO - - The company information does not

N_DOES_NOT_EXIST exist

CONTACT_ALREADY_EX - - Contact was not added since it

ISTS already exists

CONTACT_NOT_FOUND - - Contact with given FRI could not be

found

COULD_NOT_CREATE_A - - Could not create account holder

CCOUNTHOLDER_SETTI
NGS

COULD_NOT_PERFORM - - Could not perform add account

_ADD_ACCOUNT_OPER operation
ATION
COULD_NOT_PERFORM - - Failed to approve the operation,
_APPROVAL_OF_OPERA please retry the initial operation
TION_PLEASE_RETRY_ again
OPERATION_FROM_BEG
INNING
COULD_NOT_PERFORM - - ATM partial reversal operation could
_ATM_PARTIAL_REVERS not be performed
AL_OPERATION

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 192
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

COULD_NOT_PERFORM - - ATM redeem voucher operation

_ATM_REDEEM_VOUCH could not be performed
ER_OPERATION

COULD_NOT_PERFORM - - ATM rollback voucher operation

_ATM_ROLLBACK_VOUC could not be performed
HER_OPERATION

COULD_NOT_PERFORM - - Could not perform the operation.

_OPERATION Additional reason attached.

COULD_NOT_PERFORM - - Could not perform the operation, the

_OPERATION_ACCOUNT account has to be linked with sp
_NOT_LINKED account.

COULD_NOT_PERFORM - - Transaction could be performed

_TRANSACTION

COULD_NOT_RECEIVE_ - - Receive remittance failed

REMITTANCE

COULD_NOT_UPDATE_A - - Could not perform update of account

CCOUNTHOLDER_SETTI holder settings
NGS

COULD_NOT_UPDATE_P - - Could not perform update of pending

ENDING_PAYMENT payment status
COUNTER_CONFIGURA - - The specified counter configuration
TION_NOT_FOUND does not exist.

CREDENTIAL_IS_NOT_S - - The credential is not in the expected

USPENDED suspended state
CREDENTIAL_NOT_ACTI - - Operation not allowed because
VE credential not in active state

CREDENTIAL_REPEATE - - Repeated secrets does not match

D_SECRET_DOES_NOT_ each other
MATCH

CREDENTIAL_TYPE_NO - - Given credential type does not exist

T_FOUND in the system
CREDENTIALS_NOT_FO - - The user does not have any
UND credential of the given type

CREDENTIALS_NOT_FO - - Given credentials could not be found

UND

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 193
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

CURRENCIES_DONT_MA - - For this operation currency

TCH conversion is not allowed

CURRENCY_NOT_SUPP - - Given currency is not supported in

ORTED the system
CUSTODY_ACCOUNT_A - - Custody Account already exists
LREADY_EXISTS

CUSTODY_ACCOUNT_C - - Custody account certificate already

ERTIFICATE_ALREADY_ exist
EXIST

CUSTODY_ACCOUNT_C - - Custody account certificate could

ERTIFICATE_COULD_NO not deleted
T_BE_DELETED

CUSTODY_ACCOUNT_C - - Custody account certificate could

ERTIFICATE_COULD_NO not be empty
T_BE_EMPTY

CUSTODY_ACCOUNT_C - - Custody account certificate could

ERTIFICATE_COULD_NO not be used for non-repudiation
T_BE_USED_FOR_NON_
REPUDIATION

CUSTODY_ACCOUNT_C - - Custody account certificate does not

ERTIFICATE_DOES_NOT exist
_EXIST
CUSTODY_ACCOUNT_C - - Custody account certificate error
ERTIFICATE_ERROR
CUSTODY_ACCOUNT_C - - Unsupported algorithm for custody
ERTIFICATE_NO_SUCH_ account certificate
ALGORITHM

CUSTODY_ACCOUNT_C - - Custody account certificate with

ERTIFICATE_WITH_SAM same id already exist
E_ID_ALREADY_EXIST

CUSTODY_ACCOUNT_N - - Name and Bank Domain are same

AME_AND_BANKDOMAI as before
N_SAME_AS_BEFORE
CUSTODY_ACCOUNT_N - - Could not find CustodyAccount
OT_FOUND since Custody Account with
provided account number and bank
code does not exists

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 194
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

CUSTODY_ACCOUNT_S - - Custody account still contains

TILL_CONTAINS_MONEY money

CUSTODY_ACCOUNT_S - - This Custody account still have

TILL_HAVE_PENDING_T pending transaction
RANSACTION
CUSTODY_ACCOUNT_U - - Could not update custody account
PDATION_FAILED_NAME as name and bank domain both are
_AND_BANKDOMAIN_MI missing
SSING

DATEFORMAT_INVALID - - DateTime string could not be parsed

DIFFERENT_BANKDOMA - - Account holder and account must

INS belong to the same bank domain

DOCUMENT_DOES_NOT - - The document does not exist

_EXIST

DOCUMENT_URL_CONFI - - The document rules has been

GURATION_ERROR incorrectly configured in the system

DOCUMENT_URL_INVALI - - This document URL is invalid

D

DOCUMENT_URL_NOT_ - - This document URL is not allowed

ALLOWED

END_DATE_IN_FUTURE - - End date can not occur in the future

EXPIRED_OR_INVALID_T - - Transaction ID is either invalid or

RANSACTION_ID this transaction has expired
EXTERNAL_ERROR_ME - - This error originates from an
SSAGE external system

EXTERNAL_SERVICE_P - - External service provider with given

ROVIDER_NOT_FOUND User name could not be found
FAILED_TO_CREATE_NE - - Netting report error
TTING_REPORT

FIELD_TOO_LONG - - Data in element is too long

FINANCIAL_CONFIGURA - - Financial Configuration does not
TION_DOES_NOT_EXIST exist

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 195
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

FINANCIAL_CONTROLLE - - Neither transaction with transaction

R_TRANSACTION_NOT_ ID nor original transaction with
FOUND original transaction ID could be
found

FIRST_NAME_NOT_ALL - - Using first name in password is not

OWED_IN_PASSWORD allowed

FLOAT_TRANSFER_EXE - - The specified float transfer

MPTION_ALREADY_EXIS exemption rule already exists
TS

FRI_CAN_ONLY_HAVE_ - - Setting multiple owners of an FRI is

ONE_OWNER not allowed

FRI_INVALID - - FRI string is incorrectly formatted

FRI_REFERENCE_NOT_ - -
FOUND

FROM_DATE_AFTER_TO - - Operation requires that start date

_DATE has to occur before end date

GROUP_ALREADY_USE - - Could not perform operation since

D_BY_ANOTHER_BANKD the Group is already used by
OMAIN another Bank domain

GROUP_MEMBER_COUL - - Group member could not be

D_NOT_BE_REMOVED removed from group
GROUP_MEMBER_COUL - - Group member could not be
D_NOT_BE_REMOVED_F removed from Bank domain
ROM_BANKDOMAIN
GROUP_MEMBER_NOT_ - - Group member with given ID could
FOUND not be found in this group

GROUP_USED_BY_BAN - - Group used by Bank domain is not

KDOMAIN allowed to be removed
HIGH_CONTENTION_AC - - It's not possible to mirror a High
COUNT_NOT_SUPPORT Contention account in SDP since it
ED_AS_MIRRORED_ACC doesn't have a balance.
OUNT
HOME_CHARGING_REGI - - Home charging region with given ID
ON_NOT_FOUND was not found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 196
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

HOME_CHARGING_REGI - - Could not perform operation since

ON_USED the home charging region is
currently in use

HOME_CHARGING_REGI - - Could not perform operation since

ON_WITH_NAME_ALREA Home Charging Region with given
DY_EXISTS name already exists

ID_LENGTH_OUT_OF_B - - Length of identification is not within

OUNDS length boundaries

IDENTIFICATION_ID_AN - - Duplicate identification

D_TYPE_ALREADY_EXIS
T

IDENTITY_INVALID - - Identity string is incorrectly formatted

IDTYPE_NOT_SUPPORT - - ID type not supported by ISO 20022

ILLEGAL_CREDENTIAL_ - - The credential status change is

STATUS_CHANGE illegal

IMSI_INVALID - - Format of IMSI is invalid

INACTIVE_ACCOUNT - - Inactive receiver account

INCORRECT_PASSWOR - - Incorrect password

D

INCORRECT_PIN - - Incorrect pin code

INCORRECT_SEQURITY - - Security answer was not correct

_ANSWER
INCORRECT_TRANSACT - - Transaction state is incorrect for this
ION_STATUS operation

INTERNAL_ERROR - - An internal error caused the

operation to fail
INTERNAL_LOAN_ACCO - - Could not find Internal Loan Account
UNT_NOT_FOUND with given Id

INTERNAL_LOAN_AMOU - - Amount Min cannot be larger than

NT_MIN_LARGER_THAN Amount Max
_AMOUNT_MAX

INTERNAL_LOAN_APPLI - - The state of this Internal Loan

CATION_IS_NOT_VALID Application is not valid for this
operation

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 197
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

INTERNAL_LOAN_APPLI - - Could not find Internal Loan

CATION_NOT_FOUND Application

INTERNAL_LOAN_MAXIM - - Maximum number of Internal Loan

UM_NUMBER_OF_APPLI Applications reached
CATIONS
INTERNAL_LOAN_PROD - - Internal Loan Product already exist
UCT_ALREADY_EXIST
INTERNAL_LOAN_PROD - - The Internal Loan Product status is
UCT_IS_NOT_ACTIVE not active

INTERNAL_LOAN_PROD - - The given Internal Loan Product is

UCT_NOT_ALLOWED not allowed to be used

INTERNAL_LOAN_PROD - - Could not find Internal Loan Product

UCT_NOT_FOUND with given identity and product code

INTERNAL_LOAN_PROVI - - Internal Loan Provider already exist

DER_ALREADY_EXIST

INTERNAL_LOAN_PROVI - - Could not find Internal Loan Provider

DER_NOT_FOUND with given identity

INVALID_ACCOUNT_FRI - - The FRI must be of account type

INVALID_ACCOUNT_HOL - - The specified account holder's

DER_ADDITIONAL_INFO additional information name is not
RMATION_NAME valid or does not exist

INVALID_ACCOUNTHOL - - Account holder settings are invalid

DER_SETTINGS
INVALID_APPROVAL_TR - - Approval transaction has invalid
ANSACTION_STATUS state

INVALID_ATM_OPERATI - - Invalid ATM operation

ON
INVALID_CERTIFICATE - - Certificate is invalid

INVALID_CHOSEN_DELI - - Invalid Delivery method

VERY_METHOD
INVALID_CURRENCY - - Currency is either not valid or used
incorrectly

INVALID_FIELD_VALUE - - Element has invalid format

INVALID_PROFILE - - Profile validation

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 198
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

INVALID_PROFILE_COU - - Profile counter validation

NTER

INVALID_PROFILE_NAM - - Profile name validation

E
INVALID_PROFILE_THRE - - Profile threshold validation
SHOLD

INVALID_RECEIVER - - Invalid receiving end user

INVALID_REMITTANCE_ - - Incorrect remittance status

STATUS

INVALID_SCHEDULED_T - - A transaction can only be scheduled

RANSACTION_DATE from a future date

INVALID_SCHEDULED_T - - Invalid scheduled transaction status

RANSACTION_STATUS for the requested operation

INVALID_SETTLEMENT_ - - Settlement deposit with given ID

DEPOSIT_ID could not be found

INVALID_SETTLEMENTID - - Settlement with given ID could not

be found

INVALID_SIGNATURE - - The provided signature is not correct

INVALID_STATUS - - Current status is not as expected

INVALID_TRANSACTION - - Invalid Transaction type

_TYPE
INVALID_USER_APPROV - - Invalid User (or financial) approval
AL_TYPE type or not registered

LAST_BANKDOMAIN_NO - - Bank domain could not be removed

T_ALLOWED_TO_REMO since it is the last remaining
VE
LIMITED_RETRIES_FOR_ - - Limited retries are not allowed for
SERVICE_PROVIDER_N the specified service provider
OT_ALLOWED

LOAN_APPLICATION_NO - - Could not find Loan Application with

T_FOUND given approval ID

LOAN_PROVIDER_NOT_ - - Could not find Loan Provider with

FOUND given name

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 199
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

MANDATORY_FIELD_MI - - Mandatory element is missing

SSING

MAX_ACCOUNTS_LIMIT_ - - Reached limit for max accounts

REACHED
MAX_NUMBER_OF_CON - - Maximum number of contacts
TACTS_EXCEEDED threshold exceeded

MAX_NUMBER_OF_DOC - - Maximum number of documents

UMENT_EXCEEDED exceeded
MISSING_ACTOR_MSISD - - Actor MSISDN is missing
N_FOR_EXTERNAL_RATI
NG

MISSING_EXCHANGE_R - - Exchange rate for conversion

ATE between currencies does not exist.

MORE_THAN_ONE_MUT - - More than one of a set of optional

UALLY_EXCLUSIVE_OPT but mutual parameters were set.
IONAL_PARAMETERS_S
ET

MSISDN_ALREADY_USE - - Given msisdn alread used by a point

D_BY_POINTOFSALE of sale

NO_ACCESS - - User has no access permission

NONASCII_CHARACTER - - Using non ASCII characters in

S_IN_PASSWORD password is not allowed

NONDIGIT_CHARACTER - - Non-digit characters in pin code

S_IN_PINCODE

NOT_ALLOWED_TO_CH - - It is not allowed to change bank

ANGE_BANKDOMAIN domain for an account holder

NOT_AUTHORIZED - - The logged in user does not have

sufficient permissions to perform this
operation
NOT_ENOUGH_FUNDS - - Not enough funds or loyalty points to
perform operation
ONE_CUSTODY_ACCOU - - One custody account must exist
NT_MUST_EXIST

ONLY_ONE_REFUND_PE - - Only one refund per debit is allowed

R_DEBIT_IS_ALLOWED

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 200
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

OPERATION_NOT_SUPP - - Operation not supported on external

ORTED_ON_EXTERNAL_ account
ACCOUNT

OPERATION_NOT_SUPP - - Operation not supported on a

ORTED_ON_MIGRATED_ migrated account
ACCOUNT

OTHER_FINANCIAL_ERR - - Other financial error

OR

OTP_FOR_BANK_ACCO - - Request did not contain any OTP

UNT_VERIFICATION_MIS
SING

OTP_FOR_EMAIL_VERIFI - - Request did not contain any OTP

CATION_MISSING

OTP_FOR_MSISDN_VERI - - Request did not contain any OTP

FICATION_MISSING

OTP_INVALID - - Format of OTP is invalid

OTP_NOT_FOUND - - OTP not found, has expired or is

used for the wrong operation

PASSWORD_ALREADY_ - - Password has already been used

USED_BEFORE before

PASSWORD_TOO_SHOR - - Password too short

T

PENDING_COMMISSION - - Could not find Pending Commission

_NOT_FOUND

PICKUP_REFERENCE_ID - - Pickup with given MTCN could not

_NOT_FOUND be found

PINCODE_ALREADY_US - - PIN code has already been used

ED_BEFORE

PINCODE_DENIED_BY_ - - PIN code denied by matching birth

MATCHING_BIRTH_DAT date
E
PINCODE_DENIED_BY_ - - PIN code denied by matching
MATCHING_IDENTIFICAT identification number
ION_NUMBER

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 201
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

PINCODE_DENIED_BY_ - - PIN code denied by matching

MATCHING_MSISDN MSISDN

PINCODE_DENIED_BY_ - - PIN code denied by matching

MATCHING_REGULAR_E regular expression
XPRESSION
PINCODE_HAS_EXPIRE - - Wrong profile
D
PINCODE_TOO_LONG - - Pin code too long

PINCODE_TOO_SHORT - - Pin code too short

POINTOFSALE_NOT_AC - - The point of sale with given msisdn

QUIRED is not acquired.

PREAPPROVAL_NOT_FO - - The pre-approval with given ID could

UND not be found

PREAPPROVALS_NOT_F - - No pre-approvals found

OUND

PROFILE_ALREADY_EXI - - Profile name validation

STS

PROFILE_JSON_INVALID - - Json File validation

_FILE

PROFILE_MISMATCH - - A profile mismatch between for

example a provided counter
configuration (belonging to one
profile) and provided profile
reference (having a different profile)

PROFILE_NOT_FOUND - - Profile not found

PROFILE_TYPE_MISMAT - - Profile type validation

CH
PROFILE_VERSION_MA - - Profile version validation
NDATORY

PROFILE_VERSION_MIS - - Profile version validation

MATCH
PROFILE_WITH_NAME_ - - Tag was not found
DOES_NOT_EXIST

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 202
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

PROVIDER_CATEGORY_ - - Provider Category can not be

LINKED_WITH_ACCOUN deleted as it is linked with account
T_HOLDER holder

PROVIDER_CATEGORY_ - - No provider category with this name

NOT_FOUND was found in the system
QUEUED_FOR_APPROV - - Request is queued for approval
AL
QUOTE_ALREADY_USE - - Quote has already been used
D

QUOTE_EXPIRED - - Quote has expired

QUOTE_NOT_FOUND - - Quote not found

QUOTE_NOT_SUPPORT - - Quote is not supported with the

ED combination of parameters

QUOTE_PROCESSING - - Quote is already processing

REACTIVATE_ACCOUNT - - Account could not be re-activated

_FAILED

RECONCILIATION_PROC - - Failed to process reconciliation file.

ESS_ERROR
RECURRING_SCHEDULE - - Recurring scheduled transaction can
D_TRANSACTION_EXCE only be scheduled a limited number
EDS_MAX_DAYS of days into the future

REFERENCE_ID_ALREA - - This client reference ID is already

DY_IN_USE used

REFERENCE_ID_NOT_F - - A client reference with this ID could

OUND not be found

REFUND_AMOUNT_CAN - - Refund amount cannot be larger

NOT_EXCEED_THE_DEB than the debit amount
IT_AMOUNT
RELATIVE_DOES_NOT_ - - The relative does not exist
EXIST
REMITTANCE_ID_DOES_ - - Remittance Id does not exist in
NOT_EXIST dbase

REMITTANCE_NOT_FOU - - Remittance not found, Invalid

ND provider name or remittance id

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 203
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

REMITTANCE_NOT_POS - - Remittance not possible because

SIBLE given data is invalid.

REQUIRED_FIELD_MISSI - - Element needed for this invocation

NG is missing
REQUIRED_PASSWORD - - Password criteria configuration
_CRITERIA_NOT_MATCH invalid

RESOURCE_NOT_ACTIV - - Required resource is not active

E
RESOURCE_NOT_AVAIL - - FRI not available
ABLE

RESOURCE_NOT_FOUN - - FRI not found

D

RESOURCE_TEMPORAR - - Required resource is temporarily

Y_LOCKED locked

REVERSAL_ALREADY_P - - Reversal has already been

ERFORMED_ON_THIS_T performed on this transaction
RANSACTION

REVERSAL_NOT_ALLOW - - Reversal is not allowed on this type

ED_ON_THIS_TRANSAC of transaction
TION_TYPE

REVERSAL_SUB_TRANS - - Reversal not possible since sub

ACTION_INVALID transaction is invalid

REVERSED_USER_ID_N - - Using reversed user id in password

OT_ALLOWED_IN_PASS is not allowed
WORD

ROLLBACK_NOT_POSSI - - Transaction could not be performed

BLE since neither of the parties supports
rollback
SCHEDULED_TRANSAC - - Transaction can only be scheduled a
TION_EXCEEDS_MAX_D limited number of days into the
AYS future
SCHEDULED_TRANSAC - - The requested scheduled
TION_NOT_FOUND transaction could not be found

SELF_SERVICE_NOTIFIC - - This self service notification aready

ATION_DUPLICATE exists.

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 204
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

SELF_SERVICE_NOTIFIC - - The notification limit exceeds the

ATION_LIMIT_EXCEEDS_ hard limit
HARD_LIMIT

SELF_SERVICE_NOTIFIC - -
ATION_NOT_FOUND
SELF_SERVICE_NOTIFIC - - Max number of self serviced
ATION_TOO_MANY notifications reached, cannot create
another.

SERVICE_TEMPORARIL - - The operation could not be

Y_UNAVAILABLE performed right now but might
succeed later

SESSION_INVALID - - The session has timed out

SETTLEMENT_AMOUNT_ - - The response amount does not

DO_NOT_MATCH match with the amount in the
Payment Instruction

SETTLEMENT_ANOTHER - - Another settlement task is ongoing.

_SETTLEMENT_BEING_P
ROCESSED

SETTLEMENT_CLOSING - - Balance reconcilation failed.

_BALANCE_MISMATCH Provided closing balance does not
match with the expected closing
balance of custody account
SETTLEMENT_CONFIGU - - Certificate does not exist for custody
RATION_CERTIFICATE_ account not able to verify signature
DOES_NOT_EXIST_FOR of settlement file
_CUSTODY_ACCOUNT

SETTLEMENT_CONFIGU - - Custody account already exists with

RATION_CUSTODY_ACC settlement configuration
OUNT_ALREADY_EXIST
S_WITH_SETTLEMENT_
CONFIGURATION

SETTLEMENT_CONFIGU - - Could not find settlement

RATION_DOES_NOT_EXI Configuration for custody account
ST_FOR_CUSTODY_ACC
OUNT

SETTLEMENT_CONFIGU - - Settlement configuration for

RATION_FOR_IDENTIFIE identifier already exists
R_ALREADY_EXISTS

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 205
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

SETTLEMENT_CONFIGU - - Instruction formatter class not found

RATION_INSTRUCTION_
FORMATTER_CLASS_N
OT_FOUND

SETTLEMENT_CONFIGU - - Settlement configuration not found

RATION_NOT_FOUND

SETTLEMENT_CONFIGU - - Settlement parser class not found

RATION_SETTLEMENT_
PARSER_CLASS_NOT_F
OUND

SETTLEMENT_CONFIGU - - Unable to remove custody account

RATION_UNABLE_TO_R id from settlement configuration
EMOVE_CUSTODY_ACC
OUNT_ID

SETTLEMENT_CURREN - - Currency does not match with

CY_DO_NOT_MATCH custody account's currency.

SETTLEMENT_CUSTODY - - Settlement process failed because

_ACCOUNT_DO_NOT_M the custody accounts information do
ATCH not match.

SETTLEMENT_DEPOSIT - - The deposit has already been

_ALREADY_REVERSED reversed.
SETTLEMENT_DEPOSIT - - The deposit is in an invalid state.
_IN_INVALID_STATE

SETTLEMENT_DEPOSIT - - The deposit was not found.

_NOT_FOUND
SETTLEMENT_DEPOSIT - - The transaction details of the
_TRANSACTION_DETAIL deposit where not found.
S_MISSING

SETTLEMENT_DUPLICA - - Duplicated deposit or reverse

TE_RECORD_FOUND deposit record found.

SETTLEMENT_FILE_DIG - - Digest does not exist or digest

EST_VERIFICATION_ER verification failed for settlement file
ROR
SETTLEMENT_FILE_FOR - - Error in parsing settlement file
MAT_ERROR

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 206
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

SETTLEMENT_FILE_SIG - - Signature does not exist or signature

NATURE_VERIFICATION verification failed for settlement file
_ERROR

SETTLEMENT_IDENTIFIE - - Payment Instruction Response

R_DO_NOT_MATCH caller identifier mismatch
SETTLEMENT_IDENTIFIE - - Settlement identifier not found
R_NOT_FOUND
SETTLEMENT_INVALID_ - - Invalid or no amount in Payment
AMOUNT Instruction Response.

SETTLEMENT_INVALID_ - - Settlement error due to invalid

RECEIVER receiver.There is no such account
holder or custody account exists.

SETTLEMENT_NOT_REA - - Settlement is in wrong state

DY

SETTLEMENT_ONLINE_ - - Online settlement not enabled for

SETTLEMENT_NOT_ENA custody account
BLED_FOR_CUSTODY_A
CCOUNT

SETTLEMENT_OPENING - - Opening Balance reconcilation failed

_BALANCE_MISMATCH
SETTLEMENT_PAYMENT - - Wrong state for Settlement
_INSTRUCTION_IN_WRO PaymentInstruction.
NG_STATE

SETTLEMENT_PAYMENT - - Settlement PaymentInstruction not

_INSTRUCTION_NOT_FO found.
UND

SETTLEMENT_PROCESS - - Failed to process settlement file.

_ERROR
SETTLEMENT_RECEIVIN - - The receiver account does not
G_ACCOUNT_DO_NOT_ match
MATCH

SETTLEMENT_TRANSFE - - Wrong state for Settlement

R_IN_WRONG_STATE CustodyAccountsTransfers.
SOURCE_AND_TARGET - - Source is the same as the target
_ARE_THE_SAME

SOURCE_NOT_FOUND - - Source FRI not found

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 207
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

SURNAME_NOT_ALLOW - - Using surname in password is not

ED_IN_PASSWORD allowed

SUSPEND_ACCOUNT_F - - Not possible to put account in

AILED suspended state
TAG_WITH_NAME_ALRE - - Tag could not be created because a
ADY_EXISTS Tag with submitted name already
exists
TAG_WITH_NAME_DO_N - - Tag was not found
OT_EXISTS

TARGET_AUTHORIZATIO - - Target financial resource has

N_ERROR reached counter or balance limits,
has insufficient funds or is missing
permissions

TARGET_NOT_FOUND - - Target FRI not found

TAX_REPORT_NOT_FOU - - Tax report not found

ND

THRESHOLD_CONFIGUR - - The specified threshold

ATION_NOT_FOUND configuration does not exist.

TOO_FEW_LOWERCASE - - Too few lower case alphabetic

_ALPHABETIC_CHARAC characters in password
TERS_IN_PASSWORD
TOO_FEW_NUMERICAL_ - - Too few digits in password
DIGITS_IN_PASSWORD
TOO_FEW_SPECIAL_CH - - Too few special characters in
ARACTERS_IN_PASSWO password
RD

TOO_FEW_UPPERCASE - - Too few upper case alphabetic

_ALPHABETIC_CHARAC characters in password
TERS_IN_PASSWORD

TOO_FEW_UPPERCASE - - Too few upper or lower case

_OR_LOWERCASE_ALP alphabetic characters in password
HABETIC_CHARACTERS
_IN_PASSWORD
TOO_MANY_CONSECUTI - - Too many consecutive digits in PIN
VE_DIGITS_IN_PINCODE code

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 208
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

TOO_MANY_IDENTICAL_ - - Too many identical consecutive

CONSECUTIVE_CHARAC characters in password
TERS_IN_PASSWORD

TOO_MANY_REPEATED - - Too many repeated digits in PIN

_DIGITS_IN_PINCODE code
TRANSACTION_ID_OR_ - - Neither transaction ID nor original
ORIGINAL_TRANSACTIO transaction ID was given
N_ID_MISSING

TRANSACTION_NOT_CO - - Transaction has not been completed

MPLETED and its state is either Pending or
Failed

TRANSACTION_NOT_FO - - Transaction not found

UND

TRANSACTION_TIMED_ - - Transaction timed out

OUT

TRANSFER_TYPE_AND_ - - Receiving account is invalid for this

ACCOUNT_DO_NOT_MA type of transaction
TCH

TRANSFERTOBANK_NO - - Operation is not supported for this

T_SUPPORTED account
UNABLE_TO_CREATE_A - - Account holder could not be created
CCOUNTHOLDER

UNABLE_TO_CREATE_I - - Interest tier could not be created

NTEREST_TIER
UNABLE_TO_MODIFY_IN - - Interest tier could not be modified
TEREST_TIER

UNABLE_TO_REMOVE_I - - Interest tier could not be removed

NTEREST_TIER
UNBLOCK_ACCOUNT_F - - Account could not be un-blocked
AILED

UNRESOLVED_REMITTA - - Unresolved Remittance Id does not

NCE_ID_DOES_NOT_EXI exist in dbase
ST

UNSUSPEND_CREDENTI - - The maximum attempts of credential

AL_COUNTER_THRESH unsuspend for the given account
OLD_REACHED holder has been reached

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 209
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

USER_ID_NOT_ALLOWE - - Using user id in password is not

D_IN_PASSWORD allowed

VALIDATION_ERROR - - The data provided in the request

failed the validation check
VOUCHER_DATE_OF_BI - - Voucher date of birth has been set
RTH_SET

VOUCHER_EXPIRED - - Voucher has expired

VOUCHER_EXTERNALID - - Voucher external id has been set

_SET

VOUCHER_FIRSTNAME_ - - Voucher first name has been set

SET

VOUCHER_NOT_ACTIVE - - Voucher is no longer active

VOUCHER_NOT_FOUND - - Voucher with given identity could not

be found in the system

VOUCHER_SECRET_CO - - Voucher secret contains letters that

NTAINS_EXCLUDED_LET has been excluded through system
TERS configuration

VOUCHER_SECRET_CO - - Voucher secret contains characters

NTAINS_ILLEGAL_CHAR that is not legal according to system
ACTERS configuration
VOUCHER_SECRET_CO - - Voucher secret contains non ASCII
NTAINS_NONASCII_CHA characters
RACTERS
VOUCHER_SECRET_DIG - - Voucher secret can not contain
ITS_NOT_ALLOWED digits

VOUCHER_SECRET_INV - - Voucher secret is not correct

ALID
VOUCHER_SECRET_IS_ - - Voucher secret element is empty
EMPTY

VOUCHER_SECRET_LET - - Voucher secret can not contain

TERS_NOT_ALLOWED letters
VOUCHER_SECRET_SY - - The voucher secret rules has been
STEM_CONFIGURATION incorrectly configured in the system
_ERROR

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 210
SDP Solution API Reference (MobileMoney)

2 HTTP APIs

errorCode arguments.name arguments.value Exception Scene

VOUCHER_SECRET_TO - - Voucher secret is longer than

O_LONG system configured maximum length

VOUCHER_SECRET_TO - - Too many redeem voucher attempts

O_MANY_FAILED_REDE with incorrect secret has been
EM_ATTEMPTS performed
VOUCHER_SECRET_TO - - Voucher secret is shorter than
O_SHORT system configured minimum length
VOUCHER_SURNAME_S - - Voucher surname has been set
ET

WRONG_PROFILE - - Wrong profile

COUPONS_USER_ALLO - - Number of coupons allowed on the

WANCE_REACHED offer for the user has already been
reached

COUPONS_USER_NOT_ - - User is not eligible for offer

ELIGIBLE_FOR_OFFER

COUPONS_USER_PROFI - - User profile does not exist

LE_NOT_EXIST

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 211
 3 Appendix

Appendix
3.1 The Currency and Atomic Charging Unit of each OpCo country
Country Name

Afghanistan

Benin
Currency

AFN

XOF
pul

N/A
03
Atomic Charging Unit

Bissau CFA N/A

Cameroon XAF XAF

Cote d'Iviore XOF XOF

Cyprus EUR cent

Ghana GHS Pesewa (1GHS = 100Pesewa)

Guinea GNF(Guinea Franc) N/A

Liberia LRD(Liberia Dollar) N/A

N Sudan SDG Piaster

Nigeria NGN Kobo

Rwanda Rwandan Franc (RWF) RWF

SA ZAR N/A

Swaziland SZL cent

Uganda Ugandan shilling (Code UGX
UGX)

Yemen Yemeni Riyal Fils (1 Riyal = 100 Fils)

Zambia ZMK ngwee, 1ZMK = 100Ngwee

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 212
SDP Solution API Reference (MobileMoney)

3 Appendix

3.2 ISO 4217 Codes for the representation of currencies and funds
ENTITY CURRENCY ALPHABETI CCODE NUMERI CCODE

Afghanistan Afghani AFA 4

Benin CFA Franc BCEAO XOF 952

Botswana Pula BWP 72

Cameroon CFA Franc BEAC XAF 950

Congo CFA Franc BEAC XAF 950

Cyprus Cyprus Pound CYP 196

Ethiopia Ethiopian Birr ETB 230

Ghana Cedi GHC 288

Guinea Guinea Franc GNF 324

Guinea-Bissau Guinea-Bissau Peso GWP 624

CFA Franc BCEAO XOF 952

Liberia Liberian Dollar LRD 430

Nigeria Naira NGN 566

Rwanda Rwanda Franc RWF 646

South Africa Rand ZAR 710

Sudan Sudanese Dinar SDD 736

Swaziland Lilangeni SZL 748

Uganda Uganda Shilling UGX 800

Yemen Yemeni Rial YER 886

Zambia Kwacha ZMK 894

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 213
SDP Solution API Reference (MobileMoney)

3 Appendix

3.3 OpCoID List

MTN OpCo Name OpCoID Value

Afghanistan 9301

Benin 22901
Bissau 24501

Botswana 26701

Cameroon 23701

Congo 24201

CoteD'Ivoire 22501

Cyprus 35701
Ghana 23301

Guinea Republic 22401

Liberia 23101
Nigeria 23401

Rwanda 25001

South Africa 2701

Sudan North 21101

Sudan South 24901

Swaziland 26801

Syria 96301

Uganda 25601

Yemen 96701

Zambia 26001

Issue 22 (2015-06-18) Copyright 2015 Mobile Telephone Networks. All rights reserved. 214