INT

Team, kindly note that the error mentioned in ticket 321452 by Adrienne where the terminals from one of their merchants did not have any rate plan assigned as you can see below: You guys have to ensure that in merchant info, under the Time zone info, the merchant is configured with "This merchant is setup with Iso Managed Rate Plan Model", I was not able to change the Rate plans for the terminals mentioned due to the info configured was "This merchant is setup with Emida Plan Model", as you can see below: To change this option mentioned above you have to click in "Edit Merchant Info" Then, you will be able to see the option "Change Rate Plan Model", once you click there, you will be able to set up the new rate plan model that Emida is handling which is: "Iso Managed Rate Plan Model". Finally the system will allow you to change the rate plan for the terminals that the merchant handles: This is the troubleshoot to this error mentioned in this email, keep in mind that these are the steps that you have to follow if the Representative has rate plans assigned but does not allow you to change the rate plan in terminal edit.

Last updated: 5 years ago

Carrier Login User Requests

The Carrier login is a user created to review transactions for a specific carrier, as a sample on this thread are (FLOW /Digicel). You can follow these steps and create/edit/ delete the requested user: 1- Go to Support Site (you can use the external) and login into the requested marked (JAM-DOM - ATG-etc) 2- Go to customers option and select the first box available there, it should be one named Carrier: 3- You can edit, create or delete a user so if you want to CREATE it please: *Click on Add Carrier User, after that enter the Username that will be sent to the customer, add a PW and finally enter the customer email. *Add the products that belong to the carrier, just will need to click on the box. *Then please click on Save, and the credentials will be sent to the customer's email. B- EDIT To EDIT a user, you will see 3 headers EDIT PASSWORD, EDIT EMAIL and ALLOWED PRODUCTS. for the first 2 we know that we can edit either the Password or the Email just click on it, enter the info and click on Update option. For ALLOWED TERMINAL you will be able to add or edit products for the ones already selected, so click on that option and then click on Edit Carrier User Products option, add or remove the needed products. C- DELETE To delete a specific user just click on delete option and confirm it clicking on Delete box. After complete the necessary changes, send the response to the customer and that's all.

Last updated: 5 years ago

FACEY - Enabling Plan Sales for USSD/SMS Terminals

Team, here you will see the necessary actions to enable plan sales on the Facey system for all possible terminal types. To this end, an update to the system was performed but due to roll backs and configuration issues, this requires additional work. Below is a table created by Aura that describes the current status:

Last updated: 5 years ago

How to follow up Flow Xborder transactions:

The purpose of this document is let to CS know how to proceed with the investigations in Xborder transactions and identify where we can find the root cause for failed transactions, this was related to the case #310965 due to FACEY escalated an issue to us regarding Xborder transactions processed in Antigua with Jamaica’s destination which were rejected with “invalid account error” Before start the process we need to understand the flow for these kind of transactions, see below and example: Before start with the research it is necessary to identify the destination for these Xborder transactions, see the example below: 1\. We takes the transaction ID: 387544863 from FACEY Antigua 2\. Then, following the flow transaction and after the activator sent the transaction to CWC side, we need to identify this one in CWC Antigua, so we pulled out the “Transaction Summary Error” selecting the “Show errors by ERROR” option and filtering with the product IC Out FLOW JAM (SKU: 101174) 3\. Once the dates and the product were configured, we get the below screenshot, which, if we go into the errors posted we will be able to find the transaction in CWC looking for Facey’s trx ID. (In CWC it will appear as a Invoice number). 4\. Finally as the transaction destination was Jamaica, we pull out the same report in CWC Jamaica but in this case setting the option “Show errors by Merchant” and select the merchant “ANU2JAM” (since the transaction comes from Antigua to Jamaica). 5\. Click on errors as shows in the below screenshot: 6\. Finally, you have to seek the transaction with the phone number or the Facey’s transaction ID (which is the Invoice number in CWC side) and you will be able to see the real error: As you will be able to see in the above screenshot in the amount field there is a negative one, which caused “34/ Invalid Amount -Terminal Limit Error” error, the root cause was related to the exchange rate that is configured by CWC in their platform, they introduced a new exchange rate in the “Flat Fee” field that caused a negative amount in the transaction destination. Also, you will be able to see these errors in the host logs or Front end tool as well, the only thing to keep in mind is the flow transaction.

Last updated: 5 years ago

Interlinc Facey - NRP Transactions Using Soap UI

Interlinc Facey - NRP Transactions Using Soap UI The purpose of this document is to let you know how to process a NRP transaction using Soap UI. Well, this kind of product needs to be executed using two different methods than the PinDistSale. Context NRP products: Have a special configuration that process the tax charge to the merchant. NON-NRP product: Do not charge the tax to the merchant. API Methods for Processing NRP transactions executeCommand - GetProductFinancialCharges: Let to know what are associated charges to a product. executeCommand - FinancialChargesSale: Do a recharge or pin sale using financial charges. Step No. 1 - executeCommand - GetProductFinancialCharges GetProductFinancialCharges { "version":"1", "siteId": "9705796", "productId": "942001", "collectedAmount": 100, "invoiceNo": "131217", "language": 1 } When this first method is executed, the Emida API will give you a JSON response that contains the following structure: 0 00 { "productId": "942001", "taxValues": "%5B%22A8EAC76E-4454-EB11-88AB-0024E85D5910%22%5D", "feeDistributionRules": "%5B%22D43F5D66-64CE-4FC6-B1CA-F08BB5CEE4A7%22%5D", "productAmount": 125.0, "mainAmountTaxPercent": 25.0, "mainAmountTaxValue": 0, "fixedFeeValue": 0, "fixedFeeTaxPercent": 0, "fixedFeeTaxValue": 0, "totalValue": 125.0, "resultStatus": 0 } The relevant parameters you need to obtain from the above JSON response are taxValues, feeDistributionRules y productAmount. Step No. 2 - executeCommand - FinancialChargesSale This second step will let you process the transaction. As you can see, the three parameters you got from the previous method, are used in this second step. Please take into account the amount parameter must containg the Gross Amount (Net amount - Tax amount) and the collectedAmount must contain the net amount (amount without the tax) FinancialChargesSale { "version":"01", "siteId": "9705796", "productId": "942001", "clerkId": "8888", "amount": 125, "collectedAmount": 100, "accountId" : "8767911940", "taxValues": "%5B%22A8EAC76E-4454-EB11-88AB-0024E85D5910%22%5D", "feeDistributionRules": "%5B%22D43F5D66-64CE-4FC6-B1CA-F08BB5CEE4A7%22%5D", "invoiceNo": "01", "language": 1 } You can find attached the API documentation where these two methods are explained in detail. EMIDA Web Services Specification For Emida Platform - DTU v1.72 Table of Contents 1. Introduction 14 Support 14 Service Organization 14 Requesting a Service 14 2. Important Notes 15 3. General Transaction Flow and Retry policy 16 4. Result Codes 19 5. CommTest Service 21 Request Parameters 21 Return Parameters 21 Sample Client Code 21 6. PinDistSale For Pins Service 22 Request Parameters 22 Response Parameters 23 7. PinDistSale For Account Payments 25 Request Parameters 25 Response Parameters 26 8. PinDistSale For Card Activations 28 Request Parameters 28 Response Parameters 29 9. TransactionConfirm Service 30 Request Parameters 30 Response Parameters 30 10. GetProductList Service 31 Request Parameters 31 Response Parameters 31 11. GetCarrierList Service 33 Request Parameters 33 Response Parameters 33 This information is proprietary to Emida, Inc. and subject to non-disclosure. Web Services Specification 2 of 341 12. GetCategoryList Service 34 Request Parameters 34 Response Parameters 34 13. GetTransTypeList : Service 35 Request Parameters 35 Response Parameters 35 14. PINReturnReques Service 36 Request Parameters 36 Response Parameters 36 15. TransRefund Service 38 Request Parameters 38 Response Parameters 38 16. GetAccountBalance Service 40 Request Parameters 40 Response Parameters 40 17. SubmitPaymentNotification Service 41 Request Parameters 41 Response Parameters 41 18. GetBillPaymentBalance 43 Request Parameters 43 Response Parameters 43 19. BillPayment 45 Request Parameters 45 Response Parameters 45 20. GiftCardQueryFee 47 Request Parameters 47 Response Parameters 47 21. GiftCardActivate 48 Request Parameters 48 Response Parameters 48 22. GiftCardBalance 50 Request Parameters 50 Response Parameters 50 23. GiftCardDeactivate 52 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 3 of 341 Request Parameters 52 Response Parameters 52 24. StoredValueQueryFee 54 Request Parameters 54 Response Parameters 54 25. StoredValueActivate 55 Request Parameters 55 Response Parameters 55 26. StoredValueLoad57 Request Parameters 57 Response Parameters 57 27. StoredValueBalance 58 Request Parameters 58 Response Parameters 58 28. StoredValueRefund 59 Request Parameters 59 Response Parameters 59 29. StoredValueDeactivate 61 Request Parameters 61 Response Parameters 61 30. CheckTransactionByInvoiceNo63 Request Parameters 63 Response Parameters 63 31. GetBProductList Service 65 Request Parameters 65 Response Parameters 65 32. CheckProviderStatusService 66 Request Parameters 66 Response Parameters 66 33. GetProductFee 68 Request Parameters 68 Response Parameters 68 34. PINDistSale for Mobile Wallet Operations 70 Request Parameters Registration 70 Response Parameters Registration 71 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 4 of 341 Request Parameters Cash-In 72 Response Parameters Cash-In 73 Request Parameters Cash-out 74 Response Parameters Cash-out 75 35. PinDistSaleUSSD 77 Request Parameters 77 Response Parameters 78 36. PINDistSale for Registration Fee Products 79 Request Parameters 79 Response Parameters 80 37. LookUpTransactionBylnvoiceNo81 Request Parameters 81 Response Parameters 81 38. ApplyPayment 83 Request Parameters 83 Response Parameters 84 39. ApplyPaymentISOLevel 85 Request Parameters 85 Response Parameters 86 40. ApplyPaymentAgentLevel 87 Request Parameters 87 Response Parameters 88 41. GetMerchantBalance 89 Request Parameters 89 Response Parameters 89 42. DoSimActivationCDMA1 91 Request Parameters 91 Response 92 43. DoSimActivationGSM1 94 Request Parameters 94 Response 95 44. LookUpSimActivationBylnvoiceNo1 97 Request Parameters 97 Response 98 45. GetPinProductsForActivatior 101 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 5 of 341 Request Parameters 101 Response Parameters 101 40. PinDistSale with Subscriber's PIN 103 Request Parameters 103 Response Parameters 105 Quippi Gift Cards related methods 106 46. QuippiCreatePIN 107 Request Parameters 107 Response Parameters 108 47. QuippiCancelPIN 110 Request Parameters 110 Response Parameters 111 48. LookupQuippiTransactionBylnvoiceNo 113 Request Parameters 113 Response Parameters 113 49. GetQuippiFxRate 115 Request Parameters 115 Response Parameters 115 50. QuippiAuthorize 117 Request Parameters 117 Response Parameters 117 51. QuippiRedeem 119 Request Parameters 119 Response Parameters 119 Lyca related methods 121 52. LycaPortinPin 122 Request Parameters 122 Response Parameters 123 53. LycaPortinRTR 124 Request Parameters 124 Response Parameters 125 54. LycaPortInDetails126 Request Parameters 126 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 6 of 341 Response Parameters 127 55. LycaCheckPortlnEligibility 129 Request Parameters 129 Response Parameters 130 56. CancelPortIn 131 Request Parameters 131 Response Parameters 132 57. ModifyPortIn 133 Request Parameters 133 Response Parameters 134 58. LycaActivationPin 135 Request Parameters 135 Response Parameters 136 59. LycaActivationRTR 137 Request Parameters 137 Response Parameters 138 Locus Activation Related Methods 139 60. LocusActivateCDMAesn 141 61. LocusActivateCDMAsim 143 62. LocusActiv61. LocusActivateCDMAsim 145 ateGSMAfcode 147 63. LocusActivateGSMsim 149 User Sesion Based Services 151 64. Login 152 Request Parameters 152 Response Parameters 152 65. Logout 154 Request Parameters 154 Response Parameters 154 66. CheckClerk 155 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 7 of 341 Request Parameters 155 Response Parameters 155 67. Login2 156 Request Parameters 156 Response Parameters 156 Services For NOC Project 158 68. NOCOperation 159 Request Parameters 159 Response Parameters 159 69. sendNotification 160 Request Parameters 160 Response Parameters 160 70. BillPaymentInfoMx 161 71. BillPaymentSaleMx 164 72. TransactionsDetailsForDay 167 73. PINReturnRequestStatus 170 41. IsoLogin 173 75. IsoLogout 175 76. CheckMerchantBylsoAndTaxld 178 77. InsertMerchant 182 78. LocusCreateMultiLine2Lines 189 79. locusCreateMultiLine4Lines 192 80. LocusActivateMultiLineSim 194 81. locusActivateMultiLineAfCode 197 82. ValidatelsoLogin 200 83. ValidatelsoToken2 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 8 of 341 84. H2OWirelessPortin 205 85. LocusActivateGSMsimPhoneBundle 211 86. FreeUpMobileUtil 214 87. FreeUpMobileActivations217 88. FreeUpMobilePortin 221 89. FreeUpMobilePortinStatus 226 90. LocusActivateGSMAfCodePhoneBundle 230 91. GetActivationDataBySIMNumber 234 92. GSSATTActivation 237 93. GSSATTPortin 240 94. getExecutionEnvironment 243 Request 243 Response 243 95. Activation347 244 96. GetPortinElegibility348 248 97. Portin348 251 98. GetActiveMessages 255 99. PinDistSaleExtraData 257 Request Parameters 257 Response Parameters 258 100. CustomerDue352 260 101. EquipmentValidation332 262 102. Activate332 264 103. Portin332 268 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 9 of 341 104. Get Terminal Transactions Compact Report 272 105. GetProductListDetailed 275 106. SwapEquipment349 277 107. InquirePort349 279 108. executeCommand 281 109. executeCommandHelp 283 110. executeCommandAllList 285 111. GSSInquireSubscriberStatus 286 112. executeCommand - prasanPreAuthorizationService 287 113. executeCommand - ProductFlowlnfoService 290 114. Get Today's Summary Report 295 115. Get Monthly Summary Report 297 116. Get Weekly Summary Report 299 117. Get Yesterday Summary Report 301 118. Get Last 5 Transactions Report 303 119. executeCommand - GetProductFinancialCharges 305 120. executeCommand - FinancialChargesSale 307 121. executeCommand - DigitalProductService 309 122. Get Last 5 Transactions Report With Profit 312 123. executeCommand - ApplyPaymentToRe 314 124. executeCommand - TelikomMeteringService 316 125. executeCommand - InternalReport 318 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 10 of 341 125. executeCommand - BillPayment_GetBill: 320 126. executeCommand - PaymentReview 324 127. executeCommand - BillPayment_PayBil 326 128. executeCommand-GenMobileActivatior 335 129.executeCommand-GenMobilePortin - 337 130. executeCommand-GenMobileQuery 340 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 11 of 341 Revision History Version Change History 1.71 executeCommand TelikcomMeteringServices and BillPaymentService 1.70 executeCommand DigitalProductService 1.66 executeCommand Update parameters and merge documentation 1.65 Adding GSSInquireSubscriberStatus 1.64 executeCommandHelp: This method allows to know the parameters of a specific method (old or new) executeCommand : This method allows execute any current webservices method 1.63 SwapEquipment349 InquirePort349 1.62 GetProductListDetailed 1.61 GetTerminalTransactionsCompact (Report by phone number) 1.60 EquipmentValidation332 Activate332 Portin332 1.59 CustomerDue352 1.58 PinDistSaleExtraData terminal data from third parties. Id, type balance 1.57 GetActiveMessages 1.56 New Methods 348 (Activation, GetPortinElegibility, Portin) 1.55 New Methods GSSATTActivation/ GSSATTPortin 1.54 New method PinDistSaleSubscriberPIN for recharging subscribers with mandatory PIN. New method for SOAP monitoring getExecutionEnvironment 1.53 FreeUpMobilePortinStatus, look up for a previous port-in action 1.52 Two new methods FreeUpMobileUtil and FreeUpMobilePortin. 1.51 New method GetActivationDataBySIMNumber to search SIMNumber information 1.50 New Method LocusActivateGSMAfCodePhoneBundle Add IMEI parameter to LocusActivateGSMsimPhoneBundlel Method 1.49 New Method LocusActivateGSMsimPhoneBundle New Method FreeUpMobileActivations 1.48 New Method to porting H2Owireless (H2OwirelessPortin) 1.47 New methods to verify IsoLogin and verify IsoToken (ValidatelsoLogin, ValidatelsoToker 1.46 LocusCreateMultiLine2Lines, LocusCreateMultiLine4Lines, LocusActivateMultiLineSim, LocusActivateMultiLineAfCode This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 12 of 341 1.45 New methods to Insert a new Merchant (only Isos): IsoLogin, IsoLogout, CheckMerchantBylsoAndTaxld, InsertMerchant 1.44 Update to include two new methods: TransactionsDetailsForDay and PINReturnRequestStatus 1.43 Update for some methods and remove deprecated methods. 1.42 Add methods of Lyca activation 1.41 Add Activation Locus Methods 1.40 Carrier code for Verizon on DMC activations has changed from VZW to VERIZ. Additionally, the rules on ICCID and SN field were specified by carrier. 1.39 Adding new methods to allow the management of Quippi GiftCards. Please note that a new section has been added to the document and the existing Giftcards method will not apply to Quippi Giftcards. 1.38 Adding Carrierld parameter to DMCActivation and DMCPortlnActivation. And format change of the dateOfBirth parameter for both DMCActivation and DMCPortlnActivation. 1.37 Fixed the response of BillPayment method. 1.36 Addition of new method ApplyPaymentAgentLevel to apply Payment to merchants from Agent level or Agent User 1.35 Addition of email as request parameter for DMCActivation and DMCPortlnActivation. 1.34 Addition of 4 new method calls for DMC Activations. 1.33 Addition of new method ApplyPaymentISOLevel to apply Payment to merchants from ISO level or ISO User. Addition of new methods to support SIM Activation transactions. The title of the 1.32 document was updated, minor formatting updates. 1.31 Addition of Ultra fee based products. Invoice number limitation updated. 1.30 Addition of Merchant phone number to MerchantID parameter of ApplyPayment 1.29 Addition of methods for Rep to Merchant payments 1.28 Addition of PinDistSaleUSSD and LookUpTransactionBylnvocieNomethods 1.27 Addition of MobileWallet operations, GetProductFee 1.26 Addition of retries policy chapter and Check last transaction status policy 1.25 Addition new methods for NOC project. 1.24 Added ResponseMessage, AuthorizationNo to the response parameters for 1.23 GiftCardActivate, GiftCardDeactivate methods. For GiftCardFee and GiftCardBalance added ResponseMessage Parameter. Addition of GetBProductList, CheckProviderStatus and Login2 methods. Modified the product id and account id request parameters on PINReturnRequest method 1.22 Addition of an item in the Important Notes section regarding considerations specific to International TopUp. 1.21 Addition of new method CheckTransactionBylnvoiceNo. 1.20 Modification of the "Important Notes" section in order to reflect a clearer statement of This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 13 of 341 Invoice reuse and Retry policy. 1.19 Modification of InvoiceNo and LanguageOptior in the PinDistSale methods, these parameters are now shown as required. In addition the section "Important Notes" was added to include items to have in mind when connecting to the WebService. 1.18 Addition of new document section and update of method Login to return Site ID based on Username/Password only. Addition of CheckClerk method to documentation of Services. Addition of workflow proposal to use the WS Authentication approach. Apendix A & B were removed and Standard methods specifications and samples updated. 1.17 Addition of new methods Login, Logout for Webservice Terminal User Authentication 1.16 Addition of new methods for GiftCard and StoredValue 1.15 Addition of new services for US and Mexico 1.14 Update on TransRefund service specification. 1.13 New service to allow Void Top Up requests. Updated description of PINReturnReques: service. 1.12 Updated web service URL 1.11 Other web methods section added for documentation purposes 1.10 Minor corrections to scrub data in example messages. 1.9 Minor corrections to tag names and message elements. 1.8 Clarified types on operations to be strings. Added Accountld attribute to the description in Section 4. Added Appendix B. 1.7 Added ConfirmTransaction service. 1.6 Added GetProductList, GetCarrierList, GetCategoryList, and GetTransType services. 1.5 Added appendix to describe using PinDistSale method for account payments. Removed PINDistRefund method description. Added WSDL appendix. 1.4 Moved service response result codes to section 1. Added PINDistRefund method. 1.3 Server address changed to cvs.debisys.com; Added CommTest method; Redefined PinDistSale method parameters & response definition 1.2 Identified required/non-required parameters for PinDistSale method 1.1 Removed PIN-caching elements from services description 1.0 First draft This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 14 of 341 1. Introduction Debisys Services Integration is an extension of the POS terminal requirements. Debisys' transaction functionality is exposed as web services via SOAP. Debisys utilizes Apache SOAP version 2.3. For more information of this Apache SOAP implementation, visit http://ws.apache.org/soap/index.html. Support For comments and/or questions, send email to cs@emida.net. Service Organization Services are defined by Debisys' current applications followed by the type of transaction requested. NOTE: Some Services use Site ID and other Services use Terminal ID to refer to the actual Point of Sale unique identifier. A new section is added to describe how Username/Password WS Authentication works. Requesting a Service To form a request, define a SOAP client to make a call based on the Debisys web services definition language (WSDL) file. The latest file can be found at: ttps://ws.emida.net:444/soap/webServices.wsdl All services are accessible at the web address https://webservice.emida.net/soap/servlet/rpcrouter Current services include a communications test, distribution of a prepaid PIN, and payment to a prepaid account. Additional services will be defined and this document updated as necessary. NOTE: The WSDL has precedence over this document in describing the available services and their request / response message signatures. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 15 of 341 2. Important Notes Before deploying your WebService client please consider the following items: For select carriers, it may be mandatory that only 1 WebService terminal exists for each terminal at a merchant location. The InvoiceNo parameter is mandatory in those methods that require it, this parameter references the internal Invoice managed by each client and which uniquely identify each transaction attempt. Each client can implement its own rules for handling this parameter and also such rules must include the following considerations: - After a successful transaction the invoice number must get incremented (by default in 1) When requesting non-PIN based products, a client connected to this SOAP Webservice has to establish a well defined reattempt logic, whenever a response is not received the client should reattempt the last transaction at least one time. Please provide your application with parameters to define: - Time between attempts - Number of attempts Suggested values are 3 reattempts and 20 seconds. Regarding International TopUp, the following considerations must be present: - The Product ID or SKU to be used is 4000, internally this Product ID is mapped to the product that successfully performed the TopUp. - The Account Number or Phone Number must always include the Country Area. Products that may be margin based, but collect a service fee need to be built out appropriately as the Debisys system will look for a single amount which will translate as the top up amount and the service fee combined. You always need to use ResponseCode Tag to determinate if the transaction was successful or no. Using Response Message is not a valid way to evaluate the status of a transaction. API responses come inside a CDATA field, for that reason even thought they can contain an XML, it should not be treated as a fully compliant XML and need to be treated as a TEXT and encoded before trying to use a XML parser. More information about CDATA can be found here http://www.w3.org/TR/REC-xml/#sec-cdata-sect and http://www.w3.org/TR/REC- xml/#dt-chardata This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 16 of 341 3. General Transaction Flow and Retry policy Login2 LoginResponse PinDistSale PinDistSaleResponse PinDistSale LookUpTransactionByInvoiceN, PinDistSaleResponse PinDistSale PinDistSaleResponse It is mandatory for any integrator client to retry transactions when no response is received from the Webservice. USE CASE. No response Transaction, Check status Client sends request of transaction (PinDistSale) to the webservice No response is received after SecondsBetweenRetries seconds. Client sends request of LookUpTransactionBylnvoiceNo to Webservice Webservice replies Result message is presented to customer. End transaction flow. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 17 of 341 LookUpTransactionByInvoiceNo LookUpTransactionByinvoiceNo LookUpTransactionByinvoiceNo TIMEOUT AND END OF TRANSACTION PinDistSale (Attempt 1) (Attempt 2) (Attempt n) 0 t t+x t+2x t+nx t Initial TimeOut Inicial x Interval of query n Attemps number To this should be used as follows: Assuming that a total timeout of for example 40 seconds, if 20 seconds there is no response, you must invoke this method as part of the same transaction, if still no answer, 10 seconds (30) reinvokes and equally to 40 if still there is no answer. If any of the so-called response is obtained, the transaction ends. Method 1 PindistSale Method 1 Beginning Method 2 LookUpTransactionBylnvoiceNo 0 5 10 15 20 25 30 35 Method 2 Method 2 1st Attemp 2d Attemp This method is the mandatory use for any integrator client to validate transactions when no response is received from the Webservice. The method works using two parameters: NumberOfRetries: Integer Is the number of times that the client will retry the validation if no response is received from the Webservice or if the answer has the code 32 SecondsBetweenRetries: Integer Is the number of seconds that the client should wait for a response from the Webservice. In other words is the number of seconds between retries. After the max number of retries has passed the transaction will be reconciliated by Emida's reconciliation process. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 18 of 341 Start Yes Found Start answer? PindDistSale No Receive Third Yes answer Lookuptransaction before 40 No seconds? Yes Found No answer? End PindDistSale Send First No Lookuptransaction Fourth Lookuptransaction No Yes Found answer (50 seconds) Yes Found answer? No Second No Lookuptransaction Prepare TimeOut answer Print Receipt End This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 19 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 20 of 341 4. Result Codes The following table describes the result codes that are applicable for all request types. These codes are passed in the response to a service request as outlined in the following sections. Table 1 - Possible Service Response Codes Result Description Notes Code 00 Success 01 Invalid Amount Dollar amount requested does not match the product's configured amount. 02 Not Authorized The terminal indicated by the SiteID, is not allowed to sell product 03 Sold Out Product is currently unavailable due to an out-of-stock condition. 04 Product Disabled The requested product is currently disabled for the indicated terminal 05 Invalid Product The ProductID sent did not resolve to a known product 07 Invalid Version Supplied request version is invalid 10 Invalid Terminal The SitelD sent did not resolve to a known terminal 11 Disabled Terminal Terminal is currently disabled 12 Invalid Clerk ID Clerk-id entered is not valid 20 Invalid Merchant ID Supplied Merchant ID does not exist or it not associated to the Terminal 21 Invalid Bank Code Parameter bankCode has been specified as non-empty but the value doesn't match to the code of an existent Bank 23 Invalid Document Date Supplied DocumentDate doesn't match the format MM/dd/yyyy 24 Error when creating An error occurred when adding the Payment Notification PaymentRequest in the database 25 Invalid Document Supplied DocumentNumbe exceeds 64 bytes of length Number 95 Invalid IP Address Supplied IP Address is not authorized 96 Internal Error Internal Debisys system error 101 Invalid Login Information Username/Password empty or wrong 102 Not Logged In User is not logged in and trying to access any of the other public methods 103 WebService If the ISO for that Site id doesn't have this 'Enable This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 21 of 341 Result Description Notes Code Authentication Webservice Authentication for Terminals' permission Permission not enabled enabled 150 Provider Disabled If the provider is not up. 160 Username and/or The username and/or password entered are not valid password invalid 161 User does not have The user does not have permission to execute this permissions. method 162 Merchant does not The Merchant is not in the Rep's chain belong to the Rep 163 The merchant has The merchant has Unlimited Credit Unlimited Credit 164 The Rep does not have The Rep does not have enough credit to allow this enough credit to allow payment this payment 165 Merchant available credit Merchant available credit plus payment amount < 0 plus payment amount < 0 166 Payment must be less Payment must be less than Terminal sale than Terminal sale 167 Payment is greater than Payment is greater than Credit Limit Credit Limit 168 The Merchant has The Merchant has SharedBalance credit type SharedBalance credit type 169 Payment could not be Payment could not be processed processed 170 The merchant does not The merchant does not belong to the ISO belong to the ISO 171 The merchant doesnt not The merchant doesnt not belong to the Agent belong to the Agent This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 22 of 341 5. CommTest Service This service provides an application layer RPC transmission test. Request Parameters None Return Parameters Type Notes String 2-Char response. Currently "OK". Sample Client Code URL url = new URL ("http services.debisys.com/soap/servlet/rpcrouter" ; String encodingstyleURI = Constants.NS URISOAPENC, // Build the call. Call call = new Call () ; call.setTargetobjectURI ("urn:debisys-soap-services") ; all.setMethodName ("CommTest") i all.setEncodingStyleURI (encodingstyleURI) ; // Make the call Response resp = call.invoke ( * * router URL */ url, /* actionURI */ // Check the response. Parameter result = resp.getReturnValue () ; System.out.printlr result.getValue () ) ; } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 23 of 341 6. PinDistSale For Pins Service The prepaid PIN distribution (sale) service returns a PIN embedded in a product response. A product response contains a description and instruction on how to activate a pre-paid pin. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. AccountID String Y Not used for Pins Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistsale> (Version>01</Version> <SiteId>000000</SiteId> <ClerkId>1111</ClerkId> <ProductId>8815020</ProductId> <Amount>20.00</Amount> InvoiceNo>023282638576.37</InvoiceNo> (LanguageOption>01</LanguageOption> /PinDistSale> Response Parameters Parameter Tag Type Notes This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 24 of 341 Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Pin String PIN retrieved from inventory ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResultCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistsaleResponse <Version>01 </Version> InvoiceNo>023282638576.37</InvoiceNo> <ResponseCode>00</ResponseCode> IN>53829152988739</PIN> <ControlNo>22851482</ControlNo> <CarrierControlNo></CarrierControlNo) <CustomerServiceNo></CustomerServiceNo <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTime) (ResultCode>0</Resultcode> (ResponseMessage> $20.00 ProductABC&#x0a; DIAL 611 to recharge&#x0a; EnterPIN:53829152988739&#x0a; ABC CARE:888-266-7848 (/ResponseMessage> (TransactionId>16725644</TransactionIo (/PinDistSaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 25 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 26 of 341 7. PinDistSale For Account Payments This method allows a mobile subscriber to add funds to their account. The PinDistSale service can support this product with the addition of an AccountID parameter. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. AccountID String Y Between 10 and 16 digits. AccountID provides the account number to which the payment is applied. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistsale> <Version>01</Version> <SiteId>00000</SiteId) <ClerkId>1111</ClerkId> ProductId8814520</Productid> <AccountId5518556939</ AccountId > <Amount>20.00</Amount> <InvoiceNo>1234567</InvoiceNo> <LanguageOption>01</LanguageOptioni /PinDistSale> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 27 of 341 Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistsaleResponse> <Version>01 </Version> <InvoiceNo>1234567</InvoiceNo> <ResponseCode>00</ResponseCode> <PIN>5518556939</PIN> (ControlNo>22851832</CarrierControlNo> <CustomerServiceNo></CustomerServi (TransactionDateTime06/08/2005 :48:13:513</TransactionDateTimex <Resultcode>0</Resultcode> (ResponseMessagex $20.00 ProductXYZ Topup&#x0a; Your current balance is $243.43 MXP </ResponseMessage> TransactionId>16725644</TransactionId> (PinDistSaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 28 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 29 of 341 8. PinDistSale For Card Activations The PinDistSale web service can be used to transmit a card activation or recharge to the Debisys platform with a modification of the use of the ProductID parameter. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Card swipe data. The track 2 data should be recorded in this field, less sentinels and check digits. The swipe date read from the card should be preceded with an 's' to indicate that data was read from the swipe. If a card's account number is manually keyed, the 's' should be omitted. AccountID String Y May be empty. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistsale> <Version>01</Version> <SiteId>00000</SiteId <ClerkId>1111</ClerkId> <ProductId>s999=9999999999</ProductId> <AccountId></AccountId> <Amount>20.00</Amount> <InvoiceNo>1234567</InvoiceNo> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 30 of 341 LanguageOption>01</LanguageOption) </PinDistsalex Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String Typically empty ControlNo String Typically empty CarrierControlNo String Typically empty CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResultCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistsaleResponse> <Version>01 </Version> InvoiceNo>1234567</InvoiceNo> KResponseCode>00</ResponseCode> <PIN></PIN> <ControlNo></ControlNo <CarrierControlNo></CarrierControlN <CustomerServiceNo></CustomerServiceNo> <TransactionDateTime>06/08/200510:48:13:513</TransactionDateTimex (ResultCode>0</Resultcode> <ResponseMessage> $20.00 Card Recharge&#x0a; Your current balance is $243.43 </ResponseMessage> TransactionId>16725644</TransactionId </PinDistSaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 31 of 341 9. TransactionConfirm Service This service may be used by a client ot confirm receipt of a PinDistSaleResponse message. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Siteld String Y Between 5 and 9 digits Transactionld String N Debisys transaction reference number from prior PinDistSaleResponse Request parameters are sent as an XML string. A sample request is: <TransactionConfirmRequest> <Version>01</Version> <SiteId>00000</Siteld> (TransactionId>16725644</TransactionId> </TransactionConfirmRequest> Response Parameters Field Type Notes Siteld String SiteID parameter echoed from the request message Transactionld String Debisys transaction reference number echoed from the request message Response parameters are returned as an XML string. A sample response is: TransactionConfirmResponse> <SiteId>00000</SiteId> (TransactionId>16725644</TransactionId> </TransactionConfirmResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 32 of 341 10. GetProductList Service The GetProductList service provides a list of products given a specific terminal id. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits TransactionTypeld String N Valid transaction type id from GetTransTypeList Carrierld String N Valid carrier id from GetCarrierList Categoryld String N Valid category id from GetCategoryList Productld String N Valid product id from GetProductList Response Parameters Field Type Notes Productld String Unique id for the product. Description String Description of product ShortDescription String Shortened description currently used for terminal display. Amount String Monetary value of product Carrierld String Carrier Id denotes the carrier for this product i.e. Boost, Cingular, Verizon. A list of supported carrier id's and descriptions can be obtained by calling GetCarrierList Categoryld String Category Id denotes a category for this product i.e. Wireless, Long Distance, Topup. A list of supported category id's and descriptions can be obtained by calling GetCategoryList TransTypeld String Transaction Type Id currently denotes a transaction type for this product i.e. Activate, Pin, or Payment. A list of supported transaction type id's and descriptions can be obtained by calling GetTransTypeList CurrencyCode String 3 letter currency code i.e. USD(US Dollar), MXN(Mexican Peso) CurrencySymbol String Currency symbol i.e. $ DiscountRate String The discount rate is the percentage of the Amount that the merchant retains from the transaction; e.g,- "14.5" This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 33 of 341 Response parameters are returned as an XML string. A sample response is: <GetProductListResponse <Version>01</Version> <Product> <ProductId>8000000</ProductId> (Description>Test Pins</Description> <ShortDescription>Test PIN</ShortDescription> <Amount>20</Amount> <CarrierId>41</CarrierId> <CategoryId>O</CategoryId> <TransTypeId>2</TransTypeId> CurrencyCode>USD</CurrencyCode> <CurrencySymbol>$</Currencysymbol> <DiscountRate>14.5</DiscountRate> </Product> <Product> ProductId>8814510</ProductId> <Description>XYZ 10</Description> <ShortDescription>Roaming- - $10</ShortDescription> <Amount>10</Amount> <CarrierId>62</CarrierId> <CategoryId>1</CategoryId> TransTypeId>3</TransTypeId> <CurrencyCode>USD</CurrencyCode> <Currencysymbol>$</Currencysymbol <DiscountRate>12.5</DiscountRate> </Product> (/GetProductListResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 34 of 341 11. GetCarrierList Service The GetCarrierList service provides a list of carriers given a specific terminal id. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits TransactionTypeld String N Valid transaction type id from GetTransTypeList Carrierld String N Valid carrier id from GetCarrierList Categoryld String N Valid category id from GetCategoryList Productld String N Valid product id from GetProductList Response Parameters Field Type Notes Carrierld String Unique id for the carrier. Description String Description of carrier ProductCount String Number of products this carrier provides Response parameters are returned as an XML string. A sample response is: IGetCarrierListResponse> <Version>01</Version> <Carrier> <CarrierId>41</CarrierId> <Description>Test</Description> <ProductCount>1</ProductCount> </Carrier> <Carrier> <CarrierId>62</CarrierId> <Description>XYZ</Description> <ProductCount>1</ProductCount> </Carrier> (/GetCarrierListResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 35 of 341 12. GetCategoryList Service The GetCategoryList service provides a list of categories given a specific terminal id. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits TransactionTypeld String N Valid transaction type id from GetTransTypeList Carrierld String N Valid carrier id from GetCarrierList Categoryld String N Valid category id from GetCategoryList Productld String N Valid product id from GetProductList Response Parameters Field Type Notes Categoryld String Unique id for the category. Description String Description of category ProductCount String Number of products in this category Response parameters are returned as an XML string. A sample response is: KGetCategoryListRespons <Version>01</Versioni <Category> <CategoryId>0</CategoryId> <Description>Test</Description> <Productount>2</ProductCount> </Category> <Category> (CategoryId>1</CategoryId> <Description>Wireless</Description <ProductCount>1</ProductCount> :/Category> </GetCategoryListResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 36 of 341 13. GetTransTypeList Service The GetTransTypeList service provides a list of categories given a specific terminal id. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits TransactionTypeld String N Valid transaction type id from GetTransTypeList Carrierld String N Valid carrier id from GetCarrierList Categoryld String N Valid category id from GetCategoryList Productld String N Valid product id from GetProductList Response Parameters Field Type Notes TransTypeld String Unique id for the transaction type. Description String Description of transaction type ProductCount String Number of products in this transaction type Response parameters are returned as an XML string. A sample response is: GetTransTypeListResponse> <Version>01</Version> <TransType> <TransTypeId>2</TransTypeId> <Description>PIN</Description> (ProductCount>1</ProductCount> </TransType> <TransType> (TransTypeId>3</TransTypeId> <Description>Payment</Description> <ProductCount2</ProductCount> </TransType> </GetTransTypeListResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 37 of 341 14. PINReturnRequest Service The PINReturnRequest service provides a way to submit a PIN Return request for further revision. It doesn't mean it was processed in real time. As part of the response is returned a case number that can be use to track status of the request through Support Site. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y You need to pass always productld = 812 AccountID String Y Original PIN Number that was generated with original transaction. Amount String Y Original amount collected at the point of sale. It will be interpreted in local currency. InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ControlNo String PIN's Debisys internal control number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product Transactionld String Case number associated with the PIN Return requet. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 38 of 341 Response parameters are returned as an XML string. A sample response is: <TransRefundResponse> <Version>01</Version) <InvoiceNo>ABC001</InvoiceNo> <ResponseCode>00</ResponseCode) <ControlNo>22851482</ControlNo> <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTime> <ResponseMessage> You Pin Return request was received. Case Number 12345 </ResponseMessage> <TransactionId>1234567</TransactionId> </TransRefundResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 39 of 341 15. TransRefund Service The TransRefund service provides a way to void a previous successful Top-Up. This method was activated for only RTR Products where manual returns are available. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y You need to pass always productld = 815 AccountID String Y Original transaction Id and Phone Number associated with the transaction to be voided. The format is: <original_trans_id>=<phone_number> Amount String Y Original amount collected at the point of sale. It will be interpreted in local currency. InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ControlNo String PIN's Debisys internal control number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product Transactionld String Debisys transaction reference number This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 40 of 341 Response parameters are returned as an XML string. A sample response is: TransRefundResponse> <Version>01</Version> (InvoiceNo>ABC001</InvoiceNo> (ResponseCode>00</ResponseCode> <ControlNo>22851482</ControlNo> <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTimex (ResponseMessage> VOID Sucessful </ResponseMessage> TransactionId>1234567</TransactionId> </TransRefundResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 41 of 341 16. GetAccountBalance Service The GetAccountBalance service provides a way to query the current balance for any merchant. Request Parameters Field Type Required Notes version String Y This value should be set to the public IP of the client that calls the WebService, this value is intended for security purposes. terminalld String Y Between 5 and 9 digits merchantld String Y This value should be set to the MerchantID of the merchant whose balance is going to be queried. Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure siteld String Same value as parameter terminalld merchantld String Same value as parameter merchantld legalBusinessName String BusinessName of supplied Merchant dba String DBA Name of supplied Merchant availableBalance String Current balance of supplied Merchant Response parameters are returned as an XML string. A sample response is: <GetAccountBalanceResponse> <Version>01</Version> <ResponseCode>00</ResponseCodex <siteId>2752581</siteId> <merchantId>280195010144</merchantId> <legalBusinessname>1</legalBusinessname> <dba>1</dba> <availableBalance>4519.35</availableBalance GetAccountBalanceResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 42 of 341 17. SubmitPaymentNotification Service The SubmitPaymentNotification service provides a way to report a deposit made by the merchant in the Debisys account. Request Parameters Field Type Required Notes version String Y This value should be set to the public IP of the client that calls the WebService, this value is intended for security purposes. terminalld String Y Between 5 and 9 digits amount String Y Amount of Payment. clerkPassword String Y This value should be set to the password of the clerk who is reporting the Payment Notification, this password should be the same one used to log-in into the terminal. documentNumber String Y This value should be set to the Reference Number issued by the bank or any corresponding entity and which allows to uniquely differentiate the Payment, this value can't exceed 64 bytes. documentDate String Y This value should be set to the date when the Payment was made, this value should be in the format MM/dd/yyyy. bankCode String N This value should be set to an empty string or otherwise should be set to the code of one of the currently registered banks, such codes are listed as follows: BNM Banamex HSBC Santander Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure siteld String Same value as parameter terminalld This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 43 of 341 requestld String This tag contains the ID of the Payment Notification generated in the Debisys platform, this value should be used by the merchant for further tracking of such Payment. Response parameters are returned as an XML string. A sample response is: <SubmitPaymentNotificationResponse> <Version>01</Version> <ResponseCode>00</ResponseCode> <siteld>2752581</siteld> <requestId>74910</requestId> SubmitPaymentNotificationResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 44 of 341 18. GetBillPaymentBalance The GetBillPaymentBalance service provides a way to query the current balance from an Account in the biller system. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id AccountID String Y Phone number that will be query InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ControlNo String PIN's Debisys internal control number TransactionDateTime String Debisys transaction date & time Transactionld String Debisys transaction reference number ResponseMessage String Field with the message for the success or failure transaction ClientName String Customer name AccountNumber String Customer account number TransactionFeeAmount String Biller transaction fee amount CurrentAmountDue String Current amount due PastAmountDue String Past amount due This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 45 of 341 TotalAmountDue String Total amount due CurrentAmountDueOr String Bill due date ConvenienceFee String Debisys transaction fee amount Response parameters are returned as an XML string. A sample response is: TransRefundResponse> <Version>01</Version> (InvoiceNo>ABC001</InvoiceNo> (ResponseCode>00</ResponseCode> <ControlNo>22851482</ControlNo <TransactionDateTime>06/08/2008 10:48:13:513</TransactionDateTimex <ResponseMessage>Sucessful transaction</ResponseMessage> <TransactionId>1234567</TransactionId> ClientName>ARLECIAALFORD</ClientNamel AccountNumber>11085348341</AccountNumber> <TransactionFeeAmount>0.25</TransactionFeeAmountx KCurrentAmountDue>200</CurrentAmountDue> (PastAmountDue>100</PastAmountDue> (TotalAmountDue300</TotalAmountDue> <CurrentAmountDueOn>06/08/2008 10:48:14:513</CurrentAmountDueOn> (ConvenienceFee>0.1</ConvenienceFee> /TransRefundResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 46 of 341 19. BillPayment The BillPayment service provides a way to make a Bill Payment in the Billing system. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id AccountID String Y Phone number that will be query Amount String Y Original amount collected at the point of sale. It will be interpreted in local currency. InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ControlNo String PIN's Debisys internal control number TransactionDateTime String Debisys transaction date & time Transactionld String Debisys transaction reference number ResponseMessage String Field with the message for the success or failure transaction ClientName String Customer name AccountNumber String Customer account number TransactionFeeAmount String Biller transaction fee amount CurrentAmountDue String Current amount due This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 47 of 341 PastAmountDue String Past amount due TotalAmountDue String Total amount due CurrentAmountDueOn String Bill due date ConvenienceFee String Debisys transaction fee amount Response parameters are returned as an XML string. A sample response is: (BillPaymentResponse> (Version>01</Version> <InvoiceNo>ABC001</InvoiceNo> <ResponseCode>00</ResponseCode> <ControlNo>22851482</ControlNo> TransactionDateTime>06/08/2008 10:48:13:513</TransactionDateTime> <ResponseMessage>Sucessful transaction</ResponseMessage> ansactionId>1234567</TransactionId> <ClientName>ARLECIA ALFORD</ClientName> AccountNumber>11085348341</AccountNumber> (TransactionFeeAmount>0.25</TransactionFeeAmount> (CurrentAmountDue>200</CurrentAmountDue> <PastAmountDue>100</PastAmountDue> TotalAmountDue>300</TotalAmountDue> <CurrentAmountDueOn>06/08/200810:48:14:513</CurrentAmountDueOn) <ConvenienceFee>0.1</ConvenienceFee> </BillPaymentResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 48 of 341 20. GiftCardQueryFee The GiftCardQueryFee service provides a way to query the current fee for a GiftCard Activation. NOTE: Please note this method is nor applicable to Quippi Giftcards Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Response Message String Field with the message for the success or failure transaction Fee String Fee for the specified product Response parameters are returned as an XML string. A sample response is: KGiftCardQueryResponse> <Version>01</Version> <InvoiceNo>1</InvoiceNo) <ResponseCode>00</ResponseCode <ResponseMessage>GIFTCARD QUERY FEE SUCCEEDED</ResponseMessage> <Fee3.95</Fee> </GiftCardQueryResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 49 of 341 21. GiftCardActivate The GiftCardActivate service provides a way to Activate a specific GiftCard. NOTE: Please note this method is nor applicable to Quippi Giftcards Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id SerialNumber String Y Serial Number printed in the GiftCard package InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Response Message String Field with the message for the success or failure transaction TransactionDateTime String Datetime of the transaction Transactionld String ID of the transaction AuthorizationNo String Authorization Number from the card Provider for successful giftcard activation Response parameters are returned as an XML string. A sample response is: (GiftCardActivateResponse> <Version>01</Version> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 50 of 341 <InvoiceNo>1</InvoiceNo <ResponseCode>0o</ResponseCodex <ResponseMessage>GIFTCARD ACTIVATION SUCCEEDED</ResponseMessage> <TransactionDateTime>10/15/2009 18:12:06:53</TransactionDateTime> <TransactionId>116465621</TransactionId> <AuthorizationNo>00000000000113321916</AuthorizationNo> //GiftCardActivateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 51 of 341 22. GiftCardBalance The GiftCardBalance service provides a way to query a previously activated GiftCard. NOTE: Please note this method is nor applicable to Quippi Giftcards Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id CardNumber String Y Card Number printed in the plastic card InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Response Message String Field with the message for the success or failure transaction TransactionDateTime String Datetime of the transaction Balance String Current balance for the specified card Response parameters are returned as an XML string. A sample response is: GiftCardBalanceResponse> <Version>01</Version> <InvoiceNo>1</InvoiceNo> <ResponseCode>00</ResponseCod (ResponseMessage>GIFTCARD BALANCE SUCCEEDED</ResponseMessage <TransactionDateTime>10/15/2009 :13:35:630</TransactionDateTime (Balance>25</Balance> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 52 of 341 </GiftCardBalanceResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 53 of 341 23. GiftCardDeactivate The GiftCardDeactivate service provides a way to Deactivate a previously activated GiftCard. NOTE: Please note this method is nor applicable to Quippi Giftcards Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id TransactionID String Y TransactionID generated when the GiftCard was activated InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Response Message String Field with the message for the success or failure transaction TransactionDateTime String Datetime of the transaction Transactionld String ID of the transaction SerialNumber String Serial of the original package when this card was activated ProductShortName String Product name for display purpose ProductAmount String Fixed amount of card for display purpose Productld String ProductID for display purpose This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 54 of 341 AuthorizationNo String Authorization Number from the card Provider for successful giftcard deactivation Response parameters are returned as an XML string. A sample response is: IGiftCardDeactivateResponse> <Version>01</Version> <InvoiceNo>1</InvoiceNo> <ResponseCode>00</ResponseCode> <ResponseMessage>GIFTCARD DEACTIVATION SUCCEEDED</ResponseMessage) <TransactionDateTime>10/15/20091 8:13:41:20</TransactionDateTime> <TransactionId>116465625</TransactionId> <SerialNumber>999999002569</SerialNumber> ProductshortName>GiftCardSBlln$25</ProductshortName> <ProductAmount>25</ProductAmount> (ProductId>8900014</ProductId> AuthorizationNo>00000000000113321916</AuthorizationNo> /GiftCardDeactivateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 55 of 341 24. StoredValueQueryFee The StoredValueQueryFee service provides a way to query the current fee for either a StoredValue Activation or Load. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id Operation String Y 51 for an Activation or 54 for a Load Amount String Y Amount of the Activation or Load InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Fee String Fee for the specified product Response parameters are returned as an XML string. A sample response is: <StoredValueQueryResponse> <Version>01</Versioni InvoiceNo>1</InvoiceNo> ResponseCode>00</ResponseCode> <Fee2.95</Fee> </StoredValueQueryResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 56 of 341 25. StoredValueActivate The StoredValueActivate service provides a way to Activate a prepaid card with a specific amount. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id SerialNumber String Y Serial Number printed in the prepaid card package Amount String Y Amount of the Activation InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTime String Datetime of the transaction Transactionld String ID of the transaction Response parameters are returned as an XML string. A sample response is: <StoredValueActivateResponse> <Version>01</Version> <InvoiceNox1</InvoiceNo> (ResponseCode>00</ResponseCode> <TransactionDateTime>10/16/2009 :46:58:923</TransactionDateTimel This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 57 of 341 <TransactionId>116465654</TransactionId> </StoredValueActivateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 58 of 341 26. StoredValueLoad The StoredValueLoad service provides a way to Load an amount to a prepaid card. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id CardNumber String Y Card Number printed in the plastic card Amount String Y Amount of the Load InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTime String Datetime of the transaction Transactionld String ID of the transaction Response parameters are returned as an XML string. A sample response is: <StoredValueLoadResponse> <Version>01</Version> <InvoiceNo>1</InvoiceNo> (ResponseCode>00</ResponseCode> <TransactionDateTime>10/16/2009 116:47:08:477</TransactionDateTime) <TransactionId>116465656</TransactionId> </StoredValueLoadResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 59 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 60 of 341 27. StoredValueBalance The StoredValueBalance service provides a way to query a previously activated or loaded prepaid card. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id CardNumber String Y Card Number printed in the plastic card InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTime String Datetime of the transaction Balance String Current balance for the specified card Response parameters are returned as an XML string. A sample response is: <StoredValueBalanceResponse> <Version>01</Version> <InvoiceNo>1</InvoiceNo> <ResponseCode>00</ResponseCode> (TransactionDateTime>10/16/2009 :47:13:517</TransactionDateTimel <Balance>40</Balance> </StoredValueBalanceResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 61 of 341 28. StoredValueRefund The StoredValueRefund service provides a way to void a previous load for a prepaid card. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id TransactionID String Y TransactionID generated when the card was activated InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTime String Datetime of the transaction Transactionld String ID of the transaction SerialNumber String Serial of the original package when this card was activated ProductShortName String Product name for display purpose ProductAmount String Fixed amount of card for display purpose Productld String ProductID for display purpose Response parameters are returned as an XML string. A sample response is: <StoredValueRefundResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 62 of 341 <Version>01</Version> <InvoiceNo>1</InvoiceNo> (ResponseCode>00</ResponseCode> (TransactionDateTime>10/16/2009 16:47:26:40</TransactionDateTime> <TransactionId>116465660</TransactionId> <SerialNumber>6011905590169128</SerialNumber> ProductshortName>ProductxInstant</ProductshortNamex <ProductAmount>20</ProductAmount> <ProductId>8973899</ProductId> </StoredValueRefundResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 63 of 341 29. StoredValueDeactivate The StoredValueDeactivate service provides a way to Deactivate a previously activated prepaid card. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Debisys product Id TransactionID String Y TransactionID generated when the card was activated InvoiceNo String N Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTim String Datetime of the transaction Transactionld String ID of the transaction SerialNumber String Serial of the original package when this card was activated ProductShortName String Product name for display purpose ProductAmount String Fixed amount of card for display purpose Productld String ProductID for display purpose Response parameters are returned as an XML string. A sample response is: StoredValueDeactivateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 64 of 341 <Version>01</Version> <InvoiceNo>1</InvoiceNo> (ResponseCode>00</ResponseCode> (TransactionDateTime>10/16/2009 16:47:38:23</TransactionDateTimex <TransactionId>116465663</TransactionId> (SerialNumber>999999002572</SerialNumber> ProductshortName>ProductxInstant</ProductShortName> <ProductAmount20</ProductAmount> <ProductId>8973899</Productid> </StoredValueDeactivateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 65 of 341 30. CheckTransactionBylnvoiceNo The CheckTransactionBylnvoiceNo service checks if there's already a transaction using the invoice Number criteria. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. InvoiceNo String Y Between 1 to 9 digits. Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user depending if does exist the transaction (original response) or not ("No transactions have been made with invoiceNo: XXX for this terminal: terminalID") Transactionld String ID of the transaction if exists Response parameters are returned as an XML string. Sample responses are: - If it does exist a transaction: <CheckTransactionByInvoiceResponse <Version>01</Version> <ResponseCode>00</ResponseCode> (ResponseMessage>Transaction existent with invoiceNo: 38 in this terminal: 8446856 </ResponseMessage> ransactionId>116558759</TransactionId) CheckTransactionByInvoiceResponse> - If it does not exist transactions: CheckTransactionByInvoiceResponse> <Version>01</Version> <ResponseCode>32</ResponseCode> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 66 of 341 <ResponseMessage>N transactions have been made with invoiceNo: 66 in this terminal: 8446856</ResponseMessage> <TransactionId></TransactionId> </CheckTransactionByInvoiceResponse> - If it does not exist transactions caused by a failure: <CheckTransactionByInvoiceResponse> <Version>01</Version> <ResponseCode>33</ResponseCode) (ResponseMessage>Transaction attempt failed. (Providerresponse:17:)</ResponseMessagex <TransactionId></TransactionId> </CheckTransactionByInvoiceResponse This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 67 of 341 31. GetBProductList Service The GetBProductList service provides a list of mapping of UPC codes with Debisys Product ids configured for a specific terminal id. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. Productld String Unique id for the product. Productld String UPC code of Product Response parameters are returned as an XML string. A sample response is: GetBProductListResponse> <Version>01</Version> <Product> roductId>5035200</ProductId> BiaaniProductId>79931234555</ProductId> </Product> <Product> roductId>5035201</ProductId> <BiaaniProductId>79931234567</ProductId> (/Product> GetProductListResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 68 of 341 32. CheckProviderStatusService The CheckProviderStatus service checks if a product's provider is up or not. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits Productld String Y Unique Id for product Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user depending if provider is up or not. Response parameters are returned as an XML string. A sample response is: <CheckProviderStatusResponse> (ersion>01</Version> <ResponseCode>00</ResponseCode> KResponseMessage>PROVIDER ENABLED</ResponseMessage> theckProviderStatusResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 69 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 70 of 341 33. GetProductFee The GetProductFee service gets the fee( (if any) for any product. This is done specially to get the fee for Mobile Wallet products like Registration, Cash-In and Cash-out. It is also used to get products that require regulatory fees. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Productld String Y Unique Id for product Amount String Y This is field to identify if for Registration we have fee or not depending on the amount entered. Response parameters are sent as an XML string. A sample request is: <GetProductFee <version>01</version> <productId>89000113</productId> <amount>10</amount> /GetProductFee> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user depending if provider is up or not. Response parameters are returned as an XML string. A sample response is: <GetProductFeeResponse> <Version>01</Version> <ResponseCode>00</ResponseCodes> <ProductId>89000113</ProductId> <ProductDescription>Registration</ProductDescription> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 71 of 341 <ProductFee>1.5000</ProductFee> /GetProductFeeResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 72 of 341 34. PINDistSale for Mobile Wallet Operations This method allows a mobile subscriber to perform the MobileWallet Operations . Following are the different operations that can be performed from the MobileWallet. 1. Registration : This operation will let you register the subscriber mobile to Wallet system. Registration could be without amount or with amount. When you are just registering the phone you would entry 0 as amount. If you want to register plus load your wallet, you would enter amount you want to load plus the fee for Registration. This fee for registration can be extracted by using the method GetProductFee with parameters 01,89000113,x amount. For example you want to load the wallet for 100$ but the amount you would enter would be 100+ fee. Request Parameters Registration Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. Product ID for this operation is 89000113. AccountID String Y Between 10 and 16 digits. AccountID provides the account number which is being registered as MobileWallet. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistSale> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 73 of 341 KVersion>01</Version> <SiteId>00000</SiteId> <ClerkId>1111</ClerkId> <ProductId>89000113</ProductId> <AccountId>5518556939</ AccountId > (Amount>0</Amount> <InvoiceNo>1234567</InvoiceNo> LanguageOption>01</LanguageOption> </PinDistSale> Response Parameters Registration Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistSaleResponse> <Version>01 </Version> InvoiceNo>1234567</InvoiceNo> <ResponseCode>00</ResponseCode> <PIN>5518556939</PIN> <ControlNo>22851832</ControlNo> <CarrierControlNo>20227</CarrierControlNo> <CustomerServiceNo></CustomerServiceNo> <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTimex <ResultCode>0</ResultCode> <ResponseMessage> REGISTRATION SUCCEEDED. Cash In Amount: $0.00 Fee: 0.0 Total Load: $0.00 New Balance: $0.00 Account: 5518556939 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 74 of 341 Mobile Wallet Reference Number: 20229 ProductId: 89000113 Purchase and use of CAT is subject to the Terms and Conditionsof service which can be found at http://www.catwallet.com Company A, Inc 1111 Main Street, Anytown, CA 92610 Company A is a licensed Money Services Business Emida ensures delivery of this transaction. If you have questions, please contact your service provider For questions about this payment, complaints or to opt out, call 1-800-xxx- XXX </ResponseMessage> <TransactionId>16725644</TransactionId> (/PinDistsaleResponse> 2. Cash-In : This operation will let the subscriber mobile to add funds to their Wallet Cash-in amount will be amount the subscriber wants to load in plus the product fee that can be found using the service GetProductFee. So to cash-in for 100 you would need to add 100+fee. Example below is showing amount as 101.50 assuming a fee of 1.5 Request Parameters Cash-In Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. Product ID for this operation is 89000114. AccountID String Y Between 10 and 16 digits. AccountID provides the account number to which the mobile wallet is attached. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 75 of 341 Parameter Tag Type Required Notes LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistsale> (Version>01</Version> <SiteId>00000</SiteId <ClerkId>1111</ClerkId> <ProductId>89000114</ProductId> <AccountId>2138400000</ AccountId > <Amount>101.50</Amount> <InvoiceNo>1234567</InvoiceNo> LanguageOption>01</LanguageOption> (/PinDistSale> Response Parameters Cash-In Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistsaleResponse> <Version>01</Version> <InvoiceNo>9</InvoiceNo> <ResponseCode>00</ResponseCode> <Pin>1213840008</Pin> (ControlNo>65535717</ControlNo> <CarrierControlNo>20064</CarrierControlNo) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 76 of 341 CustomerServiceNo>12138400000</CustomerServiceNo> <TransactionDateTime>05/09/201212:36:26:250</TransactionDateTime <ResponseMessage> CASH-IN SUCCEEDED. Cash-In Amount: $100.00 Fee: $1.5 Total Amount: $101.50 NewBalance $1066.50 Mobile Wallet Reference Number: 314 ProductId: 89000114 Purchase and use of CAT is subject to the Terms and Conditionsof service which can be found at http://www.catwallet.com Company A, Inc 1111 Main Street, Anytown, CA 92610 Company A is a licensed Money Services Business Emida ensures delivery of this transaction. If you have questions, please contact your service provider For questions about this payment, complaints or to opt out, call 1-800-xxx- XXX (/ResponseMessage> <TransactionId>85249495</TransactionId> </PinDistsaleResponse> 3. Cash-Out : This operation will let the subscriber mobile to withdraw funds from their Wallet Since it's a withdrawal, you would need to add negative amount. So withdrawal of $100 means -100.00 as amount in the call. In Account ID parameter you would be adding the token you receieved from MobileWallet system to retrieve the cash. Request Parameters Cash-out Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. Product ID for this operation is 89000115. AccountID String Y AccountID provides TOKEN required to Cash-out This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 77 of 341 Parameter Tag Type Required Notes Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. In this case it has to be negative amount InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOptio String Y Single-digit number to indicate preferred language for n the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistSale> <Version>01</Version> SiteId>00000</SiteId> <ClerkId>1111</ClerkId> <ProductId>89000115</Productid> <AccountId>9090309680</ AccountId > <Amount>-100</Amount> <InvoiceNo>1234567</InvoiceNo> <LanguageOption>1</LanguageOption) /PinDistSale> Response Parameters Cash-out Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 78 of 341 Response parameters are returned as an XML string. A sample response is: (PinDistSaleResponse> <Version>01</Version> <InvoiceNo>9</InvoiceNo> <ResponseCode>00</ResponseCode> (Pin>9090309680</Pin> <ControlNo>65535717</ControlNo> <CarrierControlNo>20064</CarrierControlNo> <CustomerServiceNo>12138400000</CustomerServiceNo> <TransactionDateTime>05/09/201212:36:26:250</TransactionDateTime> <ResponseMessage> CASH-OUT SUCCEEDED. Cash Out Amount : $56.00 Fee: $8.00 New Balance : $1043.50 Account :12138408408 Mobile Wallet Reference Number : 321 ProductId: 89000115 Purchase and use of CAT is subject to the Terms and Conditionsof service which can be found at http://www.catwallet.com Company A, Inc 1111 Main Street, Anytown CA 92610 Company A is a licensed Money Services Business Emida ensures delivery of this transaction. If you have questions, please contact your service provider For questions about this payment, complaints or to opt out, call 1-800-xxx- XXX (/ResponseMessage> <TransactionId>85249507</TransactionId> PinDistsaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 79 of 341 35. PinDistSaleUSSD This method is intended for doing a pin sale, but instead of requesting the Siteld, it will use the terminal phone number in order to identify internally the current terminal Siteld. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. PhoneNumber String Y Send the terminal phone number here ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to se products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. AccountID String Y Not used for Pins Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response parameters are returned as an XML string. A sample response is: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 80 of 341 <PinDistSaleUSSD> <Version>01</Version> <PhoneNumber>9491733194</PhoneNumber> ClerkId>1111</ClerkId> ProductId>8815020</ProductId> <AccountID></AccountID> <Amount>20.00</Amount> <InvoiceNo>023282638576.37</InvoiceNo: <LanguageOption>01</LanguageOption> c/PinDistSaleUSSD> Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Pin String PIN retrieved from inventory ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResultCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product Transactionld String Debisys transaction reference number Sample Response: PinDistSaleResponse> <Version>01</Version> InvoiceNo>1234567</InvoiceNo> <ResponseCode>00</ResponseCode) IN>5518556939</PIN> ControlNo>22851832</ControlNo> KCarrierControlNo>20227</CarrierControlNo <CustomerServiceNo></CustomerServiceNo> <TransactionDateTime>06/08/2005 :48:13:513</TransactionDateTimex <ResultCode>0</ResultCode> (ResponseMessage> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 81 of 341 $20.00 ProductXYZ Topup&#x0a; Your current balance is $243.43 MXP </ResponseMessage TransactionId>167434354</TransactionId) </PinDistSaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 82 of 341 36. PINDistSale for Registration Fee Products There are specific products with regulatory fees that needs to be considered during the sale. This fees can be extracted by using the method GetProductFee with parameters 01,productID,x amount. For example you want to make a recharge for 100$ but the amount you would enter would be 20 + fee. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. AccountID String Y AccountID provides the account number to recharge. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. And for this case is Recharge Amount + Fee. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistSale> (Version>01</Version> <SiteId>00000</SiteId> <ClerkId>1111</ClerkId <ProductId>8915119</ProductId> <AccountId12345678</ AccountId > <Amount>20</Amount> InvoiceNo>1234567</InvoiceNo> (LanguageOption>01</LanguageOption> </PinDistSale> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 83 of 341 Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: <PinDistSaleResponse> <Version>01 </Version> InvoiceNo>1234567</InvoiceNo> <ResponseCode>00</ResponseCode> PIN>5518556939</PIN> (ControlNo>22851832</CarrierControlNo> <CustomerServiceNo></CustomerServiceNe <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTime (ResultCode>0</Resultcode> (ResponseMessage> Product: Mobile Top Up Amount: 19.00 Account #: 12345678 Trans ID:123 Fee:1.00 /ResponseMessage> <TransactionId>123</TransactionId> (/PinDistsaleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 84 of 341 37. LookUpTransactionBylnvoiceNo This method is intended for checking for ongoing transactions when the original response is delayed, then the client application can use it to recover the original transaction information as it was returned by the PinDistSale method. Request Parameters Parameter Tag Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits. ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. InvoiceNo String Y Between 1 to 9 digits. Sample request: <LookUpTransactionByInvoiceRequest) <Version>01</Version> <TerminalId>00</TerminalId> <ClerkId>3425</ClerkId> InvoiceNo>23282638576</InvoiceNo> </LookUpTransactionByInvoiceRequest> Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Pin String PIN retrieved from inventory ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTim String Debisys transaction date & time ResultCode String Refer to Section 2 for a list of result codes This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 85 of 341 ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product Transactionld String Debisys transaction reference number Sample Response: <LookUpTransactionByInvoiceNoResponsex <PinDistsaleResponse> <Version>01</Version> InvoiceNo>1234567</InvoiceNo> <ResponseCode00</ResponseCode IN>5518556939</PIN> <ControlNo>22851832</ControlNo> <CarrierControlNo>20227</CarrierControlNo> <CustomerServiceNo></CustomerServiceNo> <TransactionDateTime>06/08/2005 10:48:13:513</TransactionDateTime <ResultCode>0</Resultcode> <ResponseMessage> $20.00 ProductXYZ Topup&#x0a; Your current balance is $243.43 MXP </ResponseMessage> TransactionId>167434354</TransactionId> /PinDistSaleResponse> /LookUpTransactionByInvoiceNoResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 86 of 341 38. ApplyPayment The service ApplyPayment allows payments between Rep and Merchant (or otherwise) of the same chain. For authentication and security purposes you must create a user Rep, who has enabled the permission: "Enable Mobile Authentication". That user and permission must be sent in the UserName and Password fields respectively. Request Parameters Parameter Tag Type Required Notes Version String Y Version indicator. 2 characters. Currently is 01. MerchantID String Y Merchant identifier which is going to receive the payment. MerchantID can be either the merchant Id or it could be merchant phone number beginning with letter P so it would be something like P8761234567. Amount String Y Indicates the value of the payment to be made. This amount will be interpreted in local currency. It can be positive or negative. If it is positive the merchant credit will be increase and if negative the merchant credit will be decrease. Description String N Payment description. RefNumber String N Payment reference number. UserName String Y Username associated with Rep running the transaction. Password String Y Password associated with the user name of the Rep running the transaction. Sample request: < ApplyPaymentRequest> Version>01</Version> <MerchantID>12345</MerchantID> <Amount>10</Amount> <Description>Payment from Bank XYZ</Description> <RefNumber>9546</ RefNumber> (UserName>Test</UserName> (Password>1234</Password> </ApplyPaymentRequest> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 87 of 341 Response Parameters Parameter Tag Type Notes Version String Version indicator. 2 characters. Currently is 01. ResponseCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user. NewBalance String New Merchant balance Sample Response: <ApplyPaymentResponse> Version>01</Version> <ResponseCode>00</ResponseCode> <ResponseMessage>Sucessful</ResponseMessage) <NewBalance>20</NewBalance </ApplyPaymentResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 88 of 341 39. ApplyPaymentISOLevel The service ApplyPaymentISOLeve allows issue of payments to Prepaid Prepaid Merchants under an ISO. For authentication and security purposes, the ISO user used as part of the request must have the permission: "Update Credit Limit" enabled. Request Parameters Parameter Tag Type Required Notes Version String Y Version indicator. 2 characters. Currently is 01. MerchantID String Y Merchant identifier which is going to receive the payment Amount String Y Indicates the value of the payment to be made. This amount will be interpreted in local currency. It can be positive or negative. If it is positive the merchant credit will be increase and if negative the merchant credit will be decrease Description String N Payment description (i.e. Payment received from Bank Account XYZ) RefNumber String N Payment reference number (i.e ABC12345). This reference number helps to identify the payment. UserName String Y Username associated with ISO sending the transaction request. Password String Y Password associated with the user name of the ISO sending the transaction request. Sample request: < ApplyPaymentISOLevelRequest> Version>01</Version> MerchantID>12345</MerchantID> <Amount>10</Amount> <Description>Payment received from Bank XYZ</Description> <RefNumber>9546</ RefNumber> <UserName>Test</UserName> <Password>1234</Password> (/ApplyPaymentISOLevelRequest> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 89 of 341 Response Parameters Parameter Tag Type Notes Version String Version indicator. 2 characters. Currently is 01. ResponseCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user. NewBalance String New Merchant balance Sample Response: <ApplyPaymentISOLevelResponse> <Version>01</Version> (ResponseCode>00</ResponseCode> (ResponseMessage>Sucessful</ResponseMessage <NewBalancex20</NewBalance> /ApplyPaymentISOLevelResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 90 of 341 40. ApplyPaymentAgentLevel The service ApplyPaymentAgentLevel allows issue of payments to Prepaid Prepaid Merchants under an Agent. For authentication and security purposes, the Agent user used as part of the request must have the permission: "Update Credit Limit" enabled. Request Parameters Parameter Tag Type Required Notes Version String Y Version indicator. 2 characters. Currently is 01. MerchantID String Y Merchant identifier which is going to receive the payment Amount String Y Indicates the value of the payment to be made. This amount will be interpreted in local currency. It can be positive or negative. If it is positive the merchant credit will be increase and if negative the merchant credit will be decrease Description String N Payment description (i.e. Payment received from Bank Account XYZ) RefNumber String N Payment reference number (i.e ABC12345). This reference number helps to identify the payment. UserName String Y Username associated with Agent sending the transaction request. Password String Y Password associated with the user name of the Agent sending the transaction request. Sample request: < ApplyPaymentAgentLevelRequest> (Version>01</Version> <MerchantID>23456</MerchantID> <Amount>5</Amount> <Description>Payment received from Bank XYZ</Description> <RefNumber>7446</ RefNumber> <UserName>Test</UserName> <Password>1234</Password> /ApplyPaymentAgentLevelRequest> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 91 of 341 Response Parameters Parameter Tag Type Notes Version String Version indicator. 2 characters. Currently is 01. ResponseCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user. NewBalance String New Merchant balance Sample Response: <ApplyPaymentAgentLevelResponse> <Version>01</Version> esponseCode>0o</ResponseCode> (ResponseMessage>Sucess</ResponseMessage> (NewBalance>50</NewBalance) </ApplyPaymentAgentLevelResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 92 of 341 41. GetMerchantBalance The service GetMerchantBalance allows to check the balance of a merchant associated with the Rep of the User sent on the parameters. For authentication you must create a user type Rep, who has enabled the permission: "Enable Mobile Authentication". That user and permission must be sent in the UserName and Password fields respectively. Request Parameters Parameter Tag Type Required Notes Version String Y Version indicator. 2 characters. Currently is 01. MerchantID String Y Merchant Identifier to which you want to check the balance. UserName String Y Password associated with Rep running the transaction. Password String Y Password associated with the user name of the Rep running the transaction. Sample request: < etMerchantBalanceRequest> Version>01</Version> < MerchantID>12345</MerchantID> UserName>Test</SourceEntityID> <Password>1234</SourceEntityID> </GetMerchantBalanceRequest> Response Parameters Parameter Tag Type Notes Version String Version indicator. 2 characters. Currently is 01. ResponseCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user. Balance String Merchant balance. Sample Response: <GetMerchantBalanceResponse> (ersion>01</Version> <ResponseCode>00</ResponseCode> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 93 of 341 <ResponseMessage>sucessful</ResponseMessage> <Balance>20</Balance> </GetMerchantBalanceResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 94 of 341 42. DoSimActivationCDMA: The service DoSimActivationCDMA1 allows the activation of a Phone CDMA for an specific carrier and plan, based on the product code provided. Request Parameters Parameter Tag Type Required Notes version String Y Version indicator. terminalld String Y Between 5 and 9 digits. The terminalld is the identifier for the merchant terminal in the Emida system clerkld String Y Between 1 and 9 digits. The clerkld identifies a clerk that is authorized to sell products via the associated terminal. producldSim String Y The SKU or Product Id associated with the SIM Activation in the Emida system amountSim String Y Amount associated to the SIM Activation SKU or Product in the Emida system productldPin String Y The SKU or Product Id of the PIN that will be automatically pulled during the activation process from the Emida system amountPin String Y Amount associate to the PIN used for the SIM Activation esn String Y ESN of Phone to be activated zipCode String Y Zip code associated to the Phone to be activated netWorkType String Y Network type associated to the plan/phone to be activated invoiceNo String Y Unique ID provided by the caller of the Web Service to identify the request language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 95 of 341 Sample request: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" mlns:xsd="http://www.w3.org/2001/XMLSchema" kmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:DoSimActivationCDMA1 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">1111111</terminalld> <clerkld ksi:type="xsd:string">1234</clerkld> <producldSim xsi:type="xsd:string">8912800</producldSim> <amountSim (si:type="xsd:string">0</amountSim> <productldPin ksi:type="xsd:string">8000000</productldPin> <amountPin xsi:type="xsd:string">5</amountPin> <esn type="xsd:string">88769869876987</esn> <zipCode xsi:type="xsd:string">92610</zipCode> <netWorkTypexsi:type="xsd:string">22</netWorkType> <invoiceNo xsi:type="xsd:string">20</invoiceNo> <language xsi:type="xsd:string">1</language> </urn:DoSimActivationCDMA1> </soapenv:Body> </soapenv:Envelope> Response An XML with empty values. Since this is an asynchronous call, the actual transaction response must be queried calling the service LookUpSimActivationBylnvocieNo1 described in section 43. Sample Response: [OAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> :SOAP-ENV:Body> ins1:DoSimActivationCDMA1Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- = services"> <return si:type="xsd:string"><![CDATA[<DoSimActivationCDMA1><Version></Version><lnvoiceNo></Invoice No><ResponseCode></ResponseCode><Reference></Reference><TotalAmount></TotalAmount><Tr ansactionDateTimex</TransactionDateTimex<Transactionld></Transactionld><AuthNo></AuthNo><pr oviderTimeout>5</providerTimeout></DoSimActivationCDMA1>]]></return> </ns1:DoSimActivationCDMA1Response> </SOAP-ENV:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 96 of 341 /SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 97 of 341 43. DoSimActivationGSM1 The service DoSimActivationGSM1 allows the activation of a Phone GSM and SIM card for an specific carrier and plan, based on the product code provided. Request Parameters Parameter Tag Type Required Notes version String Y Version indicator. terminalld String Y Between 5 and 9 digits. The terminalld is the identifier for the merchant terminal in the Emida system clerkld String Y Between 1 and 9 digits. The clerkld identifies a clerk that is authorized to sell products via the associated terminal. producldSim String Y The SKU or Product Id associated with the SIM Activation in the Emida system amountSim String Y Amount associated to the SIM Activation SKU or Product in the Emida system productldPin String Y The SKU or Product Id of the PIN that will be automatically pulled during the activation process from the Emida system amountPin String Y Amount associate to the PIN used for the SIM Activation ESN String Y ESN of Phone to be activated SIM String Y SIM card of the Phone to be activated zipCode String Y Zip code associated to the Phone to be activated netWorkType String Y Network type associated to the plan/phone to be activated invoiceNo String Y Unique ID provided by the caller of the Web Service to identify the request language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 98 of 341 Sample request: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" mlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:DoSimActivationGSM1 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">1111111</terminalld> <clerkld ksi:type="xsd:string">1234</clerkld> <producldSim xsi:type="xsd:string">8912800</producldSim> <amountSim i:type="xsd:string">0</amountSim> <productldPin ksi:type="xsd:string">8000000</productldPin> <amountPin xsi:type="xsd:string">5</amountPin> <esn xsi:type="xsd:string">9876986598</esn> <sim li:type="xsd:string">8769859857658765</sim> <zipCode ksi:type="xsd:string">111</zipCode> <netWorkType xsi:type="xsd:string">22</netWorkType: xsi:type="xsd:string">20</invoiceNo> <language xsi:type="xsd:string">1</language> <//urn:DoSimActivationGSM1> </soapenv:Body> </soapenv:Envelope> Response An XML with empty values. Since this is an asynchronous call, the actual transaction response must be queried calling the service LookUpSimActivationBylnvocieNo1 described in the next section. Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> SOAP-ENV:Body> <ns1:DoSimActivationGSM1Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[<DoSimActivationGSM1><Version></Version><InvoiceNo></InvoiceN o><ResponseCode></ResponseCode><Reference></Reference><TotalAmount></TotalAmount><Tra actionDateTime></TransactionDateTimex<Transactionld></Transactionld><AuthNo></AuthNo><pro iderTimeout>5</providerTimeout></DoSimActivationGSM1>]]></return> </ns1:DoSimActivationGSM1Response> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 99 of 341 </SOAP-ENV:Body> /SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 100 of 341 44. LookUpSimActivationBylnvoiceNo1 The service LookUpSimActivationBylnvoiceNo returns the full response of a previous async call from DoSimActivationCDMA1 or DoSimActivationGSM1. The response contains the full receipt and information related to the transaction response. Request Parameters Parameter Tag Type Required Notes version String Y Version indicator. terminalld String Y Between 5 and 9 digits. The terminalld is the identifier for the merchant terminal in the Emida system clerkld String Y Between 1 and 9 digits. The clerkld identifies a clerk that is authorized to sell products via the associated terminal. invoiceNo String Y Unique ID provided by the caller of the Web Service to identify the request Sample request: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:LookUpSimActivationBylnvoiceNo1 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">111111</terminalld> <clerkld ype="xsd:string">1234</clerkld> <invoiceNo xsi:type="xsd:string">21</invoiceNo> </urn:LookUpSimActivationBylnvoiceNo1> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 101 of 341 Response An XML with the data concerning to the CDMA or GSM Phone Activation. Sample Response for GSM: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> ins1:LookUpSimActivationBylnvoiceNo1Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services": <return si:type="xsd:string"><![CDATA[<PinDistSaleResponse><Version>01</Version><InvoiceNo>21</Invoi eNo><ResponseCode>00</ResponseCode><PIN>{"PIN":"987698798","ESN": "989817987987","SIM": '9087098709870987097","ZIPCODE": "92610"}</PIN><ControlNo>140784219</ControlNo><CarrierControlNo>595167 </CarrierControlNo>< CustomerServiceNo></CustomerServiceNo><TransactionDateTime>2015-04-30 16:00:18.0</TransactionDateTime><ResultCode>00</ResultCode><ResponseMessage>&lt;table&gt;& It;tr&gt;&lt;td align="left"&gt;&lt;p align=center&gt;&lt;font lass="receipt_product_name"&gt;&lt;b&gt;SIM ACTIVATION Igles&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;/p&gt;&lt;p align="right"&gt;Merchant Name: 1 Stop Shop&lt;br/&gt;Location: 906 N.Harper St&lt;br/&gt;Phonel No: 8649840453&lt;br/&gt;MID No: 737603766012&lt;br/&gt;TID No: 4083900&lt;br/&gt;Trans: 218665278&lt;br/&gt;Serial: 239870&lt;br/&gt; Date & Time: 4/30/2015 2:00:17 PM&It;br/&gt;Term:&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr& gt;&lt;td align="left"&gt;&lt;table width="190px"&gt;&lt;tr&gt;&lt;td align="left' &gt;&It;font class="receipt_instructions"&gt;&lt;b&gt;SIM&It;/b&gt;&lt;/td&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;$0.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;PIN&It;/b&gt;&lt;/td&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;5.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;TOTAL&It;/b&gt;&lt;/td&gt;&lt;td align="left" &gt;&It;font lass="receipt_instructions"&gt;&lt;b&gt;5.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;&lt;/td&gt;&lt;/tr&g t;&lt;tr&gt;&lt;td&gt;&lt;p align="justify"&gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;Success!&lt;br/&gt;Simple Mobile wills send you a text shortly on the device you have registered with your new phone number!&lt;br/&gt;&lt;br/&gt;&lt;b&gt;&lt;/font&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&lt;p align="left"&gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;Trxld: 218665278&lt;/b&gt;&lt;br/&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</ResponseMessage><Transa ctionld>218665278</Transactionld></PinDistSaleResponse>]]></return> /ns1:LookUpSimActivationBylnvoiceNo1Response> /SOAP-ENV:Body> </SOAP-ENV:Envelope> Sample Response for CDMA: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 102 of 341 <SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:LookUpSimActivationBylnvocieNo1Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services": <return si:type="xsd:string"><![CDATA[<PinDistSaleResponse><Version>01</Version><InvoiceNo>20</Invoi ceNo><ResponseCode>00</ResponseCode><PIN>{"PIN":"897698769", "ESN": '76987698769","ZIPCODE": 92610"}</PIN><ControlNo>140784220</ControlNo><CarrierControlNo>476207</CarrierControlNo>< CustomerServiceNo></CustomerServiceNo><TransactionDateTime>2015-04-30 15:58:42.0</TransactionDateTime><ResultCode>00</ResultCode><ResponseMessage>&lt;table&gt;& It;tr&gt;&lt;td align="left"&gt;&lt;p align=center&gt;&lt;font class="receipt_product_name"&gt;&lt;b&gt;SIM ACTIVATION Ingles&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;/p&gt;&lt;p align="right"&gt;Merchant Name: 1 Stop Shop&lt;br/&gt;Location:906 N. Harper St&lt;br/&gt;Phone No: 8649840453&lt;br/&gt;MID No: 737603766012&It;br/&gt;TID No: 4083900&lt;br/&gt;Trans: 218665274&It;br/&gt;Serial: 282873&lt;br/&gt; Date & Time: 4/30/2015 1:58:41 PM&It;br/&gt;Term:&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;br/&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr8 gt;&lt;td align="left"&gt;&lt;table width="190px"&gt;&lt;tr&gt;&lt;td align="left' &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;SIM&It;/b&gt;&lt;/td&gt;&lt;td align="left"&gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;$0.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;PIN&It;/b&gt;&lt;/td&gt;&lt;td align="left" &gt;&It;font class="receipt_instructions"&gt;&lt;b&gt;5.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;TOTAL&It;/b&gt;&lt;/td&gt;&lt;td align="left" &gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;5.00&It;/b&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;&lt;/td&gt;&lt;/tr&g t;&lt;tr&gt;&lt;td&gt;&lt;p align="justify"&gt;&lt;fon class="receipt_instructions"&gt;&lt;b&gt;Success!&lt;br/&gt;Simple Mobile will send you a text shortly on the device you have registered with your new phone number!&lt;br/&gt;&lt;br/&gt;&lt;b&gt;&lt;/font&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;tr&gt;&lt;td&gt;&lt;p "left"&gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;Trxle 218665274&lt;/b&gt;&lt;br/&gt;&lt;/p&gt;&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;</ResponseMessage><Transa ctionld>218665274</Transactionld></PinDistSaleResponse>]]></return> </ns1:LookUpSimActivationByInvocieNo1Response> </SOAP-ENV:Body> </SOAP-ENV:Envelope> The CDATA contains and standard structure called PinDistSaleResponse with the following definition: Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 103 of 341 Parameter Tag Type Notes ResponseCode String 2-character field to indicate success or failure PIN String Contains an array of fields associated to the SIM/Phone Activation (PIN, ESN, SIM, ZIP CODE) ControlNo String Emida system internal control number CarrierControlNo String Carrier's authorization code/transaction number CustomerServiceNo String Support toll-free number TransactionDateTim String Emida transaction date & time ResultCode String Refer to Section 2 for a list of result codes ResponseMessage String Text to be displayed to the end user associated with the Activation. Transactionld String Emida's transaction reference number This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 104 of 341 45. GetPinProductsForActivation The GetPinProductsForActivatior service provides a list of Pin products associated to a activation Product id configured for a specific terminal id. Request Parameters Parameter Tag Type Required Notes version String Y 01 Terminalld String Y Between 5 and 9 digits. The terminalld is the identifier for the merchant terminal in the Emida system. Clerkld String Y Between 1 and 9 digits. The clerkld identifies a clerk that is authorized to sell products via the associated terminal. activationProducld String Y SKU or Product Id associated with the activation in the Emida system. invoiceNo String Y Unique ID provided by the caller of the Web Service to identify the request. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Unique ID provided by the caller of the Web Service to identify the request. PinProductld String Unique id for the pin product associated to Activation Product. PinProductDescription String Description of the pin product associated to Activation Product. Response parameters are returned as an XML string. A sample response is: Sample request: (GetPinProductsForActivationRequest> <version>01</version> terminalId>98735</terminalId> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 105 of 341 <clerkId >123</clerkId> <activationproducId>876565</producId> invoiceNo>12434</invoiceNo> <languageOption>1</languageOption> GetPinProductsForActivationRequest> Sample Response < GetPinProductsForActivationResponse > <Version>01</Version> InvoiceNo>12434</InvoiceNo> <Product> <PinProductId>5035200</ProductId> <PinProductDescription>PagePlus $80</ProductId> </Product> <Product> <ProductId>5035200</ProductId> <PinProductDescription>Page Plus $40</ProductId> /Product> </ etPinProductsForActivationResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 106 of 341 40. PinDistSale with Subscriber's PIN This method allows a mobile subscriber to add funds to their account with its mandatory subscribers PIN. The PIN is used to validate the subscriber against Telecom providers. The PinDistSaleSubscriberPIN service can support this product with the addition of an AccountID and subscriberPIN parameter. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. AccountID String Y Between 10 and 16 digits. AccountID provides the account number to which the payment is applied. SubscriberPIN String Y 4 digits alpha-numeric, case-sensitive field. SubscriberPIN is a value used to verify the subscriber against providers when performing RTR transactions Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Request parameters are sent as an XML string. A sample request is: <PinDistSaleSubscriberPIN> <Version>01</Version) SiteId>00000</SiteId> <ClerkId>1111</ClerkId> <ProductId>8403000</ProductId> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 107 of 341 <AccountId>5518556939</AccountId > <SubscriberPIN>1524</SubscriberPIN> <Amount>20.00</Amount> <InvoiceNo>1234567</InvoiceNo> (LanguageOption>01</LanguageOption> </PinDistSaleSubscriberPIN> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 108 of 341 Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String PIN's Debisys internal control number CarrierControlNo String PIN serial number from provider CustomerServiceNo String PIN support toll-free number TransactionDateTime String Debisys transaction date & time ResponseMessage String Text to be displayed to the end user that typically contains the account balance, if available. Transactionld String Debisys transaction reference number Response parameters are returned as an XML string. A sample response is: inDistSaleSubscriberPINResponse> <Version>01 </Version> <InvoiceNo>1234567</InvoiceNo> <ResponseCode>00</ResponseCode> <PIN>5518556939</PIN> KControlNo>22851832</CarrierControlNo> CustomerServiceNo></CustomerServ (TransactionDateTime06/08/2005 0:48:13:513</TransactionDateTime> ResultCode>0</Resultcode> (ResponseMessage> $20.00 ProductXYZ Topup&#x0a; Your current balance is $243.43 MXP </ResponseMessage> <TransactionId>16725644</TransactionId </PinDistsaleSubscriberPINResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 109 of 341 Quippi Gift Cards related methods The following section describes all the methods avaible to manage the creation and redemption of Gift Cards for the Quippi system. Methods associated to the creation, cancellation and status check can only performed in the US System, while redemption method will be only available in the destination country Web Service instance. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 110 of 341 46. QuippiCreatePIN The "QuippiCreatePIN" service allows the US distributor to create a PIN-on-demand order, which activates a PIN in the Quippi system and makes it available to redeem by passing it back to the US Distributor. At that point, the US distributor prints a receipt for the customer with the PIN and order details. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a Gift Card Product in the Emida system. Amount String Y Indicates the denomination of the Gift Card. This amount must match with the denomination defined for the ProductD. SenderMobile String Y Mobile Phone number of sender, must be string of 10digits. SenderFirstName String Y Sender's first name SenderLastName String Y Sender's last name RecipientFirstName String Y Recipient's first name RecipientLastName String Y Recipient's last name ExternalFx String O The exchange rate from the US distributor, if it differs from Quippi's. If it is not included, Quippi's exchange rate will be used. (sample value: 12.34) InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction ID. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 111 of 341 Parameter Tag Type Required Notes LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample Request <QuippiCreatePIN> <Version>01</Version> TODO /QuippiCreatePIN> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. FxRate String Original Exchange Rate applied to the transaction TargetAmount String Amount in the destination country Currency String Currency ISO 4217 code in the destination country (i.e. MXN) SendingAmount String Original amount in USD PIN String Giftcard PIN number PAN String Giftcard PAN number RedeemerName String The name of the retailer in Mexico where the Giftcard can be redeemed. SenderFirstName String Giftcard purchaser first name This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 112 of 341 SenderLastName String Giftcard purchaser last name RecipientFirstName String Giftcard recipient first name RecipientLastName String Giftcard recipient last name SenderMobile String Sender's mobile phone number QuippiOrderld String Quippi's order id or transaction Id generated from Quippi's system. TransactionID String Emida's system Transaction ID Response parameters are returned as an XML string. A sample response is: <QuippiCreatePINResponse> <Version>01</Version> TODO /QuippiCreatePINResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 113 of 341 47. QuippiCanceIPIN The "QuippiCancel" service allows the US distributor to cancel an order if the customer requests a refund or ends up not wanting the order after it was placed, and the PIN has not already been redeemed. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a Gift Card Product in the Emida system. Amount String Y Indicates the denomination of the Gift Card. This amount must match with the denomination defined for the ProductD. PIN String Y The PIN requested to be Cancelled PAN String Y The PAN number associated with the PIN being canceled TransactionID String Y Original TransactionID from the PIN Creation InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction ID. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample Request <QuippiCancelPIN> <Version>01</Version> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 114 of 341 TODO /QuippiCancelPIN> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. FxRate String Original Exchange Rate applied to the transaction TargetAmount String Amount in the destination country Currency String Currency ISO 4217 code in the destination country (i.e. MXN) SendingAmount String Original amount in USD PIN String Giftcard PIN number PAN String Giftcard PAN number RedeemerName String The name of the retailer in Mexico where the Giftcard can be redeemed. SenderFirstName String Giftcard purchaser first name SenderLastName String Giftcard purchaser last name RecipientFirstName String Giftcard recipient first name RecipientLastName String Giftcard recipient last name SenderMobile String Sender's mobile phone number QuippiOrderld String Quippi's order id or transaction Id generated from Quippi's system. TransactionID String Emida's system Transaction ID This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 115 of 341 Response parameters are returned as an XML string. A sample response is: QuippicancelPINResponse> <Version>01</Version> TODO (/QuippiCancelPINResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 116 of 341 48. LookupQuippiTransactionByInvoiceNo The 'LookupQuippiTransactionBylnvoiceNo" service allows the US distributor to query a request for PIN Creation or PIN Cancelation using InvoiceNo in case there was a timeout and not response was received. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SiteID String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a Gift Card Product in the Emida system. Amount String Y Indicates the denomination of the Gift Card. This amount must match with the denomination defined for the ProductD. OriginalInvoiceNo String Y InvoiceNo value used when the original request was sent. Sample Request <LookupQuippiTransactionByInvoiceNo <Version>01</Version> TODO </LookupQuippiTransactionByInvoiceNo> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 117 of 341 ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. FxRate String Original Exchange Rate applied to the transaction TargetAmount String Amount in the destination country Currency String Currency ISO 4217 code in the destination country (i.e. MXN) SendingAmount String Original amount in USD PIN String Giftcard PIN number PAN String Giftcard PAN number RedeemerName String The name of the retailer in Mexico where the Giftcard can be redeemed. SenderFirstName String Giftcard purchaser first name SenderLastName String Giftcard purchaser last name RecipientFirstName String Giftcard recipient first name RecipientLastName String Giftcard recipient last name SenderMobile String Sender's mobile phone number QuippiOrderld String Quippi's order id or transaction Id generated from Quippi's system. TransactionID String Emida's system Transaction ID Response parameters are returned as an XML string. A sample response is: LookupQuippiTransactionByInvoiceNoResponse> <Version>01</Version> TODO </LookupQuippiTransactionByInvoiceNoResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 118 of 341 49. GetQuippiFxRate The "GetQuippiFxRate" service allows the US distributor to query the current exchange rate available in the Quippi system. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a Gift Card Product in the Emida system. Amount String Y Indicates the denomination of the Gift Card in USD. This amount must match with the denomination defined for the ProductID. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction ID. Sample Request <GetQuippiFxRate> <Version>01</Version> TODO (/GetQuippiFxRate> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 119 of 341 ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. FxRate String Current Exchange Rate TargetAmount String Amount in the destination country SendingAmount String Original amount in USD TransactionID String Emida's system Transaction ID Response parameters are returned as an XML string. A sample response is: GetQuippiFxRateResponse> <Version>01</Version> TODO </GetQuippiFxRateResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 120 of 341 50. QuippiAuthorize The "QuippiAuthorize" service allows partners to validate that the given PIN is ready to be redeemed and returns the associated PIN amount. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. PIN String Y The PIN associated with the Giftcard to be authorized. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. Sample Request <QuippiAuthorize> <Version>01</Version> TODO /QuippiAuthorize> Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 121 of 341 PIN String The Giftcard PIN number. PAN String The Gifstcard PAN number. Amount String Amount in local currency associated to the Giftcard. Currency String Currency ISO 4217 code in the destination country (i.e. MXN) RecipientFirstName String Giftcard recipient first name RecipientLastName String Giftcard recipient last name TransactionID String Emida's system Transaction ID Response parameters are returned as an XML string. A sample response is: QuippiAuthorizeResponse> <Version>01</Version> TODO </QuippiAuthorizeResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 122 of 341 51. QuippiRedeem The "QuippiRedeem" service allows partners to redeem the PIN, after which the PIN will not be redeemable any longer. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. PIN String Y The PIN associated with the Giftcard to be authorized. LocationID String Y Partner Store ID assigned by Quippi PosID String O The ID of the Point of Sale processing the transaction. PosOperatorID String The ID of the Operator/Store processing the transaction. RecipientID String The legal ID number of the person redeeming the Giftcard. InvoiceNo String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. Sample Request <QuippiRedeem> <Version>01</Version> TODO </QuippiRedeem> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 123 of 341 Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. PIN String The Giftcard PIN number. PAN String The Gifstcard PAN number. Amount String Amount in local currency associated to the Giftcard. Currency String Currency ISO 4217 code in the destination country (i.e. MXN) RecipientFirstName String Giftcard recipient first name RecipientLastName String Giftcard recipient last name QuippiOrderld String Transaction Id generated from Quippi's system. TransactionID String Emida's system Transaction ID Response parameters are returned as an XML string. A sample response is: (QuippiRedeemResponse> <Version>01</Version> TODO (/QuippiRedeemResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 124 of 341 Lyca related methods The following section describes additional methods available to manage Port In for Lyca system. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 125 of 341 52. LycaPortinPin The service LycaPortingPIN allows the port in of a current SIM (phone number) using a Pin for funding. Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. sim String Y msisdn String Y accountNumber String Y password String Y zipCode String Y languageOption String N Future implementation contactEmail String Y plan Y amount String Y invoice String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample request <LycaPortinPin> <version>1</versioni This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 126 of 341 <terminalid>test</terminalId> <clerkId>123</clerkId> <productId>353532</productId> <sim>5436534634</sim> (msisdn>34634634</msisdn> <accountNumber>464364</accountNumber <password>654d</password> <zipCode>92610</zipCode> <languageOption>ESP</languageOption> <contactEmail>jhondeoltest.com</contactEmail> <plan>34353</plan> <amount>34</amount> <invoice>5</invoice> (language>1</language> </LycaPortinPin> Type Notes Response Parameters Parameter Tag ResponseCode String 2-character field to indicate success or failure. ResponseMessage String Emida's message with success or fail process. MIN String Mobile identification number PORTINREFERENCE String Reference number NUMBER Simple Response <LycaPortinPin> <ResponseCode>%s</ResponseCode> <ResponseMessage>%s</ResponseMessage> <MIN>%s</MIN> PORTINREFERENCENUMBER>%S</PORTINREFERENCENUMBER (/LycaPortinPin> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 127 of 341 53. LycaPortinRTR The service LycaPortingRTR allows the port in of a current SIM (phone number) using a RTR for funding Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. sim String Y msisdn String Y accountNumber String Y password String Y zipCode String Y languageOption String N Future implementation contactEmail String Y amount String Y invoice String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample request This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 128 of 341 <LycaPortinRTR> <version>1</version> <terminalid>test</terminalId> (clerkId>123</clerkId> <productId>353532</productId> im>5436534634</sim> <msisdn>34634634</msisdn> <accountNumber>464364</accountNumber> password>654d</password> (ipCode92610</zipCode> languageOption>ESP</languageOption> contactEmail>jhondeoltest.com</contactEmail> <amount>34</amount> <invoice>5</invoice> <language>1</language> </LycaPortinRTR> Type Notes Response Parameters Parameter Tag ResponseCode String 2-character field to indicate success or failure. ResponseMessage String Emida's message with success or fail process. MIN String Mobile identification number PORTINREFERENCENU String Reference number MBER Simple Response <LycaPortinRTRResponse> <ResponseCode>1</ResponseCode> <ResponseMessage>Success</ResponseMessage> <MIN>%s</MIN> <PORTINREFERENCENUMBER>%S</PORTINREFERENCENUMBERI </LycaPortinRTRResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 129 of 341 54. LycaPortInDetails The "LycaPortInDetails" service allows that the user to enter in the reference type (reference number from the provider which should be listed on the receipt, the sim number used for entry or the port in phone number). Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. siteld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld String Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish referenceType String Y Option to choose the port in type. PMSISDN = Port In SIM Number ICC_ID = Port In Phone Number REF CODE = Reference Number referenceNumber String Y Reference Number for Port In process. (In the case of a phone number, please do not enter spaces or dashes.) Sample Request: <LycaPortInDetails> <version >1</version> <siteId>2865201</siteld> kclerkID">1234</clerkID> <productId>500000055</productId> Kamount>1</amount> <languageOption>1</languageOption> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 130 of 341 referenceType>REFCODE</referenceType> eferenceNumber>123456789</referenceNumber> (/LycaPortInDetails> Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure. TransactionDateTime String Emida transaction date and time. ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product. Transactionld String Emida's transaction reference number. ReferenceCode String Lyca Reference code ReturnDescription String Lyca return description. PortInDate String Lyca portIn date ReqSubDate String Portln ReqSubDate RejectReason String Lyca reject reason StreetNumber String User portIn street number StreetName String User portIn Street name StreetDirec String User portIn Street Direc Name String User portIn Name City String User portIn City State String User portIn state ZipCode String User portIn Zipcode Account String User portIn account Password String User portIn password Sample Response: <PortInDetailsResponse> <Version>1</Version> <ResponseCode>00</ResponseCode> (TransactionDateTime>02/11/2016 11:19:10:3</TransactionDateTimex <ResponseMessage/> TransactionId>218669540</TransactionId> ReferenceCode>1</ReferenceCode> (ReturnDescription>2345678976</ReturnDescription> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 131 of 341 <PortinDate>01/02/2016</PortinDate> <ReqSubDate>01/02/2016</ReqSubDate> <RejectReason/> <StreetNumber>Calle 45</StreetNumber> <StreetName>Av Chile</StreetName> <StreetDirec>4556</StreetDirec> <Name>Boston</Name> <City>Los angeles</City> <State>LA</State> ZipCode>961258</ZipCode> Account>55345345553</Account> <Password>5555555</Password> </PortInDetailsResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 132 of 341 55. LycaCheckPortInEligibility This option allow that the system check to see if the existing service is port-able. Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. siteld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld String Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish portinPhoneNumber String Y Phone number to check for eligibility. No spaces or dashes. portinSIMNumber String Y SIM Number (it is optional) Sample request <LycaCheckPortInEligibility> <version>1</version> <siteId2865201</siteld> <clerkID>1234</clerkID> (productId>500000056</productId anguageOption>1</languageOption> <portinPhoneNumber>1234567890</portinPhoneNumber> portinsIMNumber>1234</portinsIMNumber> </LycaCheckPortInEligibility> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 133 of 341 Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure. TransactionDateTime String Emida transaction date and time. ResponseMessage String Text to be displayed to the end user that typically contains instruction on how to use the requested product. Transactionld String Emida's transaction reference number. LycaErrorCode String Lyca Error Code. 0 - 18 19 LycaErrorDescription String Lyca Error Description. - 0 = This phone number is eligible for port in service. - 18 = The port in number you have submitted is invalid - 19 = This phone number is not eligible for port in service. Simple Response CheckPortInEligibilityResponse> <Version>1</Version> <ResponseCode>00</ResponseCode <TransactionDateTime>02/11/2016 11:30:00:323</TransactionDateTime (ResponseMessage/> <TransactionId>218669546</TransactionIdx <LycaErrorCode>18</LycaErrorCode> <LycaErrorDescription The port in number you have submitted is invalid </LycaErrorDescription> </CheckPortInEligibilityResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 134 of 341 56. CancelPortIn This services allows cancel port In. It works similar to a void top up function. The user need to enter in the reference number listed on the original receipt for the Lyca port in as well as the Port In Number originally submitted. Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. siteld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld String Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. amount String Y Original product amount value. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish referenceNumber String Y Lyca reference number shown on the initial port in request receipt portinNumber String Y Port In number (not to use any spaces or dashes). emidaTransactionld String Y Original Emida transaction id. Sample request <LycaCancelPortIn> <version>1</version> <siteId>4083900</siteId> iclerkID>1234</clerkID> <productId>500000057</productId> <amount>1</amount> <languageoption></languageoption> referenceNumber1234</referenceNumber> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 135 of 341 <portinNumber>1234555</portinNumber> emidaTransactionId>218668343</emidaTransactionId> </LycaCancelPortIn> Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 1. ResponseCode String 2-character field to indicate success or failure. TransactionDateTime String Emida transaction date and time. Transactionld String Emida's transaction reference number. CancelPortinMessage String Emida's message with success or fail process. Simple Response <CancelPortInResponse> <Version>1</Version> <ResponseCode>00</ResponseCode) (TransactionDateTime>02/11/2016 11:49:22:67</TransactionDateTime> <TransactionId>218669552</TransactionId> (CancelPortinMessage>Therequest was successful Emida Trx Id=[218669552] </CancelPortinMessage> </CancelPortInResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 136 of 341 57. ModifyPortIn This service allows modify portin's basic information through a request that is currently in process so the reference number is key. Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. siteld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld String Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish referenceNumber String Y Lyca reference number shown on the initial port in request receipt portInNumber String Y Port In number (not to use any spaces or dashes). portInSIMNumber String Y New Port In Sim number portInAccountNumber String Y Port In user account number portInPasswordPir String Y New port In user password pin portInZipCode String Y New port In Zip code. Sample request <LycaModifyPortIn> (version>1</version> <siteId>2865201</siteId> <clerkID>1234</clerkID> <productId>500000058</productId> <languageOption>1</languageOption> KreferenceNumber>12345</referenceNumber portInNumber>3434434</portInNumber> <portInSIMNumber>22222</portInSIMNumber> (portInAccountNumber>8888</portInAccountNumbe: <portInPasswordPin>89888</portInPasswordPin> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 137 of 341 portInzipCode>23</portInzipCode> </LycaModifyPortIn> Type Notes Response Parameters Parameter Tag Version String 2-character response version indicator. Currently 1. ResponseCode String 2-character field to indicate success or failure. TransactionDateTime String Emida transaction date and time. Transactionld String Emida's transaction reference number. ModifyPortInMessage String Emida's message with success or fail process. LycaErrorCode String Lyca error code LycaErrorDescription String Lyca Error or success message description. Simple Response <ModifyPortInResponse> <Version>1</Version> <ResponseCode>00</ResponseCode> (TransactionDateTime>02/11/201 11:49:22:67</TransactionDateTime> TransactionId>987654321</TransactionId> (ModifyPortInMessage>null</ModifyPortInMessage> (LycaErrorCode>o</LycaErrorCode> (LycaErrorDescription>Your request to modify the existing Port In request has been submitted successfully </LycaErrorDescription> </ModifyPortInResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 138 of 341 58. LycaActivationPin The service LycaActivationPin allows the activation of a Phone for an specific carrier and plan, based on the product code provided Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. sim String Y zipCode String Y languageOption String N Future implementation contactEmail String Y plan String Y Between 4 and 9 digits. amount String Y invoice String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample request <LycaActivationPin> <version>1</version> <terminalid>test</terminalId> clerkId>12356</clerkId> <productId>45578</productId <sim>436346346346</sim> <zipCode>92610</zipCode> <languageOption>2</languageOption> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 139 of 341 <contactEmail>jhondoeltest.com</contactEmail> plan>34534546</plan> <amount>12</amount> <invoice>2</invoice> <language>1</language> </LycaActivationPin> Type Notes Response Parameters Parameter Tag ResponseCode String 2-character field to indicate success or failure. ResponseMessage String Emida's message with success or fail process. MIN String Mobile identification number PORTINREFERENCENU String Reference number MBER Simple Response (LycaActivationPinResponse> <ResponseCode>1</ResponseCode> <ResponseMessage>Success</ResponseMessage> <MIN>%s</MIN> (PORTINREFERENCENUMBER>%S</PORTINREFERENCENUMBER> /LycaActivationPinResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 140 of 341 59. LycaActivationRTR The service LycaActivationRTR allows the activation of a Phone for an specific carrier, based on the product code provided Request Parameters Parameter Tag Type Required Notes version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteld is the identifier for the merchant terminal in the Debisys system clerkID String Y Between 1 and 9 digits. The clerkID identifies a clerk that is authorized to sell products via the associated terminal. productld Y Between 4 and 9 digits. productld is the identifier for a "port In Details" Product in the Emida system. sim String Y zipCode String Y languageOption String N Future implementation contactEmail String Y amount String Y invoice String Y Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. language String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample request <LycaActivationRTR> <version>1</version> <terminalid>test</terminalId> clerkId>12356</clerkId> <productId>45578</productId> <sim>436346346346</sim> <zipCode>92610</zipCode> <languageOption>2</languageOption> <contactEmail>jhondoeltest.com</contactEmail> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 141 of 341 <amount>12</amount> <invoice>2</invoice> <language>1</languagex /LycaActivationRTR> Type Notes Response Parameters Parameter Tag ResponseCode String 2-character field to indicate success or failure. ResponseMessage String Emida's message with success or fail process. MIN String Mobile identification number PORTINREFERENCENL String Reference number MBER Simple Response LycaActivationRTRResponse> <ResponseCode>1</ResponseCode> ResponseMessage>success</ResponseMessage) <MIN>%S</MIN> <PORTINREFERENCENUMBER>%S</PORTINREFERENCENUMBER </LycaActivationRTRResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 142 of 341 Locus Activation Related Methods In order to activate mobile phones through Locus 4 different calls are provided : LocusActivateCDMAesn LocusActivateCDMAsim LocusActivateGSMAfcode LocusActivateGSMsim Even when all calls are similar they share the use of two products, one for the activation request and one for the pin redeem request. Also they share the answer format: <ActivateGSMafcodeResponse> <Version>01</version> (ResponseCode>oo</Responsecode> (ResponseMessage>success</ResponseMessage> erial>02171699422933</serial> <min>1111111111</min> </ActivateGSMafcodeResponse> If for any reason the pin redeem was delayed on Locus side, the pin value will be also be included. Response fields: Field Notes Version The same value used on the request ResponseCode 00 Indicates a successful operation, any other value indicates an error. ResponseMessage String explaining the error reason. Serial This is the reference number assigned by Locus to the activation operation. Min This is the phone number assigned by Locus for the activated mobile phone. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 143 of 341 Pin When activating a CDMA phone a pin redeem will be handled together. If for any reason Locus delays the redeem response, the pin value will be included. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 144 of 341 60. LocusActivateCDMAesn This call allows to activate a CDMA phone using the corresponding ESN number. Request Fields: Field Type Required Notes siteld String Yes Terminal identifier for the Emida network. pinProductld String Yes Pin Product ID used to generate the pin redeem call. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Activation product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish invoiceNo String No linformational field Version String No Defaults to 01. Reserved for future use. ESN String Yes Mobile activation ESN NPA String Yes North American Numbering Plan code. City String No City where the activation is aplicable. zip String No Zip where the activation is aplicable. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 145 of 341 Sample Request : <soapenv:Envelope mlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns : xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys- soap-services"> <soapenv: Header/> <soapenv : Body> <urn:LocusActivateCDMAesn soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <siteId ssi:type="xsd:string">9236576</siteId> <pinProductId xsi:type="xsd:string">388015</pinProductId> <clerkId isi:type="xsd:string">1234</clerkId> <activationProductIdxsi:type="xsd:string">9000905</activationProductId> <languageId :type="xsd:string">1</languageId> <invoiceNo si:type="xsd:string">542354</invoiceNo> <version xsi:type="xsd:string">01</version> <esn xsi : be="xsd:string">100000004705134</esn> <npa xsi : ype="xsd:string">305</npa> <city :type="xsd:string">MIA</city> <zip xsi:type="xsd:string">33128</zip> rn:LocusActivateCDMAesn> :/soapenv:Body> <1 soapenv:Envelope> Sample Response: <SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:LocusActivateCDMAesnResponse SOAP- NV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ActivateCDMAesnResponse><Version>01</Version><Resp nseCode>00</ResponseCode><ResponseMessage>Success</ResponseMessage><serial>02171699 135672</serial><min>01</min><pin>4495431594</pin></ActivateCDMAesnResponse>]]></ urn> /ns1:LocusActivateCDMAesnResponse> </SOAP-ENV:Body> </ SOAP-ENV:Envelope) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 146 of 341 61. LocusActivateCDMAsim This call allows to activate a CDMA phone using the corresponding ESN and SIM numbers. Request Fields: Field Type Required Notes siteld String Yes Terminal identifier for the Emida network. pinProductld String Yes Pin Product ID used to generate the pin redeem call. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Activation product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish invoiceNo String No linformational field Version String No Defaults to 01. Reserved for future use. ESN String Yes Mobile activation ESN NPA String Yes North American Numbering Plan code. SIM String Yes Subscriber identity module number City String No City where the activation is aplicable. zip String No Zip where the activation is This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 147 of 341 aplicable. Sample Request : <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> <urn:LocusActivateCDMAsim soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <siteId xsi:type="xsd:string">9236576</siteId> <pinProductId xsi:type="xsd:string">388015</pinProductId> <clerkId li:type="xsd:string">1234</clerkId> <activationProductId xsi:type="xsd:string">9000905</activationProductId> <languageId xsi:type="xsd:string">1</languageId> <invoiceNo si:type="xsd:string">8246521</invoiceNo> <version xsi:type="xsd:string">01</version> <esn type="xsd:string">100000004705135</esn> <npa xsi:type="xsd:string">305</npa> <sim xsi:type="xsd:string">168465404705132</sim> <city xsi:type="xsd:string">MIA</city> <zip xsi:type="xsd:string">33128</zip> </urn:LocusActivateCDMAsim> </soapenv:Body> </soapenv:Envelope> Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:LocusActivateCDMAsimResponse SOAP - ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ActivateCDMAsimResponse><Version>01</Version><ResponseCode>0o</Respon eCode><ResponseMessage>Success</ResponseMessage><serial>02171699315966</serial><min>1111111111</min> </ActivateCDMAsimResponse>]]></return> </ns1:LocusActivateCDMAsimResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 148 of 341 62. LocusActiv61. LocusActivateCDMAsim This call allows to activate a CDMA phone using the corresponding ESN and SIM numbers. Request Fields: Field Type Required Notes siteld String Yes Terminal identifier for the Emida network. pinProductld String Yes Pin Product ID used to generate the pin redeem call. clerkld String Yes Clerk identifier for the Emida Network. activationProductlo String Yes Activation product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish invoiceNo String No linformational field Version String No Defaults to 01. Reserved for future use. ESN String Yes Mobile activation ESN NPA String Yes North American Numbering Plan code. SIM String Yes Subscriber identity module number City String No City where the activation is aplicable. zip String No Zip where the activation is This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 149 of 341 aplicable. Sample Request : <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services": - <soapenv:Header/> <soapenv:Body> <urn:LocusActivateCDMAsim soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" <siteId i:type="xsd:string">9236576</siteId> <pinProductId xsi:type="xsd:string">388015</pinProductId> <clerkId si:type="xsd:string">1234</clerkId> <activationProductId xsi:type="xsd:string">9000905</activationProductId> <languageId xsi:type="xsd:string">1</languageId> <invoiceNo xsi:type="xsd:string">8246521</invoiceNo> <version xsi:type="xsd:string">01</version> <esn type="xsd:string">100000004705135</esn> <npa xsi:type="xsd:string">305</npa> <sim xsi:type="xsd:string">168465404705132</sim> <city xsi:type="xsd:string">MIA</city> <zip xsi:type="xsd:string">33128</zip> </urn:LocusActivateCDMAsim> </soapenv:Body> </soapenv:Envelope> Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:LocusActivateCDMAsimResponse SOAP - ENV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services" <return xsi:type="xsd:string"><![CDATA[<ActivateCDMAsimResponse><Version>01</Version><ResponseCode>00</Respon Code><ResponseMessage>Success</ResponseMessage><serial>02171699315966</serial><min>1111111111</min> </ActivateCDMAsimResponse>]]></return> </ns1:LocusActivateCDMAsimResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 150 of 341 ateGSMAfcode This call allows to activate a GSM phone using the corresponding AFCODE. Request Fields: Field Type Required Notes siteld String Yes Terminal identifier for the Emida network. pinProductld String Yes Pin Product ID used to generate the pin redeem call. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Activation product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish invoiceNo String No linformational field Version String No Defaults to 01. Reserved for future use. NPA String Yes North American Numbering Plan code. AFCODE String Yes Locus Fast Activation code. City String No City where the activation is aplicable. zip String No Zip wher the activation is aplicable. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 151 of 341 Sample Request : <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services": <soapenv:Header/> <soapenv:Body> <urn:LocusActivateGSMAfcodesoapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <siteId xsi:type="xsd:string">9236576</siteId> <pinProductIdxsi:type="xsd:string">388015</pinProductId> <clerkId xsi:type="xsd:string">1234</clerkId> <activationProductId xsi:type="xsd:string">9000905</activationProductId> <languageId si:type="xsd:string">1</languageId> <invoiceNo xsi:type="xsd:string">54216</invoiceNox <version xsi:type="xsd:string">01</version> <afcode si:type="xsd:string">47051</afcode> <npa ksi:type="xsd:string">305</npa> <city si:type="xsd:string">MIA</city> <zip xsi:type="xsd:string">33128</zip> </urn:LocusActivateGSMAfcodex </soapenv:Body> </soapenv:Envelope: Sample Response: (SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:LocusActivateGSMAfcodeResponse SOAP- ENV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services" <return xsi:type="xsd:string"><![CDATA[<ActivateGSMafcodeResponse><Version>01</Version><ResponseCode>00</Resp onseCode><ResponseMessage>Success</ResponseMessage><serial>02171699422933</serial><min>1111111111</mi h></ActivateGSMafcodeResponse>]]></return> ns1:LocusActivateGSMAfcodeResponse> </SOAP-ENV:Body> </SOAP -ENV:Envelope> - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 152 of 341 63. LocusActivateGSMsim This call allows to activate a GSM phone using the corresponding SIM number. Request Fields: Field Type Required Notes siteld String Yes Terminal identifier for the Emida network. pinProductld String Yes Pin Product ID used to generate the pin redeem call. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Activation product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish invoiceNo String No linformational field Version String No Defaults to 01. Reserved for future use. NPA String Yes North American Numbering Plan code. SIM String Yes Subscriber identity module number. City String No City where the activation is aplicable. zip String No Zip where the activation is aplicable. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 153 of 341 Sample Request : <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' - xmlns:xsd="http://www.w3.org/2001/XMLSchema" kmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:LocusActivateGSMsim soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <siteId xsi:type="xsd:string">9236576</siteId> <pinProductId xsi:type="xsd:string">388015</pinProductId> <clerkId type="xsd:string">1234</clerkId> <activationProductId xsi:type="xsd:string">9000905</activationProductId> <languageId ksi:type="xsd:string">1</languageId> <invoiceNo xsi:type="xsd:string">654765</invoiceNo <version xsi:type="xsd:string">01</version> <npa i:type="xsd:string">305</npa> <sim xsi:type="xsd:string">168465404705132</sim> <city xsi:type="xsd:string">MIA</city> <zip xsi:type="xsd:string">33128</zip> urn:LocusActivateGSMsim> </soapenv:Body> </soapenv:Envelope: Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:LocusActivateGSMsimResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ActivateGSMsimResponse><Version>01</Version><ResponseCode>00</Respons eCode><ResponseMessage>Success</ResponseMessage><serial>02171699318563</serial><min>1111111111</min>< /ActivateGSMsimResponse>]]></return> </ns1:LocusActivateGSMsimResponse> </SOAP-ENV:Body> - </SOAP-ENV:Envelope> - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 154 of 341 User Sesion Based Services This section of the document describes all the new services created as part of the changes performed to the Web Service to allow the use of user credentials to interact with the Debisys Web Service. You can use Login to create a user session (if your ISO is previously configured with Web Service Authentication support) and get the Site ID (or Terminal ID) you will need to call the standard Services. You can also use CheckClerk Service to verify if a Clerk Code provided by the user is valid for a Terminal ID (Site ID). Proposed workflow to interact with Web Service: Login (You get the Site ID associated to the username/password provided) CheckClerk (You verified the Clerk Code for the previously obtained Site ID) NOW you can call the Standard Services using Terminal ID & Clerk Code and having a valid username/password session created Logout (You close your session with the Web Service) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 155 of 341 64. Login The Login service provides a way to create login session and track the user/password management Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. UserName String Y Webservice terminal username Password String Y Webservice terminal password LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. SiteID String Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system that relates with the username,password provided. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. Response parameters are returned as an XML string. A sample response is: <LoginResponse> <Version>01</Version> iteID>1234567</SiteID> (ResponseCode>00</ResponseCode> <ResponseMessage>USER LOGGED IN SUCCESSFULLY</ResponseMessagel </LoginResponse> Note: If the username/password provided in the request is invalid, it means it is not able to find a valid Siteld corresponding to the username/password provided. Sample response in this case is: <LoginResponse> <Version>01</Version> <SiteD></SiteID> <ResponseCode>10</ResponseCode This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 156 of 341 (ResponseMessage>INVALID SITE-ID</ResponseMessage> /LoginResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 157 of 341 65. Logout The Logout service provides a way to end login session and track the user/password management Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. UserName String Y Webservice terminal username Password String Y Webservice terminal password LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged out or not. Response parameters are returned as an XML string. A sample response is: <LoginResponse> <Version>01</Version> (ResponseCode>00</ResponseCodex ResponseMessage>USER LOGGED OUT JUCCESSFULLY</ResponseMessage> </LoginResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 158 of 341 66. CheckClerk The CheckClerk Service provide a way to check if a Clerk is valid for an specific Teminal ID (Site ID). Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. Terminalld String Y Between 5 and 9 digits ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. Response Parameters Field Type Notes Simple value result (no String 00 if Successful XML) Response parameters are returned as an simple string. A sample response is: 00 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 159 of 341 67. Login2 The Login service provides a way to create login session and track the user/password management by returning siteld and clerkld for the site. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. UserName String Y Webservice terminal username Password String Y Webservice terminal password LanguageOption String N Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Field Type Notes Version String 2-character response version indicator. Currently 01. SitelD String Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system that relates with the username,password provided. Clerkld String Between 1 and 9 digits. The Clerkld identifies a clerk that is authorized to sell products via the associated terminal. ResponseCode String 2-character field to indicate success or failure ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. Response parameters are returned as an XML string. A sample response is: <LoginResponse> <Version>01</Version> <SiteID>1234567</SiteID ClerkId>1234</ClerkId> <ResponseCode>00</ResponseCode> ResponseMessage>USER LOGGED IN SUCCESSFULLY</ResponseMessage> (/LoginResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 160 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 161 of 341 Services For NOC Project This section of the document describes the services that the PingPongService use to test the platform, this service has the purpose to check each time if platform is reliable and available. It is the first approach, for an internal project. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 162 of 341 68. NOCOperation The Login service provides a way to create login session and track the user/password management Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. addressWebService String Y Webservice terminal username queryString String Y The parameters to be passed to the addressWebService Response Parameters Field Type Notes Simple value result (no String XML) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 163 of 341 69. sendNotification The sendNotification service provides a way to send emails according the emails parameter. Request Parameters Field Type Required Notes Version String Y 2-Char request version indicator. Currently 01. emails String Y Target of the notification email service. messages String Y The message, normally alert notification indication that something is bad in the platform. subject Strin Y The subject of the email. Response Parameters Field Type Notes Simple value result (no String If the email sends with out error, "sendNotification|OK" XML) Else sendNotification(FAIL(exceptionmessage" This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 164 of 341 70. BillPaymentInfoMx It allows to execute the first step of Bill Payment process in Mexico. This step identifies the fields that should be selected or enter by the end user top ay a bill given the reference number. Request Parameters Parámetro Tipo Requerido Notas Version String S 2-character request version indicator. Currently 01. terminalld String S Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system clerkld String S Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. productld String S Between 4 and 9 digits. ProductID is the identifier for a product. accountld String S Reference of the Bill invoiceNo String S Between 1 to 9 digits. This parameter will be echoed in the response message. languageOption String S Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Response Parameters Parámetro Tipo Notas Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure TransactionDateTime String Debisys transaction date & time ArrayOfFields String XML text with the fields that will be used to the interaction with the user. See Fields Specification Transactionld String Debisys transaction reference number This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 165 of 341 <BillPaymentInfoMxResponse> <Version>01</Version> <InvoiceNo>5678</InvoiceNo> <ResponseCode>00</ResponseCode> <TransactionDateTime>02/18/2013 08:38:26:437</TransactionDateTimex <TransactionId>218657430</TransactionId> KArrayOfFields> <Field> (Name>COMISION</Name> <Type>NM</Type> <Class>1</Class> (Value>7.0</Value> (Length>8</Length> (Encrypted>false</Encrypted> </Field> <Field> <Name>REFERENCIA</Name> <Type>AN</Type> <Class>1</Class> <Value>012970408354511212310000001155</Value> <Length>30</Length> <Encrypted>true</Encrypted> </Field> <Field> <Name>MONTO</Name> <Type>NM</Type> <Class>5</Class> <Value>0</Value> <Length>8</Length> Encrypted>false</Encrypted> </Field> <Field> <Name>DV</Name> <Type>AN</Type> <Class>5</Class> <Value></Value> (Length>1</Length> <Encrypted>false</Encrypted> </Field> /ArrayOfFields> (/BillPaymentInfoMxResponse> Fields Structure Specification The class ArrayOfFields defines the information that should be sent to the Web Service from the client application to request the information of the product/service the clients wants to consume. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 166 of 341 ArrayOfFields { Field [ Name String Nombre del campo. Type Enumerado AN,NE, NM, FD, HR,ND Length Int Longitud que tiene el campo Class Int Es el tratamiento que se le dará a la información. Value Object Es el dato del campo. Encrypted Boolean True=Si el campo viaja encriptado False=Si el campo no viaja encriptado ] } Type: Data Types Tipo Formato 0: AN: Alphanumeric 1: Integer 0 2: Money 0.00 3: Date dd/MM/yyyyy 4: Time HH:mm:ss 5: Numeric 0.00 Class: Tratamiento para los datos al aplicar el pago y la impresión del comprobante: 0. - Es de solo lectura se muestra y no se regresa 1 - No es de solo lectura se muestra y se regresa 2. - No es de solo lectura, no se muestra, toma valor predefinido, y se regresa 3.- - No es de solo lectura, no se muestra, toma valor del sistema, y se regresa 4.- - No es de solo lectura, se pide en ventana con su confirmación, y se regresa 5.- - No es de solo lectura, se pide en ventana sin su confirmación, y se regresa 6.- El valor de este campo se manda a impresión. CON etiqueta 7. - El valor de este campo se manda a impresión. SIN etiqueta 8. - No es de solo lectura, se muestran opciones en un Combo, y el valor seleccionado se regresa This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 167 of 341 71. BillPaymentSaleMx Second step of Bill Payment process in Mexico, it does the actual payment using the information dynamically gathered from the user. Parámetros Requeridos Parameter Tag Type Required Notes The xml Version in String YS 2-character request version indicator. Curre Fields 01. tag should terminalld String YS Between 5 and 9 digits. The siteID is the include the identifier for the merchant terminal in the CDATA as in Debisys system. the ClerkID String YS Between 1 and 9 digits. The ClerkID identific following clerk that is authorized to sell products via th associated terminal. ProductID String YS Between 4 and 9 digits. ProductID is the identifier for a product. InvoiceNo String YS Between 1 to 9 digits. This parameter will be echoed in the response message. LanguageOption String YS Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Fields String S Fields with the information entered by the us See the section "Fields Specification" of the method BillPaymentInfoMx which is the previous and mandatory step to this method call. The fields should be sent using the same xr structure of the response of the BillPaymentInfoMx. All the fields in that response should be included adding the val antarad bu the user example: <soapenv : Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys- soap-services"> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 168 of 341 <soapenv : Header) 1> <soapenv : Body> <urn: BillPaymentsaleMx soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">01</version> <terminalId xsi:type="xsd:string">5838930</terminalId> <clerkId isi:type="xsd:string">1234</clerkId> <productId :type="xsd:string">9000900</productId> <invoiceNo ype="xsd:string">5684</invoiceNo> <languageOptionxsi:type="xsd:string">2</languageOption> <Fields xsi:type="xsd:string"><![CDATA[<ArrayOfFields><Field><Name>COMISION</Name><Type>NM< Type><Class>1</Class><Value>7.0</Value><Length>8</Length><Encrypted>false</Encryr ></Field><Field><Name>REFERENCIA</Name><Type>AN</Typex<Class>1</Class><Value555 095443</Value><Length>30</Length><Encrypted>true</Encrypted></Field><Field><Name>Mo NTO</Name><Type>NM</Type><Class>5</Class><Value>3.89</Value><Length>8</Length><Enc pted>false</Encrypted></Field><Field><Name>DV</Name><Type>AN</Typex<Class>5</Class ><Value>3</Value><Length>1</Length><Encrypted>false</Encrypted></Field></ArrayOfFie 1ds>]]></Fields> (urn:BillPaymentsaleMx> </soapenv:Body> </soapenv:Envelope> Parámetros de respuesta Parameter Tag Type Notes Version String 2-character request version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure Reference String Payment Reference. TotalAmount String Total Amount to be collected. Includes the Bill Amount and the Fee. Fee String Fee charged to the final user. Amount String Amount of the Bill. TransactionDateTime String Debisys transaction date & time transacción. ResponseMessage String Text to be displayed to the end user that tells if user is logged in or not. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 169 of 341 Transactionld String Debisys transaction reference number. Response parameters are returned as an XML string. A sample response is: <BillPaymentsaleMxResponse> <Version>01</Version> <InvoiceNo>5684</InvoiceNo> (ResponseCode>00</ResponseCode> <Reference>5553095443</Reference> <TotalAmount>10.89</TotalAmount> <Fee></Fee> <Amount>3.89</Amount> <TransactionDateTime>02/18/2013 11:33:01:577</TransactionDateTime> <ResponseMessage>NO DEFAULT RESPONSE!</ResponseMessage> <TransactionId>218657434</TransactionId) <AuthorizationNo>1220</AuthorizationNo> (/BillPaymentsaleMxResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 170 of 341 72. TransactionsDetailsForDay This method allows to obtain the list of transactions processed for a specific date. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system. clerkld String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. dayDate String Y In this parameter, the date must be sent for the transactions to be queried. The format that should be used is YYYY-MM-DD LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Request Sample: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmIns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> kurn:TransactionsDetailsForDay soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"= <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">4529142 </terminalld> <clerkld xsi:type="xsd:string">1234</clerkld> <dayDate xsi:type="xsd:string">2017-05-05</dayDate> <languageOption xsi:type="xsd:string">1</languageOption: </urn:TransactionsDetailsForDay> </soapenv:Body> </soapenv:Envelope> Response Parameters Parameter Tag Type Notes ResponseMessage String Inside is included all CDTA with and xml array with the detail for ead transaction. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 171 of 341 Response Sample: ISOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ (xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:TransactionsDetailsForDayResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[<PINReturnRequestStatusResponse> <ResponseCode>00</ResponseCode> <ResponseMessage> Details> <Transaction> <Merchantld>805028920871 </Merchantld> <TranNo>172317312</TranNo> <Siteld>4529142</Siteld> <Dba>58</Dba> <Date>2017-05-05 11:47:15.583</Date> <ClerkName>belicedos </ClerkNamex <Reference/> <RefNo/> <RechargeValue>10.0000</RechargeValuex <MerchantRate>0.2</MerchantRate> <ProductSku>8815100</ProductSku> <ProductDescription>TEST PAYGO Unlimited with Chirp $10 to $19</ProductDescription> <PinNumber/> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 172 of 341 ransactionType>Activation</TransactionType> </Transaction> </Details> </ResponseMessage> </PINReturnRequestStatusResponse>]]></return> </ns1:TransactionsDetailsForDayResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 173 of 341 73. PINReturnRequestStatus This method allows the user to know the status of their Pin Return request at any time. Request Parameters Parameter Tag Type Required Notes Version String Y 2-character request version indicator. Currently 01. terminalld String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Debisys system. clerkld String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. caseld String Y Case number associated with the PIN Return request LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Request Sample: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" kmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:PINReturnRequestStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">4529142</terminalld> <clerkld xsi:type="xsd:string">1234</clerkld> <caseld xsi:type="xsd:string">264926</caseld> <languageOption xsi:type="xsd:string">1</languageOption This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 174 of 341 </urn:PINReturnRequestStatus> </soapenv:Body> </soapenv:Envelope> Response Parameters Parameter Tag Type Notes ResponseMessage String Inside is included all CDTA with and xml array with the detail for ea transaction. Response Sample: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" mlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> hs1:PINReturnRequestStatusResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/ xmlns:ns1="urn:debisys-soap- services": <return xsi:type="xsd:string"><![CDATA[<PINReturnRequestStatusResponse> <ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage> <Siteld>4529142</Siteld> <Productld>8000000</Productld> <ProductDescription>Cingular Test Pins $20.00</ProductDescription> <ClerkName>belicedos </ClerkNamex <Status>Rejected</Status> <ProcessingDate>2017-05-03 12:40:49.0</ProcessingDate> /PINReturnRequestStatusResponse>]]></return> </ns1:PINReturnRequestStatusResponsex </SOAP-ENV:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 175 of 341 /SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 176 of 341 41. IsoLogin This method allows to a Iso login, order to he can use the methods "InsertMerchant" and "CheckMerchantBylsoAndTaxld" Request Parameters Parameter Tag Type Required Notes iso String Y ISO Id user String Y User name to log in. password String Y Password to log in. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= http://www.w3.org/2001/XMLSchema" xmlns:soapenv= "http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn= "urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:IsoLogin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <iso xsi:type="xsd:string">3864425959755</iso> <user xsi:type="xsd:string">diegokin2</user> <password xsi:type="xsd:string">12345</password> <languageOption xsi:type="xsd:string">1</languageOption> </urn:IsoLogin> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 177 of 341 Response Parameters An array of 2 positions will be response: Parameter Tag Type Notes String[0] String Response Code. 0 = Iso logged successful 10 = No logged ISO, Invalid Iso or (user, password) do not found. 96 = Any Exception has happened (SYSTEM_ERROR). Example NumberFormatException. String[1] String Response Message - Iso logged successful. - There is not an user for the ISO [123456789] with user[user] and password [pass]. - Exception in IsoLogin [Exception]. Example: <SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd ="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:lsoLoginResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/' xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[2]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">0</item> <item xsi:type="xsd:string">lso logged successful</item> </return> </ns1:lsoLoginResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 178 of 341 75. IsoLogout This method allows to a Iso log out, order to avoid use the methods "InsertMerchant" and "CheckMerchantBylsoAndTaxld' Request Parameters Parameter Tag Type Required Notes iso String Y ISO Id user String Y User name to log out. password String Y Password to log out. languageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" kmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:IsoLogout soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <iso si:type="xsd:string">3864425959755</iso> <user xsi:type="xsd:string">diegokin2</user> <password si:type="xsd:string">12345</password> <languageOption xsi:type="xsd:string">1</languageOption> </urn:IsoLogout> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 179 of 341 Response Parameters An array of 2 positions will be response: Parameter Tag Type Notes String[0] String Response Code. 0 = Iso logged successful 10 = No logged ISO, Invalid Iso or (user, password) do not found. 96 = Any Exception has happened (SYSTEM_ERROR) Example NumberFormatException. String[1] String Response Message - Iso logged out successfully - There is not an user for the ISO [123456789] with user[user] and password [pass]. - Exception in IsoLogin [Exception]. Example: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> <ns1:lsoLogoutResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1= "urn:debisys-soap-services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[2]" xmlns:ns2= "http://schemas.xmlsoap.org/soap/encoding/"> <item si:type="xsd:string">0</item> <item xsi:type="xsd:string">lsol logged out successfully</item> </return> </ns1:IsoLogoutResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 180 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 181 of 341 76. CheckMerchantBylsoAndTaxld This method allows to know if a Merchant exist according to an ISO id and the merchant tax_id Request Parameters Parameter Tag Type Required Notes isoToken String Y Iso Token tax_id String Y Merchant tax id (unique id) language String Y Single-digit number to indicate preferred language for the response message. 1 = English = 1 Spanish = 2 Example <soapenv:Envelope xmlns:xsi= http://www.w3.org/2001/XMLSchema-instance"> xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:soapenv= "http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn= "urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> kurn:CheckMerchantBylsoAndTaxid soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <isoToken xsi:type="xsd:string">3864425959755</isoToken> <tax_id xsi:type="xsd:string">123456788</tax_id> <language xsi:type="xsd:string">1</language> </urn:CheckMerchantBylsoAndTaxld> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 182 of 341 Response Parameters (Error Found) An array of 2 positions will be response if a bad process happened: Parameter Tag Type Notes String[0] String Response Code. 102= = (Iso not logged in) 103= = (Invalid isoToken) 17 = Merchant not found. 96 = Any Exception has happened (SYSTEM_ERROR). Example NumberFormatException String[1] String Response Message - Iso not logged in - Merchant not found. - Exception evaluating data [Exception]. Example: <SOAP-ENV:Envelopexmlns:SOAP-ENV= "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:CheckMerchantBylsoAndTaxIdResponse SOAP- NV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services": <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[2]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">17</item> <item xsi:type="xsd:string">Merchantnot found For the Iso [3864425959755] and tax_id [123456788]</item> </return> /ns1:CheckMerchantBylsoAndTaxIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 183 of 341 Response Parameters (Successful) An array of 9 positions will be response If a merchant is found. Parameter Tag Type Notes String[0] String Response Code. 0 (Merchant was found) String[1] String - Merchant Id String[2] String - Rep Id String[3] String - Enabled / Disabled String[4] String - Business Name String[5] String - Contact String[6] String - DBA String[7] String - Contact Phone String[8] String - Phys address Example <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' kmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"x kmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:CheckMerchantBylsoAndTaxldResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> return xsi:type="ns2:Array" ns2:arrayType="xsd:string[9]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">0</item> <item xsi:type="xsd:string">395529083197 </item> <item xsi:type="xsd:string">818384254652</item> <item xsi:type="xsd:string">Enabled</item> <item xsi:type="xsd:string">LegalBNameSoap</item: <item xsi:type="xsd:string">contactSoap</item> <item xsi:type="xsd:string">merchantSOAP_DBA</item> <item xsi:type="xsd:string">9991112222</item> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 184 of 341 <item xsi:type="xsd:string">Phys Address</item> </return> </ns1:CheckMerchantBylsoAndTaxldResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 185 of 341 77. InsertMerchant This method allow create a new merchant from a simple and basic Json structure with the merchant attributes. Request Parameters Parameter Tag Type Required Notes isoToken String Y Iso Token jsonKeyValueMap Json String Y Json structure with the merchant columns (name, value). If you type the "test" word in this field you will get a Json example Basic Json data (soap example) {"rep_id": "818384254652", "legal_businessname": "LegalBNameSoap", "dba": "merchantSOAP_DBA" "contact": "contactSoap", "contact_phone": "931-122-7879", "phys_address": "26 Street", "phys_city": "FoothillRanch", "phys_zip": "34343", "merchant_type": "2", "phys_state": "CA", "tax_id": "123456786", "account_no": "42343434", "email": "dgarzon@emida.net" } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 186 of 341 Soap complete example: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:InsertMerchantsoapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <isoToken xsi:type="xsd:string">07O4ITQ4WABZYLLVSEYGMV5F3NM=</isoToken> <jsonKeyValueMap xsi:type="xsd:string"> {"rep_id": "818384254652", "legal_businessname": "LegalBNameSoap", "dba":"merchantSOAP_DBA", "contact": "contactSoap", "contact_phone": "931-122-7879", "phys_address": "26 Street", "phys_city": "FoothillRanch", "phys_zip": "34343", "merchant_type": "2", "phys_state":"CA", "tax_id": "123456786", "account_no": "42343434", "email": 'dgarzon@emida.net" } </jsonKeyValueMap> </urn:InsertMerchant> </soapenv:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 187 of 341 </soapenv:Envelope> All complete fields you can add to the Json. All values are Strings between quotes Note: All fields are sensitive case. Field Type Length Values rep_id numeric 9 legal_businessname String 50 tax_id String 15 contact String 50 dba String 50 contact_phone String 15 contact_fax String 15 phys_address String 50 phys_city String 50 phys_county String 20 phys_state String 50 phys_zip String 10 phys_country String 50 mail_address String 50 mail_city String 50 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 188 of 341 mail_state String 100 mail_zip String 10 mail_country String 50 aba String 36 account_no String 20 1- Prepaid Credit, 2-Limited Credit, 3- merchant_type int 4 Unlimited Credit) RunningLiability numeric 8 LiabilityLimit numeric 8 mail_delegation String 100 mail_county String 20 mail_colony String 100 BankName String 100 merchant_classification int 4 Merchant Classification Id (see list) latitude numeric 9 longitude numeric 9 bank_address String 50 bank_city String 50 bank_state String 50 bank_zip String 10 bank_contact_name String 50 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 189 of 341 bank_contact_phone String 15 Merchant Classification List (for Domestic platform) Id Description 5 Wireless Store 6 Convenience Store 7 Mobile Merchant 8 Gas station 9 Chain location/Big Box Retail 10 Online Website (API) 11 3rd Party Application (API) 12 Other Response Parameters An array of 3 positions will be response (Response Code, Response Message and Detail) Parameter Tag Type Notes This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 190 of 341 String[0] String Response Code. 0 = Merchant was created successfully 1 = Mandatory Field. 2 = Json Example 96 = Any Exception has happened (SYSTEM_ERROR). Example NumberFormatException 102 = (Iso not logged in) 103 = Invalid IsoToken String[1] String Response Message - Merchant was created successfully - There are errors validating the data (see detail). - Error Creating Merchant [Exception] - Json Example String[2] String Detail (Examples) - rep_id=Valid Rep for this Merchant. The rep does not exist or it is not under this Iso. - email=The email can't be null or empty - Exception evaluating data. Posible reasons: Json bad or some converting data is incorrect (NumberFormatException) Example (Bad response): <SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmIns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:InsertMerchantResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/ xmlns:ns1="urn:debisys-soap-services"> <return (si:type="ns2:Array" ns2:arrayType="xsd:string[3]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">1</item> <item xsi:type="xsd:string">There are errors validating the data (see data)</item> <item xsi:type="xsd:string">{email=The email can't be null or empty}</item> </return> </ns1:InsertMerchantResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Example (successful) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 191 of 341 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ kmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:InsertMerchantResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[3]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">0</item> <item xsi:type="xsd:string">Merchant was created successfully</item> <item type="xsd:string">{merchant_id=762590853955}</item </return> </ns1:InsertMerchantResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 192 of 341 78. LocusCreateMultiLine2Lines This call allows join up 2 lines by ESN or SIM numbers on Locus platform. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes MultiLine product identifier amount String Yes Amount of productld. invoiceNo String Yes Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. line1 String Yes This value can be a SIM or ESN, will join up in locus. line2 String Yes This value can be a SIM or ESN, will join up in locus. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample Request : This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 193 of 341 <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn :debisys-soap-services" <soapenv:Header/> <soapenv:Body> <urn:LocusCreateMultiline2Lines soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <version xsi:type="xsd:string">01</version> <terminalId xsi:type="xsd:string">4083900</terminalId> <clerkId xsi:type="xsd:string">56987</clerkId> <productId xsi:type="xsd:string">814510</productId> <amount (si:type="xsd:string">50</amount> <invoiceNo xsi:type="xsd:string">3</invoiceNo> <line1 si:type="xsd:string">3001001</line1> <line2 xsi:type="xsd:string">3001002</line2> <languageId xsi:type="xsd:string">1</languageId: </urn:LocusCreateMultiline2Lines> </soapenv:Body> </soapenv:Envelope> Sample Response: (SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> :LocusCreateMultiline2LinesResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services": <return xsi:type="xsd:string"> <![CDATA[<CreateMultilineResponsex Version>01</Version> <ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage> ransactionId>218704511</TransactionId> </CreateMultilineResponse>]]></return> </ns1:LocusCreateMultiline2LinesResponse> </SOAP-ENV:Body> </SOAP -ENV:Envelope: - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 194 of 341 79. LocusCreateMultiLine4Lines This call allows join up 4 lines by ESN or SIM numbers on Locus platform. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes MultiLine product identifier amount String Yes Amount of productld. invoiceNo String Yes Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. line1 String Yes This value can be a SIM or ESN, will join up in locus. line2 String Yes This value can be a SIM or ESN, will join up in locus. line3 String Yes This value can be a SIM or ESN, will join up in locus. line4 String Yes This value can be a SIM or ESN, will join up in locus. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample Request : This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 195 of 341 <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys -soap-services": <soapenv:Header/> <soapenv:Body> turn:LocusCreateMultiline4Lines soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version ksi:type="xsd:string">01</version> <terminalId xsi:type="xsd:string">4083900</terminalId> <clerkId si:type="xsd:string">56987</clerkId> <productId xsi:type="xsd:string">814510</productId> <amount si:type="xsd:string">50</amount> <invoiceNoxsi:type="xsd:string">3</invoiceNo <line1 xsi:type="xsd:string">3001001</line1> <line2 xsi: type="xsd:string">3001002</line2> <line3 xsi:type="xsd:string">3001003</line1> <line4 xsi:type="xsd:string">3001004</line2> <languageId xsi:type="xsd:string">1</languageId> n:LocusCreateMultiline4Lines> </soapenv:Body> </soapenv:Envelope> Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> - s1:LocusCreateMultiline4LinesResponse SOAP- V:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"> DATA[<CreateMultilineResponsex (Version>01</Version> ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage <TransactionId>218704514</TransactionId> </CreateMultilineResponse>]]></ret </ns1:LocusCreateMultiline4LinesResponse </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 196 of 341 80. LocusActivateMultiLineSim This call allows activate by SIM number on Locus platform. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes MultiLine product identifier invoiceNo String Yes Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. npa String Yes North American Numbering Plan code. sim String Yes Subscriber identity module number. city String Yes City where the activation is aplicable. zip String Yes Zip where the activation is aplicable. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 197 of 341 Sample Request : <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/' xmlns:urn="urn:debisys-soap-services": <soapenv:Header/> <soapenv:Body> <urn:LocusActivateMultilineSim soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">01</version> <terminalId xsi:type="xsd:string">4083900</terminalId> <clerkId si:type="xsd:string">56987</clerkId: <productId xsi:type="xsd:string">814510</productId> <invoiceNo xsi:type="xsd:string">4</invoiceNo> <npa ksi:type="xsd:string">235</npa> <sim xsi:type="xsd:string">3001003</sim> <city xsi:type="xsd:string">irvine</city> <zip xsi:type="xsd:string">92615</zip> <languageId xsi:type="xsd:string">1</languageIdx urn:LocusActivateMultilineSim> </soapenv:Body> 'soapenv:Envelopex Sample Response: Take at look to the following response, if all SIMs was successfully activate a MultilineReceipt tag will added, this tag contains the multiline transaction receipt has the resume of the SIMs child transactions, if not, just the response message tag comes with the current transaction receipt. Response for the first SIM <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ nlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" SOAP-ENV:Body> ns1:LocusActivateMultilineSimResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return si:type="xsd:string"> ![CDATA[<LocusActivateMultilineSimResponse> <Version>01</Version> ResponseCode>00</ResponseCode> <ResponseMessage: &lt;p align=center&gt;&lt;font class="receipt_product_name"&gt;Amount $50.00 &lt;br&gt;Date 10/20/2017 8:46:45 AM&lt;br&gt;Account &lt;br&gt;Carrier 2017&lt;br&gt; Product 10 &lt;br&gt;Billing &lt;br&gt;Clerk nip &lt;br&gt;SiteId 4083900&lt;br&gt;Merchant Name RJA&lt;br&gt; Congratulations and welcome to OKMobile!&lt;/i&gt;&lt;/font&gt;&lt;p align=justify&gt;&lt;font class="receipt_instructions"&gt;&lt;b&gt;&lt;br&gt;These Sims Cards has been multilined !!!! Visit OKMobile.com for more details.&lt;br&gt;Enjoyyour services!&lt;/b&gt;&lt;/font&gt;&lt;br&gt;575754757&lt;br&gt;&lt;br&gt;&lt;br&gt;Transaction ID: 218704531&lt;/font&gt;&lt;/p&gt; /ResponseMessage> TransactionId>218704531</TransactionId> </LocusActivateMultilineSimResponse>]]></return> /ns1:LocusActivateMultilineSimResponsex </SOAP-ENV:Body> </SOAP-ENV: - Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 198 of 341 Response for the last SIM SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:LocusActivateMultilineSimResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" kmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"> <![CDATA[<LocusActivateMultilineSimResponse> <Version>01</Version> <ResponseCode>00</ResponseCode> <ResponseMessage> &lt;p align=center&gt;&lt;font class="receipt_product_name"&gt;Amount $50.00&lt;br&gt;Date 10/20/20178:48:32 AM&lt;br&gt;Account &lt;br&gt;Carrier 2017&lt;br&gt Product 10 &lt;br&gt;Billing &lt;br&gt;Clerk nip &lt;br&gt;SiteId 4083900&lt;br&gt;Merchant Name RJA&lt;br&gt; Congratulations and welcome to GuertyMobile!&lt;/i&gt;&lt;/font&gt;&lt;p align=justify&gt;&lt; font class="receipt_instructions"&gt;&lt;b&gt;&lt;br&gt;These Sims Cards has been multilined !!!! Visit GuertyMobile.com for more details.&lt;br&gt; Enjoy your vvices!&lt;/b&gt;&lt;/font&gt;&lt;br&gt;TOKEN_ITEM_PHONE_NUMBER&lt;br&gt;&lt;br&gt;&lt br&gt; Tra nsaction ID: 218704532&lt;/font&gt;&lt;/p&gt </ResponseMessage> TTransactionId>218704532</TransactionId> <MultilineReceipt> <p align=center><font class="receipt_product_name">Amount $50.00 <br>Date 10/20/2017 8:15:33 AM<br>Account <br>Carrier 2017<br> Product 10 <br>Billing <br>Clerk nip <br>SiteId 4083900<br>Merchant Name RJA<br> Congratulations and welcome to OKMobile!</i></font><p align=justify><font lass="receipt_instructions"><b><br>These Sims Cards has been multilined !!!! Visit OKMobile.co for more details. <br> Enjoy your services!</b></font><br><br/><tablex<tr><tr><td>Sim/AfCode</td><td>PhoneNumber</td><td>TrxId</td>< /tr><tr><td>3001004</td><td>55576757</td><td>218704532</td></tr><tr><td>3001003</td><td>5754754</ d><td>218704531</td></tr></tablex<br><br><br> Transaction ID: 218704529</font></px </MultilineReceipt> (/LocusActivateMultilineSimResponse>]]></returnx ns1:LocusActivateMultilineSimResponse> </SOAP-ENV:Body> </SOAP -ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 199 of 341 81. LocusActivateMultiLineAfCode This call allows activate by SIM number on Locus platform. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes MultiLine product identifier invoiceNo String Yes Between 1 to 9 digits. This parameter will be echoed in the response message. This parameter is considered an external transaction. afcode String Yes Locus Fast Activation code. npa String Yes North American Numbering Plan code. city String Yes City where the activation is aplicable. zip String Yes Zip where the activation is aplicable. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish Sample Request : This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 200 of 341 <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmIns:xsd="http://WWw.W3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xr hlns:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> <urn:LocusActivateMultilineAfCode soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <version xsi:type="xsd:string">01</version> <terminalId xsi:type="xsd:string">3454354</terminalIdx <clerkId ksi:type="xsd:string">1234</clerkId> <productId (si:type="xsd:string">44444</productId> <invoice ksi:type="xsd:string">2</invoice> <afcode xsi:type="xsd:string">3545445ER</afcode> <npa si:type="xsd:string">568</npa> <city :type="xsd:string">los angeles</city> <zip xsi:type="xsd:string">92610</zip> <languagexsi:type="xsd:string">1</language> urn:LocusActivateMultilineAfCode> </soapenv:Body> </soapenv:Envelope> Sample Response: Take at look to the following response, if all AfCodes was successfully activate a MultilineReceipt tag will added, this tag contains the multiline transaction receipt has the resume of the AfCode child transactions, if not, just the response message tag comes with the current transaction receipt. Response for the first SIM <SOAP-ENV: Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope, lns:xsi="http://www.w3.org/2001/XMLSchema-instance" imlns:xsd="http://www.w3.org/2001/XMLSchema"><SOAP -ENV:Body> kns1:LocusActivateMultilineAfCodeResponse SOAP- ENV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"> ATA[<LocusActivateMultilineAfCodeResponse> <Version>01</Version> <ResponseCode>00</ResponseCode> <ResponseMessage: &lt;p align=center&gt;&lt;font class="receipt_product_name"&gt;Amount $0.00 &lt;br&gt;Date 10/3/2017 1:45:11 PM&lt;br&gt; &lt;br&gt;Carrier 2017&lt;br&gt;Product 10 &lt;br&gt;Billing&lt;br&gt;Clerk nip &lt;br&gt;SiteId 4083900&lt;br&gt;Merchant Name RJA&lt;br&gt_ Congratulations and welcome to GuertyMobile!&lt;/i&gt;&lt;/font&gt;&lt; align=justify&gt;&lt;font lass="receipt_instructions"&gt;&lt;b&gt;&lt;br&gt;Visit GuertyMobile.com for more details.&lt;br&gt; Enjoy your services!&lt;/b&gt;&lt;/font&gt;&lt;br&gt;Phone Number &lt;br&gt;Transaction ID: 218704495&lt;/font&gt;&lt;/p&gt; </ResponseMessage> ransactionId>218704494</TransactionId> (LocusActivateMultilineAfCodeResponse>]]></ </ns1:LocusActivateMultilineAfCodeResponse> </SOAP-ENV:Body> (/SOAP -ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 201 of 341 Response for the last SIM <SOAP-ENV: Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema <SOAP-ENV:Body> Ins1:LocusActivateMultilineAfCodeResponse: SOAP - NV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"> <![CDATA[<LocusActivateMultilineAfCodeResponse> VVersion>01</Version> ResponseCode>0o</ResponseCode> <ResponseMessage> &lt;p align=center&gt;&lt;font class="receipt_product_name"&gt;Amount $0.00 &lt;br&gt;Date 10/3/2017 1:45:11 PM&lt;br&gt; &lt;br&gt;Carrier 2017&lt;br&gt;Product 10 &lt;br&gt;Billing &lt;br&gt;Clerk nip &lt;br&gt;SiteId 4083900&lt;br&gt;Merchant Name RJA&lt;br&gt; Congratulations and welcome to GuertyMobile!&It;/i&gt;&lt;/font&gt;&lt;p align=justify&gt;&lt;font lass="receipt_instructions"&gt;&lt;b&gt;&lt;b GuertyMobile.com for more details.&lt;br&gt; Enjoy your services!&lt;/b&gt;&lt;/font&gt;&lt;br&gt;Phone Number &lt;br&gt;Transaction ID: 218704495&lt;/font&gt;&lt;/p&gt; </ResponseMessage> <TransactionId>218704494</TransactionId> <MultilineReceipt> <p align=center><for class="receipt_product_name">Amount $50.00 <br>Date 10/3/2017 8:12:28 AM<br>Account<br>Carrier 2017<br>Product 10 <br>Billing <br>Clerk nip <br>SiteId 4083900<br>Merchant Name RJA<br> Congratulations and welcome to GuertyMobile!</i></font> <p align=justify><font class="receipt_instructions"><b><br>These Sims Cards has been multilined !!!! Visit LOCUSMobile.com for more details. <br>Enjoy your services!</b></font><br><br/><tablex <tr><td>AfCode</td><td>PhoneNumber</td><td>TrxId</td></tr><tr><td>3545445ER</td><td>9 7787878</td><td>218704495</td></tr><tr><td>3001002</td><td>9007887878</td><td>218704494 </td></tr> .tablex<br><br><br>Transaction ID:218704488</font></p> </MultilineReceipt> <</LocusActivateMultilineAfCodeResponse>]]></return> s1:LocusActivateMultilineAfCodeResponse> </SOAP-ENV:Body> - </SOAP -ENV:Envelope> - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 202 of 341 82. ValidatelsoLogin This method allows validate if a username and password are a valid Iso login. Request Parameters Parameter Tag Type Required Notes username String Y Iso username password String Y Iso password Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" hIns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <um:ValidatelsoLogin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <username xsi:type="xsd:string">diegog</username> <password si:type="xsd:string">123457</password> </um:ValidatelsoLogin> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 203 of 341 Response Parameters (Error Found) An array of 2 positions will be response if a bad process happened: Parameter Tag Type Notes String String - Isold if there is a valid register - Message "Iso not found" if there are not any register Example: <SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:ValidatelsoLoginResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/ xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string">3864425959755</return> </ns1:ValidatelsoLoginResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 204 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 205 of 341 83. ValidatelsoToken This method allows validate if a token is valid Request Parameters Parameter Tag Type Required Notes token String Y Iso token Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope. xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:ValidatelsoToken soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <token xsi:type="xsd:string">0704ITQ4WABZYLLVSEYGMV5F3NM=</token> </urn:ValidatelsoToken> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 206 of 341 Response Parameters (Error Found) An array of 2 positions will be response if a bad process happened: Parameter Tag Type Notes String[0] String - True if there is a Iso for the current token else False String[1] String Default Rep Id or empty if there is not any rep configurated. Example: OAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> ins1:ValidatelsoTokenResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[2]" xmlns:ns2="http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">True</item> <item xsi:type="xsd:string">651062464894</item> </return> /ns1:ValidatelsoTokenResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 207 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 208 of 341 84. H2OWirelessPortin This method allows doing Portin on H2OWireless platform. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes H2OWireless product identifier languageOption String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number emailAddress String Yes H2Owireless email address field callBackNumber String Yes Call Back Phone Number. oldServiceProvider String Yes Old service provider Note: (Look list below) cellNumberToTransfer String Yes Cell number to transfer cellNumberContract String Yes If other service provider is under contract. ('YES' contract, 'NO', otherwise) accountHolderFirst String Yes Account Holder's First Name accountHolderLast String Yes Account Holder's Last Name accountNumber String Yes Account Number accountPasswordPin String Yes Account Password/PIN accountAddress String Yes Account Street Address city String Yes City where the activation is aplicable. state String Yes State (look list below) This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 209 of 341 zipCode String Yes Zip where the activation is aplicable (Account ZIP) sim String Yes Subscriber identity module number. (SIM for activation) IMEI String Yes IMEI plan String Yes productld of PIN Old Servicer providers: Airvoice Wireless ,ATT Boost Mobile Claro PR Consumer Cellular Credo , Cricket Wireless Envie Google Voice H2O , Hanacell Helio Wireless Horizon Mobile iWireless ,Jolt Mobile ,Lycamobile , Metro PCS Mobi PCS Net10 Open Mobile PAETEC/Windstream ,PagePlus ,Pocket Mobile RedPocket , Revol Wireless , Safelink Wireless ,Simple Mobile Sprint Straight Talk T-Mobile , Total Call Wireless Tracfone , Tuyo Mobile , Ultra Mobile , US Cellular ,Verizon Wireless Virgin Mobile Vonage Walmart Family Mobile , Mobile ,Others. States list: AL Alabama MT Montana AK Alaska NE Nebraska AS AmericanSamoa NV Nevada AZ Arizona NH NewHampshire AR Arkansas NJ NewJersey CA California NM NewMexico CO Colorado NY NewYork CM Com.Marianas NC NorthCarolina CT Connecticut ND NorthDakota DE Delaware OH Ohio FL Florida OK Oklahoma GA Georgia OR Oregon GU Guam PA Pennsylvania HI Hawaii PR PuertoRico ID Idaho RI Rhodelsland IL Illinois SC SouthCarolina IN Indiana SD SouthDakota IA Iowa TN Tennessee KS Kansas TX Texas KY Kentucky UT Utah LA Louisiana VT Vermont ME Maine VA Virginia MD Maryland VI VirginIslands MA Massachusetts WA Washington This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 210 of 341 MI Michigan DC Washington, DC MN Minnesota WV WestVirginia MS Mississippi WI Wisconsin MO Missouri WY Wyoming Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:H2OWirelessPortin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalld xsi:type="xsd:string">5949437 </terminalld: <clerkld xsi:type="xsd:string">1234</clerkld> <productld xsi:type="xsd:string">8819500</productld> <languageOption xsi:type="xsd:string">1</languageOption: <invoiceNo xsi:type="xsd:string">12345</invoiceNo> <emailAddress xsi:type="xsd:string">email@company.com</emailAddress> <callBackNumber xsi:type="xsd:string">1234567890</callBackNumber> <oldServiceProvider xsi:type="xsd:string">Lycamobile</oldServiceProvider> <cellNumberToTransfe xsi:type="xsd:string">1234567890</cellNumberToTransfer> <cellNumberContract xsi:type="xsd:string">YES</cellNumberContract> <accountHolderFirst xsi:type="xsd:string">Name</accountHolderFirst: <accountHolderLast xsi:type="xsd:string">LastName</accountHolderLast <accountNumber xsi:type="xsd:string">343434</accountNumber> <accountPasswordPin xsi:type="xsd:string">1111</accountPasswordPin: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 211 of 341 <accountAddress xsi:type="xsd:string">Address123</accountAddress: <city xsi:type="xsd:string">LA</city> <state xsi:type="xsd:string">ca</state> <zipCode xsi:type="xsd:string">57 </zipCodex <serviceType xsi:type="xsd:string">a</serviceType> <sim xsi:type="xsd:string">34344343434343434343</sim> <imei xsi:type="xsd:string">343434343434345</imeix= <plan xsi:type="xsd:string">8814330</plan> </urn:H2OWirelessPortin> </soapenv:Body> </soapenv:Envelope> Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. otherwise the error code. ResponseMessage String Short description of the process. PORTINREFERENCENUMBER String Reference when porting. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 212 of 341 ins1:H2OWirelessPortinResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/' mlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<H2OPortinPinResponse><ResponseCode>101 </ResponseCode><Respon seMessage>Invalid emailAddress =[email],[Entera validemail address!]</ResponseMessage> <MIN> </MIN><PORTINREFERENCENUMBER></PORTINREFERENCENUMBER></H2OPortinPinResponse>]]></re turn> </ns1:H2OWirelessPortinResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Other provider Response example: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> ins1:H2OWirelessPortinResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding. xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<H2OPortinPinResponse><ResponseCode>51 </ResponseCode><Respons eMessage>NOT ACTIVATEDInvalid MDN number</ResponseMessage> <MIN></MIN> <PORTINREFERENCENUMBER> </PORTINREFERENCENUMBER> </H2OPortinPinResponse>]]></return> </ns1:H2OWirelessPortinResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 213 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 214 of 341 85. LocusActivateGSMsimPhoneBundle This method allows doing Activate a sim without a pin. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Emida product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number npa String Yes 3 digits sim String Yes Subscriber identity module number. (SIM for activation). city String Yes Old service provider Note: (Look list below) zip String Yes Zip where the activation is aplicable (Account ZIP) imei String Yes 15 digit IMEI of the handset. Must be supplied for GSM activations. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 215 of 341 Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:LocusActivateGSMsimPhoneBundle soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <version xsi:type="xsd:string">01 </version> <siteld si:type="xsd:string">4083900</siteld> <clerkld xsi:type="xsd:string">56987 </clerkld> <activationProductld xsi:type="xsd:string">5137504</activationProductld> <languageld xsi:type="xsd:string">1</languageld> <invoiceNo si:type="xsd:string">3</invoiceNo> <npa xsi:type="xsd:string">242</npa> <sim xsi:type="xsd:string">444400444</sim> <city xsi:type="xsd:string">los angeles</city> <zip xsi:type="xsd:string">92610</zip> <imei xsi:type="xsd:string">457940005487845</imei> </urn:LocusActivateGSMsimPhoneBundlex </soapenv:Body> </soapenv:Envelope> Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 216 of 341 ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. Serial String Not useful MIN String The activation phone number. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:LocusActivateGSMsimPhoneBundleResponse SOAP- INV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ActivateGSMsimPhoneBundleResponse><Version>01</ersion> <ResponseCode>00</ResponseCode><ResponseMessage>Success</ResponseMessage> <serial>23034434</serial> <min>456721289721212325890123</min> </ActivateGSMsimPhoneBundleResponse>]]></return> </ns1:LocusActivateGSMsimPhoneBundleResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 217 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 218 of 341 86. FreeUpMobileUtil This method allows doing Activate from FreeUp Mobile provider. Request Fields: Field Type Require Notes d version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:FreeUpMobileUtil soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"= <version xsi:type="xsd:string">01 </version> <siteld xsi:type="xsd:string">4083900</siteld> <clerkld xsi:type="xsd:string">56987 </clerkld> <languageld xsi:type="xsd:string">1</languageld: </urn:FreeUpMobileUtil> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 219 of 341 Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the ok. ResponseMessage String Nothing here Carriers XML Availables carriers to portin. EquipmentTypes XML Availables equipment. HandsetOs XML Availables hanset os. States XML All states of merchants Sample response: ISOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> is1:FreeUpMobileUtilResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <FreeUpMobileUtilResponse> <ResponseCode>0</ResponseCode> <ResponseMessage></ResponseMessagex Carriers><Carrier><ld>ATT</Id><Description>ATT</Description></Carrier> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 220 of 341 <Carrier><ld>SPRINT</Id><Description>SPRINT</Description></Carrier></Carriers: <EquipmentTypes> Equipment><ld>4GLTE</Id><Description>4GLTE</Description></Equipment><Equipment><l d>3G</Id><Description>3G</Description></Equipment><Equipment><ld>4GLTE</Id><Description>4 E</Description></Equipment> Equipment><ld>4GGSM</ld><Description>4GGSM</Description></Equipment><Equipment> ld>CDMA</Id><Description>CDMA</Description></Equipment><Equipment><ld>LTE</Id><Descripti n>LTE</Description></Equipment></EquipmentTypes> HandsetOs><Handset><ld>IOS</Id><Description>IOS</Description></Handset><Handset><l ANDROID</Id><Description>ANDROID</Description></Handset><Handset><ld>OTHER</ld><Des cription>OTHER</Description></Handset></HandsetOs> <States> <State><ld>AL</Id><Description>Alabama</Description></State> State><ld>AK</Id><Description>Alaska</Description></State> <State><ld>AS</Id><Description>AmericanSamoa</Description></State> State><ld>WY</ld><Description>Wyoming</Description></Statex ETC. </States> </FreeUpMobileUtilResponse>]]></return> </ns1:FreeUpMobileUtilResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 221 of 341 87. FreeUpMobileActivations This method allows doing Activate from FreeUp Mobile provider. Request Fields: Field Type Require Notes d version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. activationProductic String Yes FreeUp Mobile product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number carrier String Yes ATT or SPRINT activationCode Numeric This is a 7 or 9 digit activation code handsetOS String Yes The operating system of the handset IOS, ANDROID, OTHER iccid Numeric Optional ATT - required if not sending activationCode SPRINT - required if device is LTE and requires a SIM 20 digit ICCID value of the SIM card. Must be supplied for GSM activations unless activationCode is supplied. imei Numeric Optional ATT - required SPRINT N/A 15 or 16 digit IMEI of the handset. Must be supplied for GSM activations. meid Numeric Optional ATT N/A SPRINT - required 11 numerical digit (ESN) or 18 numerical digit (MEID) of the handset. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 222 of 341 zip Numeric Yes The zip code or Postal code that identifies the area for which to activate in. npa Numeric Optional ATT - optional if passed will be used to attempt to get an mdn with this area code SPRINT - N/A 3 digit NPA (area code) in which to activate the account. pin Numeric Optional The account PIN selected by the customer or will default to the last 4 digits of the phone number. pinProduct Numeric Yes Pin Product ID used to generate the pin redeem call. masterAccountEmail Email optional This is the main web account email to associate Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ kmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:FreeUpMobileActivations soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <version xsi:type="xsd:string">01</version> <siteld xsi:type="xsd:string">4083900</siteld> <clerkld si:type="xsd:string">56987 </clerkld> <activationProductld xsi:type="xsd:string">5137504</activationProductld> <languageld xsi:type="xsd:string">1</languageld> <invoiceNoxsi:type="xsd:string">3</invoiceNo> <carrier xsi:type="xsd:string">SPRINT</carrier> <activationCode xsi:type="xsd:string">1234567891223</activationCode: <handsetOS xsi:type="xsd:string">IOS</handsetOS> <iccid xsi:type="xsd:string"></iccid> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 223 of 341 <imei xsi:type="xsd:string">4579451265874894</imei <meid xsi:type="xsd:string">555568745879845784</meid> <zip xsi:type="xsd:string">92610</zip> <npa (si:type="xsd:string">345</npa> <pin xsi:type="xsd:string">23</pin> <pinProduct xsi:type="xsd:string">8000000 </pinProduct> <masterAccountEmail xsi:type="xsd:string">""dddd@eee.com</masterAccountEmail> </urn:FreeUpMobileActivations> </soapenv:Body> </soapenv:Envelope> Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. MIN String The activation phone number. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1: FreeUpMobileActivationsResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services": return xsi:type="xsd:string"><![CDATA[<FreeUpMobileActivations ><Version>01</Version> <ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessagex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 224 of 341 <min>456721289721212325890123</min> FreeUpMobileActivations >]]></return> </ns1 : FreeUpMobileActivations > </SOAP-ENV:Body> </SOAP-ENV:Envelopex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 225 of 341 88. FreeUpMobilePortin This method Initiate a port-in request, for a query status action make sure save the Prn returned tag value. Request Fields: Field Type Require Notes d version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. activationProductld String Yes Emida product Id identifier. languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number carrier String Yes ATT or SPRINT activationCode Numeric This is a 7 or 9 digit activation code handsetOS String Yes The operating system of the handset IOS, ANDROI, OTHER iccid Numeric Optional ATT - required if not sending activationCode SPRINT - required if device is LTE and requires a SIM 20 digit ICCID value of the SIM card. Must be supplied for GSM activations unless activationCode is supplied. imei Numeric Optional ATT - required SPRINT - N/A 15 or 16 digit IMEI of the handset. Must be supplied for GSM activations. meid Numeric Optional ATT N/A SPRINT - required 11 numerical digit (ESN) or 18 numerical digit (MEID) of the This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 226 of 341 handset. zip Numeric Yes Subscriber's zip code as provided to the previous carrier. pin Numeric Optional This is the 4 digit pin number to set on the account pinProduct Numeric Yes Pin Product ID used to generate the pin redeem call. masterAccountEmail Email optional This is the main web account email to associate. equipmentType String Yes The equipment type. Example Values: For ATT - 3G, 4GGSM, 4GLTE For Sprint- CDMA, LTE. agent String Yes Name of the agent initiating port. Example Value: GOOD2GO. mdn Numeric Yes Mobile Device Number for an existing subscriber. Example value: 6823090526. firstName String Yes Subscriber's first name as provided to the previous carrier. lastName String Yes Subscriber's last name as provided to the previous carrier. streetNumber Numeric Yes Street number of the subscriber's address as provided to the previous carrier. streetName String Yes Name of the street of the subscriber's address as provided to the previous carrier. city String Yes Subscriber's city as provided to the previous carrier. state String Yes Subscriber's state as provided to the previous carrier. contactEmail Email Yes Subscriber's email for notification. contactPhone Numeric Yes Subscriber's alternative phone number. ospAccount String Yes Subscriber's account number on the previous carrier. ospPassword String Yes Subscriber's account password on the previous carrier. Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance": xmlns:xsd= http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ kmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:FreeUpMobileActivations soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 227 of 341 <version xsi:type="xsd:string">01</versio <siteld xsi:type="xsd:string">4083900</siteld> <clerkld xsi:type="xsd:string">56987 </clerkld> <activationProductld Ixsi:type="xsd:string">8813411</activationProductld> <languageld xsi:type="xsd:string">1</languageld> <invoiceNo xsi:type="xsd:string">3</invoiceNo> <carrier xsi:type="xsd:string">SPRINT</carrier> <activationCode xsi:type="xsd:string">127891223</activationCode: <handsetOS xsi:type="xsd:string">IOS</handsetOS> <iccid xsi:type="xsd:string"></iccid> <imei xsi:type="xsd:string">4579451265874894</imei> <meid xsitype="xsd:string">555568745879845784</meid: <zip xsi:type="xsd:string">92610</zip> <pin xsi:type="xsd:string">3459</pin> <pinProduct si:type="xsd:string">8000000</pinProduct> <masterAccountEmail xsi:type="xsd:string">ffff@sss.com</masterAccountEmail: <equipmentType xsi:type="xsd:string">4GLTE</equipmentTypex <agent xsi:type="xsd:string">rerwe</agent> <mdn xsi:type="xsd:string">9874518970</mdn> <firstName xsi:type="xsd:string">nico</firstNamex <lastName xsi:type="xsd:string">romero</lastNamex <streetNumber xsi:type="xsd:string">34</streetNumber> <streetName xsi:type="xsd:string">rerer</streetNamex <city xsi:type="xsd:string">los angeles</city> <state xsi:type="xsd:string">LA</state> <contactEmail xsi:type="xsd:string">dddd@sss.com</contactEmail> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 228 of 341 <contactPhone xsi:type="xsd:string">45454564</contactPhone> <ospAccount xsi:type="xsd:string">45456456888</ospAccount> <ospPassword si:type="xsd:string">900001575</ospPassword> </urn:FreeUpMobileActivations> </soapenv:Body> </soapenv:Envelope> Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. Min Numeric The activation phone number. Prn Numeric Port request number. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> 1:FreeUpMobilePortinResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"><return xsi:type="xsd:string"> [CDATA[<FreeUpMobilePortinResponse> <ResponseCode>00</ResponseCode> <ResponseMessage>&lt;Font size= 1&gt;&It;p align=center&gt;&lt;fon class="receipt_product_name"&gt;CFE: $10.00&It;/font&gt;&lt;br&gt;&lt;br&gt;&lt;/p&gt;&lt;p align=justify&gt;&lt;font class="receipt_instructions"&gt;&lt;/font&gt;&lt;/p&gt;</ResponseMessagex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 229 of 341 <Min>6823090526</Min> <Prn>4567879</Prn> </FreeUpMobilePortinResponse>]]></return> </ns1:FreeUpMobilePortinResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 230 of 341 89. reeUpMobilePortinStatus This method gets information regarding a specific port-in request. The lookup can be done via MDN or via a Port Request Number (PRN). PRN usage is prefered. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. mdn Numeric Yes(If prn is empty) Mobile Device Number returned in a previous porti-in. prn Numeric Yes(If mdn is empty) Port request number (PRN). Example value: 13843878 languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd= "http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:FreeUpMobilePortinStatus soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">01</version> <siteld xsi:type="xsd:string">4083900</siteld> <clerkld xsi:type="xsd:string">56987 </clerkld> <mdn xsi:type="xsd:string">9874518970</mdn> <prn xsi:type="xsd:string">13843878</prn> </urn: FreeUpMobilePortinStatus > </soapenv:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 231 of 341 </soapenv:Envelope: Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Information taken from provider documentation SUBMITTED='S' Port has been submitted, and waiting for OSP response. 15-20 minutes after initial submittal, Vendor should send ACCOUNT_QUERY_PORTIN call. If S status returned, then MDN should be added to a port query queue at a longer 20-25 min interval. When a port moves to any of these status' : C, R, X, N, T, N, E, the MDN must be removed from the queue, and triaged/reclassified accordingly. This is a critical requirement, to limit unnecessary traffic and errors. No changes to port can be made to the port request in this status. DELAY='D OSP has not responded yet. CONFIRMED='C' Port is complete. RESOLUTION='R This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 232 of 341 OSP Information given is not correct. Validate info with customer/have customer call OSP to get correct info. Once updated info is received from customer, send ACCOUNT_UPDATE_PORTIN call, and then add MDN back to port query queue. REJECTED='X Port has been rejected. If this response is received again, the number cannot be ported. OPEN='O Port is currently in open status. CANCELED='Y' Port has been cancelled. Carrier will cancel a stagnant port 30 days from last stagnant status. If this happens, a new port must be submitted. CONFLICT='T Contact Ztar Tier3 support DENIED='N' Contact Ztar Tier3 support This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 233 of 341 ERROR='E' Port errored out, Contact Ztar Tier3 support. likely cause, SIM already used MIN String Empty. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> kns1:FreeUpMobilePortinStatusResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <FreeUpMobilePortinStatusResponse> <ResponseCode>00</ResponseCode> <ResponseMessage>S</ResponseMessage> <Min></Min></FreeUpMobilePortinStatusResponsex ]]></return> </ns1:FreeUpMobilePortinStatusResponsex </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 234 of 341 90. LocusActivateGSMAfCodePhoneBundle This method allows doing Activate a sim without a pin but afCode. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. siteld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. activationProductId String Yes Emida product identifier languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish invoiceNo String Yes Invoice number npa String Yes 3 digits afCode String Yes Activation Fast Code. city String Yes Old service provider Note: (Look list below) zip String Yes Zip where the activation is aplicable (Account ZIP) imei String Yes 15 digit IMEI of the handset. Must be supplied for GSM activations. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 235 of 341 Request Example ksoapenv:Envelope xmIns:xsi="http://www.W3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> urn:LocusActivateGSMAfCodePhoneBundle soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">01</version> <siteld xsi:type="xsd:string">4083900</siteld> <clerkld xsi:type="xsd:string">56987 </clerkld> <activationProductld xsi:type="xsd:string">5137504</activationProductld> <languageld xsi:type="xsd:string">1</languageld> <invoiceNo xsi:type="xsd:string">23</invoiceNo> <npa xsi:type="xsd:string">343</npa> <afCodexsi:type="xsd:string">565656</afCode> <city xsi:type="xsd:string">los angeles</city> p xsi:type="xsd:string">45454</zip> <imei xsi:type="xsd:string">436464645678765</imei> </urn:LocusActivateGSMAfCodePhoneBundle> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 236 of 341 Response Parameters The response will be a XML with the following tags. Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. Serial String Not useful MIN String The activation phone number. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"= <SOAP-ENV:Body> ins1:LocusActivateGSMAfCodePhoneBundleResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ActivateGSMAfCodePhoneBundleResponse> <Version>01 </Version> <ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage> <serial>23034434</serial> <min>456721289721212325890123</min> </ActivateGSMAfCodePhoneBundleResponse>]]></return> hs1:LocusActivateGSMAfCodePhoneBundleResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 237 of 341 </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 238 of 341 91. GetActivationDataBySIMNumber This method allows get activation data Request Parameters Parameter Tag Type Required Notes simNumber String Y SimNumber domain String Y Current web page Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmins:soapenv="http://schemas.xmlsoap.org/soap/envelope/" hIns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:GetActivationDataBySIMNumber soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <simNumber xsi:type="xsd:string">1234567890</simNumber= <domain xsi:type="xsd:string">domain.com</domain> </urn:GetActivationDataBySIMNumber> </soapenv:Body> </soapenv:Envelope> Response Parameters (Error Found) An array of 2 positions will be response if a bad process happened: Parameter Tag Type Notes String[0] String - Error (101, 102, 103, 104) String[1] String Short description of the error. 101 = Sim not found, or its basic data (productid or defaultSiteid) not found. 102 = sim products plan not found 103 = Clerkld not found 104 = User Login not found This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 239 of 341 Example: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ kmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" mlns:xsd="http://www.w3.org/2001/XMLSchema"> :SOAP-ENV:Body> <ns1:GetActivationDataBySIMNumberResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[2]" xmlns:ns2= "http://schemas.xmlsoap.org/soap/encoding/"> xsi:type="xsd:string">101</item> <item xsi:type="xsd:string">{SIM=SIM Number not found}</item> </return> </ns1:GetActivationDataBySIMNumberResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response Parameters (SIM number Found) An array of 8 positions will be response if a sim is found: Parameter Tag Type Notes String[0] String - Success code zero (0) String[1] String - Sim Iso String[2] String - Merchant Id String[3] String - Productld String[4] String - Default siteld String[5] String - JSON with products plan This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 240 of 341 String[6] String - Clerkld of default siteld String[7] String - Product pctermClass String[8] String - User Login String[9] String - Password login Example: <SOAP-ENV:Envelope xmlns:SOAP-ENV= "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"= <SOAP-ENV:Body> kns1:GetActivationDataBySIMNumberResponse SOAP-ENV:encodingStyle= http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1= = "urn:debisys-soap-services"> <return xsi:type="ns2:Array" ns2:arrayType="xsd:string[8]" xmlns:ns2= "http://schemas.xmlsoap.org/soap/encoding/"> <item xsi:type="xsd:string">0</item> <item xsi:type="xsd:string">4097542045654</item> <item xsi:type="xsd:string">628073142331 </item> <item xsi:type="xsd:string">9000903</item> <item xsi:type="xsd:string">2020061 </item> <item xsi:type="xsd:string">[{"amount":"30.0000", description "H2O $30 Monthly Unlimited", "id": "388013"}] </item> <item xsi:type="xsd:string">1234</item> <item xsi:type="xsd:string">net.emida.terminals.pc.ui.products.locus.SimLocusGSMSIM</item> <item xsi:type="xsd:string">userDG</item> <item ksi:type="xsd:string">1234567 </item> </return> </ns1:GetActivationDataBySIMNumberResponsex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 241 of 341 </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 242 of 341 92. GSSATTActivation This method allows doing Activate a SIM without a PIN. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld String Yes Terminal identifier for the Emida network. clerkld String Yes Clerk identifier for the Emida Network. productld String Yes Activation product identifier sim String Yes Suscriber identity module number customerZipCode String Yes ZIP code where the activation is applicable imei String No Optional. If included. Will perform an extra step to ensure that the product is available. areaCode String No Optional. It is used when there are multiple area codes associated with the specified zip code. invoice String Yes informational field languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 243 of 341 Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' :xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys -soap-services"> - <soapenv:Header/> <soapenv:Body> <urn:GSSATTActivation soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/": <version si:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">4083900</terminalId> <clerkId si:type="xsd:string">54322</clerkId> <productId xsi:type="xsd:string">8912809</productId> <sim xsi:type="xsd:string">152012369874512</sim> <imei xsi:type="xsd:string">152012369874512</imei> <customerZipCodexsi:type="xsd:string">10236</customerZipCode: <areaCode xsi:type="xsd:string">523</areaCode> <invoice xsi:type="xsd:string">1</invoice> <languageId xsi:type="xsd:string">1</languageId> urn:GSSATTActivation> </soapenv:Body> </soapenv:Envelope> Response fields Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. MIN String The activation phone number. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' kmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:GSSATTActivationResponse SOAP- NV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services" kreturn si:type="xsd:string"><![CDATA[<GSSATTActivationResponse><ResponseCode>00</ResponseCode: <ResponseMessage>TOPUP UCCESS</ResponseMessage><Min>6155565512</Min></GSSATTActivationResponse>]]></return> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 244 of 341 </ns1:GSSATTActivationResponse> </SOAP-ENV:Body> - (/SOAP-ENV:Envelope> - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 245 of 341 93. GSSATTPortin This method allows doing Portin without a PIN. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Activation product identifier phoneNumber Numeric Yes Mobile Device Number areaCode Numeric Yes It is used when there are multiple area codes associated with the specified zip code. customerZipCode Numeric Yes ZIP code where the activation is applicable sim Numeric Yes Suscriber identity module number firstName String Yes Customer's name lastName String Yes Customer's last name city String Yes Customer's city state String Yes Customer's state streetNumber Numeric Yes Customer's street Number streetName String Yes Customer's street name billingAccountNumber String Yes Account number billingAccountPassword String Yes Account password invoice String Yes informational field languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English,2 = Spanish This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 246 of 341 Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> Irn:GSSATTPortin soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">4083900</terminalId> <clerkId ssi:type="xsd:string">54322</clerkId> <productId si:type="xsd:string">8912810</productId> <phoneNumber xsi:type="xsd:string">5203124568</phoneNumber> <areaCode type="xsd:string">523</areaCode> <customerZipCodexsi:type="xsd:string">10236</customerZipCode> <sim isd:string">152012369874512</sim> <firstName si:type="xsd:string">Luis</firstName> <lastName (si:type="xsd:string">Avila</lastName> <city i:type="xsd:string">oklahom</city> <state xsi:type="xsd:string">TN</state> <streetNumber si:type="xsd:string">15</streetNumber> <streetName xsi:type="xsd:string">Londg</streetName> <billingAccountNumber xsi:type="xsd:string">15</billingAccountNumber> <billingAccountPassword xsi:type="xsd:string">5</billingAccountPassword: <invoice xsi:type="xsd:string">1</invoice> <languageId xsi:type="xsd:string">1</languageId> </urn:GSSATTPortin> </soapenv:Body> </soapenv:Envelope> Response fields Parameter Tag Type Notes ResponseCode String - Zero (0) if the porting was successful. Otherwise the error code. ResponseMessage String Short description of the process. MIN String Phone number. Sample response: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 247 of 341 <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> - <ns1:GSSATTPortinResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/' xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[ <GSSATTResponse> <resultstatus>o</resultstatus> ResponseCode>00</ResponseCode> ResponseMessage>&amp;lt;p align=center&amp;gt;&amp;lt;font class="receipt_product_name"&amp;gt;Amount $1.30&amp;lt;br&amp;gt;Date 9/11/2018 1:50:26 PM&amp;lt;br&amp;gt; &amp;lt;br&amp;gt;Carrier 2018&amp;lt;br&amp;gt; Product 09 amp;lt;br&amp;gt;Billing &amp;lt;br&amp;gt;Clerk clerk&amp;lt;br&amp;gt;SiteId 4083900&amp;lt;br&amp;gt;Merchant Name RJA&amp; lt; br&amp;gt; Congratulations and welcome to GSS Mobile!&amp;lt;/i&amp;gt;&amp;lt;/font&amp;gt;&amp;lt;p align=justify&amp;gt;&amp; lt; font class="receipt_instructions"&amp;gt;&amp;lt;b&amp;gt;&amp;lt;br&amp;gt;Visit GSS Mobile.com for more details.&amp;lt;br&amp;gt;Enjoy your services! &amp;lt;/b&amp;gt;&amp;lt;/font&amp;gt;&amp;lt;br&amp;gt;Phone Number 5203124568&amp;lt;br&amp;gt;Transaction ID: 218705746&amp;lt;/font&amp;gt;&amp;lt;/p&amp;gt; /ResponseMessage> <min>5203124568</min /GSSATTResponse>]]></return> /ns1:GSSATTPortinResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 248 of 341 94. getExecutionEnvironment The purpose of this method is to return a value configured in the database in order to know which environment is being used. This service will be used by Load Balancers to verify activity in the service, not only that the server is responding to the open port but transversal to the system. Request The service request has no parameters <soapenv:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:getExecutionEnvironment soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </soapenv:Body> </soapenv:Envelope> Response The service response returns a single value which represents the configured property. <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' kmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:getExecutionEnvironmentResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string">DEV</return> </ns1:getExecutionEnvironmentResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 249 of 341 95. Activation347 Request Fields: Field Type Required Notes Version String Yes Use default value 01 Site id String Yes Terminal identifier for the Emida network . If the [siteld] word "Test" is sent in this field, a dummy default response is returned. Language Id String Yes Single-digit number to indicate preferred [languageld] language for the response message. 1 = English 2 = Spanish Invoice Number String No Information field [invoiceNo] Clerk Id String Yes Clerk identifier for the Emida Network [clerkld] Activation Product Id Numeric String Yes Activation product identifier for the Emida network [activationProduct(d] ICCID Numeric String Yes Integrated Circuit Card Id, that's the sim card number to be used for activation. Zip Code String Yes Zip where the activation is applicable. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 250 of 341 Sample Request: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSche <soapenv:Header/: <soapenv:Body> <urn:Activate347 soapenviencodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">0l</version> <siteId asi:type="asd:string">9758219</siteId> <languageId (si:type="asd:string">l</languageId> <invoiceNo ssi:type="xsd:string">l</invoiceNo> <clerkId xsi:type="xsd:string">1234</clerkId> <activationProductIdxsi:type="asd:string">8958510</activationProductId> <iccid xsi:type="asd:string">8912489657841259741</iccid> <zipCode ssi:type="axsd:string">95648</zipCode> /urn:Activate347> /soapenv:Body> </soapenv:Envelope> <soapenv:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmIns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:Activate347 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version Ixsi:type="xsd:string">01</version> <siteld xsi:type="xsd:string">9758219</siteld> <languageld ksi:type="xsd:string">1</languageld> <invoiceNo xsi:type="xsd:string">1</invoiceNo> <clerkld type="xsd:string">1234</clerkld> <activationProductld xsi:type="xsd:string">8958510</activationProductld> <iccid xsi:type="xsd:string">8912489657841259741</iccid> <zipCode xsi:type="xsd:string">95648</zipCode> </urn:Activate347> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 251 of 341 Sample Response: <SOAP-ENV:Envelope - xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:Activate347Response SOAP ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"> <! [CDATA[ <Activate347Response> <Version>01</Version> esponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage <min>3246543654</min> </Activate347Response> ]]> </return> </ns1:Activate347Response> </SOAP-ENV:Body> - (/SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 252 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 253 of 341 96. GetPortinElegibility348 This call should be done before doing a portability call, in order to check if the portin is allowed. Request Fields: Field Type Required Notes Version String Yes Use default value 01 Site id String Yes Terminal identifier for the Emida network . If the [siteld] word "Test" is sent in this field, a dummy default response is returned. Language Id String Yes Single-digit number to indicate preferred [languageld] language for the response message. 1 = English 2 = Spanish Invoice Number String No Information field [invoiceNo] Clerk Id String Yes Clerk identifier for the Emida Network [clerkld] Portin Product Id Numeric String Yes Portin product identifier for the Emida network portinProductld] Msisdn Numeric String Yes Mobile Station Integrated Services Digital Network. [msisdn] Phone number to be ported. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 254 of 341 Sample Request soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 2 <soapenviHeader/> <soapenv:Body> irn:PortinElegibility348 soapenviencodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version asi:type="asd:string">0l</version> <siteId xsi:type="asd:string">9758219</siteId> <languageId si:type="asd:string">l</languageId> <invoiceNo xsi:type="asd:string">l</invoiceNo> <clerkId asi:type="asd:string">1234</clerkId> <portinProductId xsi:type="asd:string">8958510</portinProductId> <msisdn xsi:type="asd:string">1546549874</msisdn> /urn:PortinElegibility348> </soapenv:Body> </soapenv:Envelope> <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:PortinElegibility348 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <version xsi:type="xsd:string">01</version> <siteId xsi:type="xsd:string">9758219</siteId> <languageId xsi:type="xsd:string">1</languageId> <invoiceNo xsi:type="xsd:string">1</invoiceNo> <clerkId xsi:type="xsd:string">1234</clerkId> <portinProductId xsi:type="xsd:string">8958510</portinProductId> <msisdn xsi :type="xsd:string">1546549874</msisdn> urn:PortinElegibility348> /soapenv:Body> </soapenv:Envelope: Sample Response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns: sd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> - <ns1:PortinElegibility348Response SOAP ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[ <PortinElegibility348Response> <Version>01</Version> ResponseCode>0o</ResponseCode> (ResponseMessage>Success</ResponseMessagex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 255 of 341 /PortinElegibility348Response> ]]></return> </ns1:PortinElegibility348Response> </SOAP-ENV:Body> </SOAP-ENV:Envelopex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 256 of 341 97. Portin348 Request Fields: Field Type Required Notes Version String Yes Use default value 01 Site id String Yes Terminal identifier for the Emida network . If the [siteld] word "Test" is sent in this field, a dummy default response is returned. Language Id String Yes Single-digit number to indicate preferred [languageld] language for the response message. 1 = English 2 = Spanish Invoice Number String No Information field [invoiceNo] Clerk Id String Yes Clerk identifier for the Emida Network [clerkld] Portin Product Id Numeric String Yes Portin product identifier for the Emida network [portinProductId] ICCID Numeric String Yes Integrated Circuit Card Id, that's the sim card number to be used for activation. Zip Code String Yes Zip where the activation is applicable. Msisdn Numeric String Yes Mobile Station Integrated Services Digital Network. [msisdn] Phone number to be This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 257 of 341 ported. Account Number String Yes [accountNumber] Account Pin String Yes [accountPin] Sample Request: <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLScl <soapenv:Header/> <soapenv:Body> <urn:Portin348 soapenviencodingStyle="http://schemas.mmlsoap.org/soap/encoding/": <version type="asd:string">ol</version> <siteId xsi:type="asd:string">9758219</siteId> <languageId xsi:type="xsd:string">l</languageId> <invoiceNo xsi:type="asd:string">1232</invoiceNo> <clerkId i:type="asd:string">1234</clerkId> <portinProductId xsi:type="axsd:string">8958512</portinProductId: <iccid xsi:type="asd:string">6543574961921579548</iccid: <zipCode si:type="asd:string">9540</zipCode> <msisdn xsi:type="asd:string">82469875</msisdn> <accountNumber xsi:type="asd:string">17894</accountNumber> <accountPin "si:type="axsd:string">3579</accountPin> /urn:Portin348> </ /soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 258 of 341 <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns :xsd="http://www.w3.org/2001/XMLSchema" xmlns :soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:Portin348 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <version xsi:type="xsd:string">01</version> <siteId type="xsd:string">9758219</siteIdx <languageId xsi:type="xsd:string">1</languageIdx <invoiceNo xsi:type="xsd:string">1232</invoiceNo> <clerkId xsi:type="xsd:string">1234</clerkId> <portinProductId xsi:type="xsd:string">8958512</portinProductId> <iccid i:type="xsd:string">6543574961921579548</iccid) <zipCode xsi:type="xsd:string">9540</zipCode> <msisdn si:type="xsd:string">82469875</msisdn> <accountNumber xsi:type="xsd:string">17894</accountNumbery <accountPin xsi:type="xsd:string">3579</accountPin> </urn:Portin348> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 259 of 341 Sample Response Use re MNP code as reference for portin operations. <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:Portin348Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <Portin348Response> <Version>01</Version> ResponseCode>0o</ResponseCode> <ResponseMessage>Success</ResponseMessage> <MNPCode>3246543548</MNPCode> </Portin348Response> ]]></return> </ns1:Portin348Response> </SOAP-ENV:Body> - </SOAP-ENV: Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 260 of 341 98. GetActiveMessages This method allows to pull the available messages list. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. marca String Yes Product mark invoice String Yes informational field languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv: :Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns: xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys -soap-services" <soapenv:Header/> apenv:Body> <urn:GetActiveMessages soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <siteId xsi:type="xsd:string">5041432</siteId> <clerkId xsi:type="xsd:string">1234</clerkId> <marca (si:type="xsd:string">MobilMex</marca> <invoiceNo si:type="xsd:string">1</invoiceNo> <languageOption xsi:type="xsd:string">2</languageOption> /urn:GetActiveMessages> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 261 of 341 Response fields Parameter Tag Type Notes resultStatus String - Zero (0) if the porting was successful. Otherwise 1 ResponseCode String - Zero (00) if the porting was successful. Otherwise the error code. ResponseMessage String Available Messages in json format Sample response: GetActiveMessagesResponse> <resultstatus>o</resultstatus: <ResponseCode>00</ResponseCode> <ResponseMessage>{&quot;messages&quot;: [&quot C1 Edicion Maestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del ZuliaMaestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del ZuliaMaestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del Zulia&quot;, &quot; C2 Edicion Maestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del ZuliaMaestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del ZuliaMaestría en Computación Aplicada - Instituto de Cálculo Aplicado - Universidad del Zulia&quot; &quot; C3 Ingrese un asunto para una búsqueda rápida. Ingrese un asunto para una búsqueda rápida. Ingrese un asunto para una búsqueda rápida.&quot;]}</ResponseMessage: </GetActiveMessagesResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 262 of 341 99. PinDistSaleExtraData This method allows sale a topup passing third parties data Request Parameters Parameter Tag Type Requir Notes ed Version String Y 2-character request version indicator. Currently 01. SitelD String Y Between 5 and 9 digits. The siteID is the identifier for the merchant terminal in the Emida's system ClerkID String Y Between 1 and 9 digits. The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. ProductID String Y Between 4 and 9 digits. ProductID is the identifier for a product. (SKU) AccountID String Y Between 10 and 16 digits. AccountID provides the account number to which the TopUp / payment is applied. Amount String Y Amount indicates the money to be collected at the point of sale. It will be interpreted in local currency InvoiceNo String Y Between 1 to 9 digits. This is the transaction id of this request in the customer system (third one integrated). This parameter will be echoed in the response message. LanguageOption String Y Single-digit number to indicate preferred language for the response message. 1 = English 2 = Spanish externalTerminalld String Y Terminal from third parties externalTerminalType String Y Terminal type from third parties externalTerminalBalance String Y The terminal from third parties balance. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 263 of 341 Request parameters are sent as an XML string. A sample request is: <urn:PinDistsaleExtraData soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">2931883</terminalId> <clerkId (si:type="xsd:string">1234</clerkId> <productId si:type="xsd:string">2323</productId> <accountId xsi:type="xsd:string">31122445554</accountId> <amount xsi:type="xsd:string">20</amount> <invoiceNo xsi:type="xsd:string">123</invoiceNo> <languageOption isi:type="xsd:string">3</languageOption> <externalTerminalIo isi:type="xsd:string">aa22bb33</externalTerminalId> KexternalTerminalType si:type="xsd:string">caja</externalTerminalType> <externalTerminalBalance xsi:type="xsd:string">100</externalTerminalBalance> (/urn:PinDistsaleExtraData> Response Parameters Parameter Tag Type Notes Version String 2-character response version indicator. Currently 01. InvoiceNo String Invoice number echoed from request ResponseCode String 2-character field to indicate success or failure PIN String This parameter will echo the account number provided in the request ControlNo String Emida's internal control number CarrierControlNo String Serial number from provider CustomerServiceNo String Support toll-free number TransactionDateTime String Emida's transaction date & time ResponseMessage String Text to be displayed to the end user Transactionld String Emida's transaction reference number. Used for reconciliation purpose This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 264 of 341 <ns1 : PinDistsaleForPromotionsResponse SOAP- ENV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/' xmlns ns1= "urn:debisys-soap-services"> <return xsi:type="xsd:string"><! [CDATA[<PinDistSaleResponse> (PinDistsaleResponse> <Version>01</Version> <InvoiceNo>1234</InvoiceNo> <ResponseCode>00</ResponseCode> <PIN>13455456793</PIN> <ControlNo>-1</ControlNo> <CarrierControlNo>2438212</CarrierControlNox <CustomerServiceNo>2438212</CustomerServiceNo> ransactionDateTime>09/10/2018 13:17:44:002</TransactionDateTime <ResponseMessage>FLOW PHONE #: 13455456793 LOAD AMOUNT: USD1.00 TOTAL AMOUNT: USD1.00 TRANSACTION : 2438212 DATE : 09/10/2018 THANK YOU FOR CHOOSING FLOW! For balance inquiries dial *2273 Customer Care: 1 -800-804-2994 - </ResponseMessage> TransactionId>2438212</TransactionId PinDistSaleResponsex]]> </return> </nsl:PinDistsaleForPromotionsResponsel This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 265 of 341 100. CustomerDue352 This method allows to get the customers amount due for Free Up Ztar Mobile provider. Request Fields: Field Type Required Notes version String No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld String Yes Between 4 and 9 digits. Is the identifier for a product. accountld String Yes Between 10 and 16 digits. Provides the account number to which the TopUp / payment is applied. invoiceNo String Yes informational field languageld String Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" Ins:xsd="http://wWw.W3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> (urn:CustomerDue352 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <siteId :type="xsd:string">4083900</siteldx <clerkId i:type="xsd:string">56987</clerkIdx <productId xsi:type="xsd:string">9000902</productId> <accountId xsi:type="xsd:string">5868889760</accountId> <invoiceNo xsi:type="xsd:string">1</invoiceNo> <languageId xsi:type="xsd:string">1</languageIdx urn:CustomerDue352> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 266 of 341 Response fields Parameter Tag Type Notes ResponseCode String - Zero (00) if the porting was successful. Otherwise the error code. ResponseMessage String Error messages in some cases Min String Customer amount due Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" = xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> - <ns1:CustomerDue352Response SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return si:type="xsd:string"><![CDATA[<CustomerDue352Response><ResponseCode>0o</ResponseCode: <ResponseMessage>Success</ResponseMessage><Min>19.0</Min></CustomerDue352Response>]]></return> /ns1:CustomerDue352Response> </SOAP-ENV:Body> </SOAP -ENV:Envelopex - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 267 of 341 101. EquipmentValidation332 Is used to validate SIM status and ESN/Device ID Eligibility. API is required for all CDMA Activations ensure CDMA ESN. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Identifier of the product. productClass String Yes GSM : RedPocket AT&T, RedPocket T-Mobile CDMA : RedPocket Sprint, RedPocket Verizon. RPMU: RedPocket Universal Products esn String Y/N Required : If productClass = CDMA Optional : If productClass = GSM or any other sim Numeric Y/N Required : If productClass = GSM Optional : If productClass = CDMA or any other invoiceNo Numeric Yes Information about transaction languageld Numeric Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' :xsd="http://www.w3.org/2001/XMLSchema" imlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> - <soapenv:Header/> <soapenv:Body> <urn:EquipmentValidation332 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <version si:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">2687689</terminalId> <clerkId i:type="xsd:string">1234</clerkId> <productId si:type="xsd:string">8912811</productId> <productClass xsi:type="xsd:string">cdma</productClass This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 268 of 341 <esn xsi:type="xsd:string">AE12387</esn> <sim xsi: type="xsd:string"></sim> <invoice xsi:type="xsd:string">21213</invoice: <languageId si:type="xsd:string">2</languageId> </urn: EquipmentValidation332> </soapenv:Body> </soapenv:Envelope> Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful show a json schema with the following information : device type, product class and product code. Otherwise show the error message. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" mlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:EquipmentValidation332Response SOAP- ENV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return si:type="xsd:string"><![CDATA[<Response><resultStatus>o</resultStatus><ResponseCode>0o</ResponseCode ><ResponseMessage>{"DEVICE_TYPE":"LTE","PRODUCT_CLASS":"CDMA","PRODUCT_CODE":"CDMAV"}</ResponseMessag <</Response>]]></return> (/ns1:EquipmentValidation332Response> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 269 of 341 102. Activate332 The activate prepaid function is to activate a RedPocket GSM or CDMA subscriber using a plan. To do a correct activation is necessary to do a request to equipment validation method, because some parameters from activation are taken from response of that method. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Identifier of the product. deviceType String Yes Device taken from response of EquipmentValidation332 method. productClass String Yes Network taken from response of EquipmentValidation332 method. productCode String Yes Code taken from response of EquipmentValidation332 method. esn String Y/N Required : If productClass = CDMA Optional : If productClass = GSM or any other sim Numeric Y/N Required : If productClass = GSM Optional : If productClass = CDMA or any other planld String Yes The RTR Plan for first month of service. In the below table you will find the plan list. iccld Numeric Y/N Required : If productClass is GSM Required : If productClass is CDMA and device type is LTE Optional : If productClass is CDMA and device type is 3G email String N Email address for Subscriber serviceZip Numeric Y Service ZIP code for number assignment firstName String N First Name of Subscriber lastName String N Last Name of Subscriber This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 270 of 341 address String N Home Address of Subscriber city String N Home city of Subscriber state String N Home state of Subscriber zipCode Numeric N Home Zipcode of Subscriber homePhone Numeric N Alternative Phone Number of Subscriber sendEmail Numeric N 1 or 0 (To send Welcome email to Subscriber) invoiceNo Numeric Yes Information about transaction languageld Numeric Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish The following table shows the available plan ids. PLAN ID VALUE Description B025RPMUz $25.00 $25.00 30 Day Activation MBB Plan. B050RPMUz $50.00 $50.00 30 Day Activation MBB Plan M010RPMUz $10.00 $10-30 Day Activation Plan M020RPMUz $19.99 $19.99 30 Day Activation Plan M025RPMUz $24.99 $24.99 30 Day Activation Plan M030RPMUz $29.99 $29.99 30 Day Activation Plan M045RPMUz $45.00 $45.00-30 Day Activation Plan M060RPMUz $59.99 $59.99 : 30 Day Activation Plan P010RPMUz $10.00 PayGo $10 Activation Plan P025RPMUz $25.00 PayGo $25 Activation Plan P050RPMUz $50.00 PayGo $50 Activation Plan P100RPMUz $100.00 PayGo $100 Activation Plan This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 271 of 341 Sample Request <soapenv:Envelopexmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:Activate332 soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version be="xsd:string">1</version> <terminalId xsi:type="xsd:string">2687689</terminalId> <clerkId xsi:type="xsd:string">1234</clerkId> <productId xsi:type="xsd:string">8912811</productId> <deviceType i:type="xsd:string"></deviceTypex <productClass xsi:type="xsd:string">gsm</productClass> <productCode xsi:type="xsd:string">gsmt</productCode> <esn ksi:type="xsd:string"></esn> <sim i:type="xsd:string">10236587897</sim> <planId ssi:type="xsd:string">p025rpmuz</planId> <iccId ssi:type="xsd:string">5820369412036589754110</iccId> <email si:type="xsd:string">test@test.com</email> <serviceZip xsi:type="xsd:string">5698740</serviceZip> <firstName xsi:type="xsd:string">Test </firstName> <lastName xsi:type="xsd:string">Te: Test</lastName> <address xsi:type="xsd:string">Street 12 # 34</address> <city ksi:type="xsd:string">New York</city> <state type="xsd:string">NA</state> <zipCode xsi:type="xsd:string">10400</zipCodex <homePhone ksi:type="xsd:string">12065877</homePhone> <sendEmail xsi:type="xsd:string">1</sendEmail> <invoice :type="xsd:string">212134</invoicex <languageId xsi:type="xsd:string">2</languageId> </urn:Activate332> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 272 of 341 Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a message previously configured in terminal response. If not exists shows a success message. Otherwise shows a short error description. Min Numeric If the transaccion was successful shows subscriber msisdn Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:Activate332Response SOAP -ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return si:type="xsd:string"><![CDATA[<Response><resultstatus>o</resultStatus><ResponseCode>00</ResponseCode <ResponseMessage>RedPocketPort complete and phone is activeAmount: $20.00 Phone 6663209Trx: 218706444</ResponseMessage><min>6663209</min></Response>]]></return> </ns1:Activate332Response> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 273 of 341 103. Portin332 Portin332 allows doing Portin with a RTR plan. To do a correct portin is necessary to do a request to equipment validation method, because some parameters from portin are taken from response of that method. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Identifier of the product. deviceType String Yes Device taken from response of EquipmentValidation332 method. productClass String Yes Network taken from response of EquipmentValidation332 method. productCode String Yes Code taken from response of EquipmentValidation332 method. iccld Numeric Y/N Required : If productClass is GSM Required : If productClass is CDMA and device type is LTE Optional : If productClass is CDMA and device type is 3G esn String Y/N Required : If productClass = CDMA Optional : If productClass = GSM or any other planld String Yes The RTR Plan for first month of service. In the below table you will find the plan list. portinIndCheck Numeric No Portins pass through value= 1 portinCurrCarrier String No Current Wireless Carrier from list : ATT, MetroPCS, T-Mobile, Sprint, Verizon, Other currCarrierOther String Y/N If portinCurrCarrier is Other then carrier name must be entered. portinNumToPort Numeric Yes 10 Digit Wireless Number for portin activation portinAccountNumber Numeric Yes Account Number with current Wireless Carrier This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 274 of 341 portinAccountPassworo String Yes Account Password with current Wireless Carrier serviceZip Numeric No Service ZIP code for number assignment portinTitle String No Values= Mr, Mrs, or Ms portinFirstName String Yes First Name associated with current Wireless Carrier portinLastName String Yes Last Name associated with current Wireless Carrier portinMi String No Middle Initial associated with current Wireless Carrier portinSnNum String No SSN# associated with current Wireless Carrier portinAddress String Yes Address associated with current Wireless Carrier portinCity String Yes City associated with current Wireless Carrier portinState String Yes State associated with current Wireless Carrier portinZip String Yes Zip Code associated with current Wireless Carrier portinEmail String No Email associated with current Wireless Carrier invoice String Yes Information about transaction languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish The following table shows the available plan ids. PLAN ID VALUE Description B025RPMUz $25.00 $25.00 30 Day Activation MBB Plan. B050RPMUz $50.00 $50.00 30 Day Activation MBB Plan M010RPMUz $10.00 $10- 30 Day Activation Plan M020RPMUz $19.99 $19.99 30 Day Activation Plan M025RPMUz $24.99 $24.99 30 Day Activation Plan This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 275 of 341 M030RPMUz $29.99 $29.99 30 Day Activation Plan M045RPMUz $45.00 $45.00-30 Day Activation Plan M060RPMUz $59.99 $59.99 30 Day Activation Plan P010RPMUz $10.00 PayGo $10 Activation Plan P025RPMUz $25.00 PayGo $25 Activation Plan P050RPMUz $50.00 PayGo $50 Activation Plan P100RPMUz $100.00 PayGo $100 Activation Plan Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> kurn:Portin332 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <version xsi:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">2687689</terminalId> <clerkId :type="xsd:string">1234</clerkId> <productId si:type="xsd:string">8912811</productId> <deviceType :type="xsd:string">3g</deviceType <productClass si:type="xsd:string">gSM</productClass> <productCode xsi:type="xsd:string">cdmas</productCodex <iccId xsi: type="xsd:string">44444444444444444444</iccId: <esn ype="xsd:string">555555555555555</esn: <planId xsi:type="xsd:string">P010RPMUZ</planId> <portinIndCheck xsi:type="xsd:string"></portinIndCheck> <portinCurrCarrier xsi:type="xsd:string">OTHER</portinCurrCarriery <currCarrierOther ksi:type="xsd:string">Vodafone</currCarrierOthery <portinNumToPort si:type="xsd:string">1234234</portinNumToPort> <portinAccountNumber xsi:type="xsd:string">123123123</portinAccountNumber> <portinAccountPasswordxsi:type="xsd:string">pass1231</portinAccountPassword> <serviceZip xsi:type="xsd:string">10011</serviceZip> <portinTitle xsi:type="xsd:string">Mr</portinTitle> <portinFirstName ksi:type="xsd:string">Test</portinFirstName> <portinLastName si:type="xsd:string">Test</portinLastName> <portinMi ksi:type="xsd:string">Son</portinMi> <portinSnNum xsi:type="xsd:string">123123</portinSnNum> <portinAddress xsi:type="xsd:string">Street4 # 12</portinAddress> <portinCity si:type="xsd:string">New York</portinCity> <portinState si:type="xsd:string">NA</portinState> <portinZip (si:type="xsd:string">123</portinZip> <portinEmail xsi:type="xsd:string">test@test.com</portinEmail> <invoice ype="xsd:string">1111</invoice> <languageId xsi:type="xsd:string">1</languageId> </urn:Portin332> </soapenv:Body> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 276 of 341 </soapenv:Envelope> Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a message previously configured in terminal response. If not exists shows a success message. Otherwise shows a short error description. Min Numeric If the transaccion was successful shows subscriber msisdn Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:Portin332Response SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<Response><resultStatus>o</resultStatus><ResponseCode>00</ResponseCode 18706448</ResponseMessage><min>6914073</min></Response>]]></return: </ns1:Portin332Response> </SOAP-ENV:Body> </SOAP -ENV:Envelope: - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 277 of 341 104. Get Terminal Transactions Compact Report This call allows to get the terminal transactions using a date interval Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. startDate Date Yes Use format yyyy-MM-dd Hhmmss compressed, no separators yyyyMMddHHmmss endDate String Yes Use format yyyy-MM-dd Hhmmss compressed, no separators yyyyMMddHHmmss PhoneNumber Numeric Yes Phone number for which transaction list is going to be retrieved. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" lns:xsd="http://www.w3.org/2001/XMLSchema" Ins:soapenv="http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:getTerminalTransactionsCompact soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">01</version> <siteId xsi:type="xsd:string">9758219</siteId> <clerkId xsi:type="xsd:string">1234</clerkId> <startDate (si:type="xsd:string">2019-01-24 00:00:00</startDate> <endDate si:type="xsd:string">2019-01-26 00:00:00</endDate> <phoneNumber xsi:type="xsd:string">3004005001</phoneNumber> <language xsi:type="xsd:string">1</language> /urn:getTerminalTransactionsCompact> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 278 of 341 <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> turn:getTerminalTransactionsCompact soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <version (si:type="xsd:string">01</version> <siteId xsi:type="xsd:string">9758219</siteId> <clerkId xsi:type="xsd:string">1234</clerkId> <startDate xsi:type="xsd:string">2019-01-24 00:00:00</startDate> <endDate ksi:type="xsd:string">2019-01-26 00:00:00</endDate> <language xsi:type="xsd:string">1</languagex urn:getTerminalTransactionsCompact> </soapenv:Boc </soapenv:Envelope> Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String Encoded JSON array with the corresponding records or the error message in case of failure. Sample response: <?xml version="1.0" encoding="UTF-8" standalone="no"?> TerminalTransactionsCompactResponseTag> <ResponseCode>00</ResponseCode> ResponseMessage>%5B%7B%22amount%22%3A10.0000%2C%22datetime%22%3A%222019-01-24+17%3A34%3A03.467%22%2C%22phoneNumbery 24+17%3A36%3A35.893%22%2C%22phoneNumber%22%3A%226302615772%22%2C%22productId%22%3A6519017%2C%22transactionId%22%3A2 TerminalTransactionsCompactResponseTag> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 279 of 341 JSON example: [{ "amount": 10.0000, [{ "amount": 10.0000, "datetime": "2019-01-24+17:34:03.467" "datetime": "2019-01-24+17:34:03.467", "phoneNumber": "6302615772", "phoneNumber" : "6302615772", "productId": 6519017, "productld": 6519017, "transactionId": 218706547 "transactionId": 218706547 }, { { "amount": 10.0000, "amount": 10.0000, "datetime": "2019-01-24+17:36:22.563" "datetime' "2019-01-24+17:36:22.563", "phoneNumber": "6302615772", "phoneNumber": "6302615772", "productId": 6519017, "productld" 6519017, "transactionId": 218706548 "transactionId": 218706548 }, { }, { "amount": 10.0000, "amount": 10.0000, "datetime": "2019-01-24+17:36:35.893", "datetime" "2019-01-24+17:36:35.893", "phoneNumber": "6302615772", "phoneNumber": "6302615772", "productId": 6519017, "productld": 6519017, "transactionId": 218706549 "transactionId" 218706549 }, { { "amount": 10.0000, "amount": 10.0000, "datetime": 2019-01-24+17:36:40.267" "datetime": "2019-01-24+17:36:40.267", "phoneNumber": "6302615772", "phoneNumber": "6302615772", "productId": 6519017, "productld": 6519017, "transactionId": 218706550 "transactionId": 218706550 }] This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 280 of 341 105. GetProductListDetailed Get all available products on the rate plan, but with detailed fields that provide extended information about the products Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> kurn:GetProductlistDetailed soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">5041432</terminalID <languageId xsi:type="xsd:string">2</languageId> n:GetProductlistDetailed> </soapenv:Body> </soapenv:Envelope: Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a Json enclosed list with all products with all the detailed fields This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 281 of 341 Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" mlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> - ins1:GetProductListDetailedResponse SOAP - ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys -soap-services" " <return xsi: :type="xsd:string"><![CDATA[<Response><resultStatus>o</resultstatus><ResponseCode>00</ResponseCode ><ResponseMessage>{"products":[ { "amount":"0.0000", "carrierID": "41", "carrierName": "- - Test", "categoryDescription" "TOP UP", "categoryId": "1", "maxAmount" : "70.0000", "minAmount": "1.0000", "productDescription": "Debisys FLEX (Test TopUp) "productId" "7000", "regulatoryFee": "0.0000" }, { "amount": "0.0000", "carrierID": "112", "carrierName" "...Card Swipe", "productDescription": "Card Swipe "productId" "1000000", "regulatoryFee": "0.0000" },}</ResponseMessage></Response>]]></return> hs1:GetProductListDetailedResponsex </S0AP-ENV:Body> </SOAP-ENV:Envelopex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 282 of 341 106. SwapEquipment349 This method is used when customers with active phones either need to move their SIM card to a new phone, swap out the SIM card in their existing phone, or move their service to a different phone with a different SIM. Swapping out a SIM is a change in the SIM number, putting the existing SIM in a new phone is a change of the IMEI, and changing service to a new phone and a new SIM is a change of both SIM and IMEI at the same time. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Identifier of the product. sim Numeric Y/N Required: If not exists a IMEI number phoneNumber Numeric Yes Mobile Device Number. imei Numeric Y/N Required: If not exists a sim number invoice String Yes Information about transaction languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services": <soapenv:Header/> <soapenv:Body> <urn:SwapEquipment349 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <version xsi:type="xsd:string">1</version> <terminalId xsi:type="xsd:string">5041432</terminalId> <clerkId si:type="xsd:string">1234</clerkId> <productId :type="xsd:string">8957622 </productId <sim xsd:string">1020362147523014785</sim> <phoneNumber xsi:type="xsd:string">1020365471</phoneNumber> <imei xsi:type="xsd:string">222222222222222</imei> <invoice xsi:type="xsd:string">123123</invoice> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 283 of 341 <languageId xsi:type="xsd:string">2</languageId> </urn:SwapEquipment349> </soapenv:Body> </soapenv:Envelope> Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a success message, or a configured message as shown below. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:SwapEquipment349Response SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap services"> <return xsi:type="xsd:string"><![CDATA[<Response><resultstatus>o</resultsStatus><ResponseCode>00</ResponseCode ><ResponseMessage>SwapEquipmentTransaction # 2521886132/25/20195:30:05 PMHAVE A NICE DAY!</ResponseMessage></Response>]]></return> </ns1:SwapEquipment349Response </SOAP-ENV:Body> </SOAP-ENV:Envelopex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 284 of 341 107. InquirePort349 This method is used after a successful reply to porting a phone. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. Reserved for future use. terminalld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. productld Numeric Yes Identifier of the product. portRequestNumbe Numeric Yes Number to port. phoneNumber Numeric Yes Mobile Device Number. invoice Numeric Yes Information about transaction languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance - xmlns:xsd="http://www.w3.org/2001/XMLSchema" = xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys -soap-services"> <soapenv:Header/> <soapenv:Body: <urn:InquirePort349soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <version xsi:type="xsd:string">1</version> <terminalId (si:type="xsd:string">5041432</terminalI <clerkId xsi:type="xsd:string">1234</clerkId> <productId xsi:type="xsd:string">8957623</productId> <portRequestNumber xsi:type="xsd:string">1111111111111111</portRequestNumber <phoneNumber xsi:type="xsd:string">1020365471</phoneNumber> <invoice type="xsd:string">123123</invoice> <languageId d xsi:type="xsd:string">2</languageId> </urn:InquirePort349> </soapenv:Body> /soapenv:Envelope: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 285 of 341 Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a success message, or a configured message as shown below. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> = <SOAP-ENV:Body> <ns1:InquirePort349Response SOAP- NV:encodingstyle="http://schemas.xmlsoap.org/soap/encoding, xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[<Response><resultStatus>o</resultStatus><ResponseCode>00</ResponseCode ResponseMessage>InquirePortTransaction # 2521886192/26/2019 10:31:21 AMHAVE A NICE DAY!</ResponseMessage></Response>]]></ret </ns1:InquirePort349Response> </SOAP-ENV:Body> (/SOAP -ENV:Envelope: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 286 of 341 108. executeCommand This method allows execute any current webservices method. It will also execute new soap methods develop since now Request Parameters Parameter Tag Type Required Notes command String Y Soap Method parameters String Y JSON String with all parameters that you need Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services": <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">BeanExampleService</command: <parameters xsi:type="xsd:string"> { "millennium no" "1234567", "merchant_id":1234567890, "clerk":1234, "myArray":[ "Mazda", "BMW", "Ford" 13 </parameters> /urn:executeCommand> </soapenv:Body> /soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 287 of 341 New Methods Response An String will be response: Parameter Tag Type Notes String String String with all information that the method will return. Inside this return all result code, messages xml metadata. according the method return Examples: (Method not found) <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1: executeCommandResponse SOAP-ENV:encodingStyle= "http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1= "urn:debisys-soap-services": - <return xsi:type="xsd:string"><![CDATA[<code>2</code><message>No command named (BeanExampleService1) is defined</message><data></data>]]></return> </ns1:executeCommandResponse> /SOAP-ENV:Body> </SOAP-ENV:Envelope> (Method found) <SOAP -ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:executeCommandResponse SOAP-ENV:encodingStyle= "http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> = - <return xsi:type="xsd:string">This is a example (SoapFunctionExample) with Json Parameters[ { "millennium_no":"1234567","merchant_id":1234567890,"clerk":1234, 'myArray" [ "Mazda", "BMW", "Ford" ] } ]</return> /ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 288 of 341 109. executeCommandHelp This method allows to know the parameters of a specific method (old or new). In Old methods you can see the parameters types. In New methods you can see a short description about it. Request Parameters Parameter Tag Type Required Notes command String Y Soap Method to get information Example <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> kurn:executeCommandHelp soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <commandxsi:type="xsd:string">Login2</command> urn:executeCommandHelp> </soapenv:Body> </soapenv:Envelope> Response Old Method (SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ins:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:executeCommandHelpResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string">Soap Services Method (Login2) with parameters: [java.lang.String,java.lang.String,java.lang.String,java.lang.String]</return> </ns1:executeCommandHelpResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 289 of 341 An String will be response: Parameter Tag Type Notes String String String with all information about the specific method. Response New Method <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:executeCommandHelpResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1=" unn:debisys-soap- services": <return ksi:type="xsd:string">In order to use this function, please send a array String[2] with values [0]=amount, [1]=terminalid</return> </ns1:executeCommandHelpResponse> </SOAP-ENV:Body> - </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 290 of 341 110. executeCommandAllList This method returns all new methods name executed through of the 'executeCommand" function. Request Parameters Parameter Tag Type Required Notes NO No parameters Example <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommandAllList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/> </soapenv:Body> </soapenv:Envelope> Response <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:executeCommandAllListResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap services"> <return si:type="xsd:string">prasanPreAuthorizationService,BeanExampleService</return> </ns1:executeCommandAllListResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelopex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 291 of 341 111. GSSInquireSubscriberStatus This service method provides a given phone number is active on GSS cellular network. The service method uses the service executeCommand (See 108. executeCommand section). The parameters required to retrieve the status are: Index Parameter Description order 1 siteld Id of the Web Service terminal. Numeric characters 2 Clerkld Clerk Id that is authorized to execute the action. Numeric characters. 3 Invoiceld TransactionId that is generated by the provider. Numeric characters 5 SubscriberNumber It is the phone number to retrieve the status against the cellular network. Numeric characters. Response The response is an xml string which contains the attributes of the phone number. <ServiceStatus>Inactive</ServiceStatus> <FirstName>Joe</FirstNamex <LastName>Jones</LastName> <Address>123 Main</Address> <City>Nashville</City> <State>TN</State> <Zip>37205</Zip> <Features>feature1,feature2</Features> <BillingMarket>CBD</BillingMarket> <BillingSubmarket>XAC</BillingSubmar <PricePlan>AT&T RTR $35</PricePlan> <ActivationDate>2014-10-22Z</ActivationDatex <SubscriberStatus>A</SubscriberStatus> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 292 of 341 112. executeCommand - prasanPreAuthorizationServic Method to do the prevalidation of the phone numbers when an IMTU is doing developed through a Webservice terminal Request Parameters Parameter Tag Type Required Notes command String Y prasanPreAuthorizationService parameters String Y { "version":"1 "terminalld"."9415754" " 'product(d":"8000" "accountld":"3195885982", "amount":"10", "invoiceNo":"123" "language":"1' "clerkld":"1234" "countryDialingCode"."5 Request Example <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <ns1:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" Ins:ns1="urn:debisys-soap-services"> <command Ixsi:type="xsd:string">prasanPreAuthorizationService</command <parameters xsi:type="xsd:string">{"version":"1","terminalld":"54321","productId":"10001","accountId":"3195885982",' = "a mount": 10", "invoiceNo":"123","language":"1","clerkld":"1234","countryDialingCode":"57"}</parameters> </ns1:executeCommand> </soapenv:Body> </soapenv:Envelope> Respose Parameters This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 293 of 341 Parameter Tag Type Notes String String String with JSON structure { "code":"00". "message":"OK" } { "code":"51", "message": "INVALID SITE ID" } code = 00 Phone number is valid code != 00 Phone number is invalid Response Example <SOAP-ENV:Envelope kmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> <ns1:executeCommandResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string">{"code":"10","message":"INVALID SITE-ID"}</return> </ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 294 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 295 of 341 113. executeCommand - ProductFlowlnfoService To describe the parameters according product for integrated clients that must paint on their screen flows for TopUp and BillPayment Request Parameters Parameter Tag Type Required Notes command String Y ProductFlowlnfoService parameters String Y { "productId":"optional", "version":"1" "terminalld":"40839005", "invoiceNo":"123", "language":"1" "clerkld":"56987" } Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" kmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommandsoapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">ProductFlowlnfoService</command> <parameters xsitype="xsd:string"> "productId":"8813416", "version' ":"1", "terminalld":"4083900", "invoiceNo":"123", "language":"1" "clerkld":"56987"}</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 296 of 341 Respose Parameters Parameter Tag Type Notes String String When fail <SOAP-ENV:Envelope xmlns:SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> ns1:executeCommandResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<ProductFlowlnfoServiceRespons (ex<Version>1</Version><ResponseCode>10</ResponseCode>- ResponseMessage>INVALID SITE- D</ResponseMessage></ProductFlowlnfoServiceResponse>]]></r eturn> </ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response Example FOR 2 products billpayment and topup: <?xml version="1.0" encoding="UTF-8"?: <ProductFlowlnfoServiceResponse> ersion>1</Version> <ResponseCode>00</ResponseCodex <ResponseMessage> <Products> <Product> <ProductCategory>BILL PAYMENT</ProductCategory> <CarrierName>Emida Cash And Transact</CarrierName> <Productld>8955911</Productld> <NameProduct>BillPaymentMX</NameProduct: <ProductUFee>0.2000</ProductUFee> <CurrencyCode>USD</CurrencyCode: <Amount>0</Amount mountMin>1.0000</AmountMin> <AmountMax>5.2000</AmountMax <PaymentTypeTotal-Parcial-Vencidos</PaymentTypex ProductSubCategory>Bill Payment</ProductSubCategory> <ReferenceParameters> <Reference1> <ReferenceName>Accountnumber</ReferenceName: <FieldType>NM</FieldType> <LengthMin>12</LengthMin> <LengthMax>12</LengthMax> <Prefix>NA</Prefix> <ToolTip>Numero de Cuenta a 12 Digitos</ToolTip> <URLImage 1> <ExtraReference1> <Mandatory>NO</Mandatory> <ReferenceName>Customer number</ReferenceName This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 297 of 341 FieldType>AN</FieldTypex <LengthMin>5</LengthMin> <LengthMax>5</LengthMax> <Prefix>#</Prefix> ToolTip>Enter the customernumber</ToolTip> <URLImage 1> </ExtraReference1> </Reference1> <Reference2> <ReferenceName>AAAAAAA</ReferenceName> <FieldType>AN</FieldType> <LengthMin>9</LengthMin> <LengthMax>9</LengthMax> <ToolTip>Accountstatus 9 letters and numbers</ToolTip> <URLImage/> <Mandatory>NO</Mandatory> </Reference2> </ReferenceParameters> Product> Product> <ProductCategory>RTR</ProductCategory> CarrierName>TMobile TopUp</CarrierName> <Productld>8813416</Productld> <NameProduct>T-Mobile TopUp $15</NameProduct> ProductUFee>0.0000</ProductUFee> <CurrencyCode>USD</CurrencyCode> <Amount>15.0000</Amount> <AmountMin>0</AmountMin> <AmountMax>0</AmountMax> PaymentType>Total-Parcial-Vencidos</PaymentType> <ProductSubCategory>Balance TAE</ProductSubCategory <ReferenceParameters> <Reference1> <ReferenceNamexTelce Sin Limite 50 = 7 days 300 MB data + WhatsApp minutes and unlimited sms + 500 MB Twitter Facebook Instagram and Snapchat</ReferenceName> <FieldType>NM</FieldTypex LengthMin>12</LengthMin> <LengthMax>12</LengthMax> <Prefix>NA</Prefix> <ToolTip 1> <URLImage 1> <ExtraReference1> <Mandatory>NO</Mandatory> </ExtraReference1> </Reference1> /ReferenceParameters> /Product> <Product> <ProductCategory>BILI PAYMENT</ProductCategory> <CarrierName>Emida Cash And Transact</CarrierName> <Productld>8955911</Productld: <NameProduct>BillPaymentMX</NameProdu <ProductUFee>0.2000</ProductUFee> <CurrencyCode>USD</CurrencyCodex <Amount>0</Amount> <AmountMin>1.0000</AmountMin> <AmountMax>5.2000</AmountMax> aymentType>Total-Parcial-Vencidos</PaymentType> <ProductSubCategory>Bill Payment</ProductSubCategory> <ReferenceParameters> <Reference1> ReferenceName>Accountnumber</ReferenceName> <FieldType>NM</FieldType> <LengthMin>12</LengthMin> <LengthMax>12</LengthMax> <Prefix>NA</Prefix> <ToolTip>Numero de Cuenta a 12 Digitos</ToolTip> <URLImage/ 1> <ExtraReference1> <Mandatory>NO</Mandatory> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 298 of 341 <ReferenceName>Customernumber</ReferenceNamex <FieldType>AN</FieldType> <LengthMin>5</LengthMin> <LengthMax>5</LengthMax> <Prefix>#</Prefix> <ToolTip>Enter the customer number</ToolTip> <URLImage 1> </ExtraReference1> </Reference1> <Reference2> <ReferenceName>AAAAAAA</ReferenceName> <FieldType>AN</FieldType> <LengthMin>9</LengthMin> <LengthMax>9</LengthMax> <ToolTip>Accountstatus 9 letters and numbers</ToolTip> <URLImage 1> <Mandatory>NO</Mandatory> </Reference2> </ReferenceParameters> Product> 'roducts> /ResponseMessage> /ProductFlowInfoServiceResponsex This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 299 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 300 of 341 114. Get Today's Summary Report This call allows to get today's transactions for the terminal and clerk passed as parameters. Request Fields: Parameter Type Required Notes reportCode String Yes getTodaysSummaryReport version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv Envelope xmlns XS1= "http://www.w3 .org/2001/XMLSchema-instance' Ins xsd= http://www.w3.org/2001/XMLSchema" Ins soapenv= http://schemas soap.org/soap/envelope/" mlns urn= urn debisys-soap services <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command XS1 :type= xsd:string >AdministrativeReport</command> <parameters xsi: type= xsd:string" >{ "reportCode":"getTodaysSummaryReport" "version" :"01", "terminalId" "9758219", "clerkId" '1234", "language" "1" }</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope <<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ xmlns:urn="urn:debisys-soap-services"> soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/ <command xsi:type="xsd:string">AdministrativeReport</command> <parameters xsi:type="xsd:string"> "reportCode" : getTodaysSummaryReport". "version": "01","terminalId":"9758219", "clerkId":"1234", "language": "1" }</parameters> urn:executeCommand> </soapenv:Body> /soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 301 of 341 Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. Sample response: <?xml version= 1.0" encoding= UTF-8' standalone= "no"?> TTodaysSummaryReportResponse> <ResponseCode>00</ResponseCode> <ResponseMessage>{"reportName "DAILY SUMMARY REPORT' "columnNames":["Count"."Category"."Collected"."Profit"]."records":[{"categorycount":"5" </TodaysSummaryReportResponse> L "reportName "DAILY SUMMARY REPORT", "columnNames": [ "Count", "Category", "Collected", "Profit" 1, "records": "categoryCount":"5"= "collected":"50", "category":"Test", "profit": "0" }, { "categoryCount":"4 "collected":"40", "category":"Topup", "profit":"0.32" }, { "categoryCount":"11 "collected":"26,850.88", category":"Wireless", "profit":"1,327.55" } 1, "totals":{ "count":{ "label":"Total Count", "value":"119" }, "collected":{ "label":"Less Profit", "value":"0" }, "totalCost": "label":"Total Cost", "value":"0" } } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 302 of 341 115. Get Monthly Summary Report This call allows to get monthly transactions for the terminal and clerk passed as parameters. Monthly means from the current month first day to the current date. Request Fields: Parameter Type Required Notes reportCode String Yes getMonthlySummaryRepor version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv: Envelope Ins:XS1= http://ww org/2001/ Schema- instance" Ins xsd="http://www.w3.org/2001/XMLSchema' Lns :soapenv= "http://schemas soap.org/soap/envelope/" xm Lns :urn= urn: debisys soap services"> <soapenv:Header/> <soapenv:Body> urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <command xsi:type="xsd:string">AdministrativeReport</command> <parameters xsi:type= xsd:string">{ "reportCode":"getMonthlySummaryReport". "version" "01", "terminalId":"9758219" "clerkId":"1234", "language":"l }</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope> <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" = - ns:xsd="http://www.w3.org/2001/XMLSchema" kmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/' Ins:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters xsi:type="xsd:string">{ "reportCode":"getMonthlySummaryReport", "version": "01", "terminalId": "9758219", "clerkId":"1234", "language" "1" }</parameters> /urn:executeCommand> /soapenv:Body: /soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 303 of 341 Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. Sample response: <?xml version= .0" encoding= 'UTF-8' standalone="no"?> <MonthlysummaryReportResponse> esponseCode>00</ResponseCode> <ResponseMessage>{"reportName" "MONTHLY SUMMARY REPORT", "columnNames" ["Count". "Category" "Collected", ""Profit"]."records":[{"categoryCount":"5"."collecte "50", <) /Mont th ySummar yRepor tResponse> "reportName" "MONTHLY SUMMARY REPORT", "columnNames": [ "Count" "Category", "Collected", "Profit" 1, "records":[ { "categoryCount":"14", "collected":"35", "category":"Test", "profit":"1" }, { "categoryCount":"10 "collected":"60", "category": "Topup", "profit":"2.58" }, { "categoryCount":"45", "collected":"58", "category":"Wireless", "profit":"3.25" } "totals":{ "count":{ "label":"Total Count", "value":"69" }, "collected": "label": "Less Profit", "value":"6.83" }, "totalCost":{ "label":"Total Cost", "value":"153" } } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 304 of 341 116. Get Weekly Summary Report This call allows to get weekly transactions for the terminal and clerk passed as parameters. Request Fields: Parameter Type Required Notes ReportCode String Yes getWeeklySummaryReport version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request soapenv:Envelope xm lns XS1= http://www.w. 01/XMLSchema-instance Lns xsd= http://www. org/2001/) Schema" Ins soapenv= http://schemas. lsoap Lorg/soap/envelope/" Ins urn= urn debisys soap services": <soapenv:Header/ <soapenv Body> <urn: executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi type= :string">AdministrativeReport</command> <parameters xsi:type="xsd:string">{ "reportCode":"getweeklySummaryReport"."version":"01"."terminalId":"9758219" "clerkid" "1234", "language" }</parameters> </urn: :executeCommand> </soapenv Body> </soapenv:Envelope> <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" = - Ins:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope ns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters xsi:type="xsd:string">{ "reportCode" getweeklySummaryReport", "version":"01","terminalId":"9758219", "clerkId":"1234", "language":"1" }</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 305 of 341 Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. Sample response: : xm 1.0" encoding= UTF-8' standalone="no"?> "Week 1 ySummar /Repor rtResponse> <ResponseCodex 00< /ResponseCode> <ResponseMessage> { repor tName' "WEEKLY SUMMARY REPORT|" "columnNames ["Count"."Category"."Collected"."Profit"]."records":[{"categorycount":"5"."collected":"50" "category" "Test" /Week ySumma yRepo tResponse> "reportName" "WEEKLY SUMMARY REPORT", "columnNames": [ "Count", "Category", "Collected", "Profit" ], "records": "categoryCount":"20", "collected":"87", "category":"Test", "profit":"5" }, "categoryCount":"22", "collected":"98", "category":"Topup", "profit":"4.52" }, { "categoryCount":"62", "collected":"113.25 "category":"Wireless", "profit":"9.54" } ], "totals":{ "count": "label":"Total Count", "value":"104" }, "collected":{ "label":"Less Profit", "value": "19.06" }, "totalCost":{ "label":"Total Cost", "value": "298.25" } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 306 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 307 of 341 117. Get Yesterday Summary Report This call allows to get the day before transactions for the terminal and clerk passed as parameters. Request Fields: Parameter Type Required Notes reportCode String Yes getYesterdaySummaryRepor version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request soapenv:Envelope xmLns:XSl="http://www.w3.org/2001/XMLSchema -Instance xm Ins "http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmns:urn="urn:debisys soap services" <soapenv:Header/> <soapenv:Body> kurn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters ksi:type=' xsd:string"> "reportCode":"getYesterdaySummaryReport". "version":"01", "terminalId":"9758219". "clerkId":"1234" "language":"1" }</parameters> </urn :executeCommand> </soapenv:Body> 'soapenv:Envelope> <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance = imlns:xsd="http://www.w3.org/2001/XMLSchema" kmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" Ins:urn="urn:debisys-soap-services": tsoapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters xsi:type="xsd:string">{ "reportCode":"getYesterdaySummaryReport". "version":"01", "terminalId": "9758219", "clerkId":"1234","language":"1"}</parameters> /urn:executeCommandx </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 308 of 341 Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. Sample response: UTF- 8 standalone=" no ?> Yes <ResponseMessagext {' repo tName' *YESTERDAY SUMMARY REPORT' "columnNames ["Product". "Amount". "Product Id","Sub Total" "Quantity"1."records":[{"product":"Ready Credit $100". amount' :"100.0000" "quantity" : "12", /Yester da Summar /Repo "Response> "reportName" "YESTERDAY SUMMARY REPORT", "columnNames": [ "Product", "Amount", "Product Id", "Sub Total", "Quantity" ], "records":[ { "product":"Ready Credit $100", "amount":"100.0000", "quantity":"12", "productId":"6537016", "subtotal":"1,200", "profit":"12" { "product": "Ready Credit $300", "amount":"300.0000", "quantity":"89", "productId":"6537023", "subtotal":"24,750.88", "profit":"1,306.55" "product":"TestPIN$20", "amount":"10.0000", "quantity":"5" "productId":"8000000", "subtotal":"50", "profit":"0 ], "totals":{ "totalCollected":{ abel":"Total", "value":"26,000.88" }, "totalProfit":{ "label":"Total Profit", "value":"1,318.55" }, "count":{ "label":"Total Count", "value":"106" } } tary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 309 of 341 118. Get Last 5 Transactions Report This call allows to get the last five transactions for the terminal and clerk passed as paramete rs. Request Fields: Parameter Type Required Notes reportCode String Yes getLastFiveTrxReport version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv Envelope xm Ins http://www.w3.org/2001/XMLSchema-instance" nlns xsd= http://www.w Schema" Ins soapenv= http://schemas. lsoap.org/soap/envelope/" Ins urn= urn debisys soap services <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xs1 type= xsd:string' ">AdministrativeReport</command> <parameters xsi:type= xsd:string" >{ "reportCode":"getLastFiveTrxReport". "version": "01", "terminalId":"9758219", "clerkId":"1234", "language" "1" }</parameters> </urn:executeCommand> </ soapenv Body> /soapenv Envelope> <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" imlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services" <soapenv:Header/> <soapenv:Body> (urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters ksi:type="xsd:string">{ "reportCode" : "getLastFiveTrxReport", "version":"01", "terminalId" "9758219", "clerkId":"1234", "language": "1" }</parameters> </urn:executeCommandx </soapenv:Body> /soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 310 of 341 Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. Sample response: LastFiveTrxReportResponse> ResponseMessage>{"reportName":"Ultimas 5 Transacciones" "columnNames' :["Fecha", "Hora", "Trx. Id", "pin" "9692445583392690", /LastFiveTnReportResponser { "reportName":"LAST FIVE TRANSACTIONS REPORT", "columnNames":[ "Date", "Time", "Trx. Id", "Pin", "Amount", "Product", "Trx. Type", "Ani" "records":[ "date":"04/08/19", "amount":"300", "product":"Ready Credit $300", pin":"9692445583392690", "trxtype":"2", "time":"18:48", "trxId":" 218707136", "ani":"9692445583392690" }, "date":"04/08/19", "amount":"300", "product":"Ready credit $300", "pin":"9725822712138333", "trxtype":"2", "time":"12:13", "trxId":"218707134", ani":"9725822712138333" "date":"04/08/19", "amount":"300", "product":"Ready Credit $300", "pin":"4929807083145288", "trxtype":"2", "time":"08:37", | "trxId":"218707131", "ani":"4929807083145288" "date":"04/05/19", "amount":"240", "product":"Ready credit $300", "pin":"6526974543001494", "trxtype":"2", "time":"14:13", "trxId":"218707127", "ani":"6526974543001494" "date":"04/05/19", "amount":"240", - product":"Ready Credit $300", "pin":"1440777250939069", "trxtype":"2", "time":"14:08", "trxId":" 218707126", "ani":"1440777250939069" 1, "totals":{ } } and subject to any prior established NDA. Web Services Specification 311 of 341 119. executeCommand - GetProductFinancialCharges Let to know what are associated charges to a product. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. siteld Numeric Yes Terminal identifier for the Emida network. productld Numeric Yes Identifier of the product. collectedAmount Numeric Y/N It's required If your product is variable amount. invoiceNo Numeric Yes Information about transaction language String Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services": <soapenv:Header/> <soapenv:Body> urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding <command (si:type="xsd:string">GetProductFinancialCharges</command> <parameters xsi:type="xsd:string">{"version":"01"," "siteId": "123456789", "productId": "123456789", "collectedAmount": 1.23, "invoiceNo": "01", "language": 1}</parameters> /urn:executeCommand> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 312 of 341 Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows a json schema with the charges of the product. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> ins1:executeCommandResponse SOAP -ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> - <return xsi:type="xsd:string"><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> ResponseStatus>o</ResponseStatus ResponseCode>00</ResponseCode> (ResponseMessage>{"productId" : "123456789", "taxValues" : "%5B%22B65AA9F5-C34D-E522-A639 000C293AFFF2%22%2C%22B85CC9F3-C12M-E911-A639 000C293ADSA2%22%5D","feeDistributionRules' : "%5B%22F98G1BAM-2T97-E354-A639- 000C293BFDF3%22%5D", "productAmount":1, 56,"mainAmountTaxPercent" 59.30, "mainAmountTaxValue":168.75, "fi xedFeeValue" 9.58,"fixedFeeTaxPercent":36.20,"fixedFeeTaxValue":3.47,"totalValue" 466.36,"resultstatu s":0}</ResponseMessage> </Response>]]></return> </ns1:executeCommandResponse> </SOAP-ENV:Body: </SOAP-ENV:Envelopex - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 313 of 341 120. executeCommand - FinancialChargesSale Do a recharge or pin sale using financial charges. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. siteld Numeric Yes Terminal identifier for the Emida network. productld Numeric Yes Identifier of the product. clerkld String Yes Clerk Identifier for the Emida Network amount Numeric Yes Amount of the product collectedAmount Numeric Yes This parameter could be got from "GetProductFinancialCharges" method too. accountld Numeric No Mobile Device Number taxValues String No Tokens encoded associated a Taxes Identifiers. feeDistributionRules String No Tokens encoded associated a Fee Distribution Rules Identifiers. invoiceNo Numeric Yes Information about transaction language String Yes Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command (si:type="xsd:string">FinancialChargesSale</command> <parameters xsi:type="xsd:string">{"version":"01", "siteId": "123456789", "productId": "123456789", "clerkId": "Test", "amount": 2.4, "collectedAmount": 2.3, "accountId" : "300", "taxValues": "%5B%22B65DD9E4-C34D-F911-A639-1180C293ABBB2%22%2C%22B75CC9E4-C34D-E911-A639- 000C293ABBB2%22%5D", "feeDistributionRules": :"%5B%22F98C1BCB-2C77 -E911-A639-000C293ABBB2%22%5D", "invoiceNo": "01", "language": 1}</parameters> urn:executeCommand> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 314 of 341 </soapenv:Body> :/soapenv:Envelope > Response fields Parameter Tag Type Notes resultStatus Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows information with sale result. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> hs1:executeCommandResponse SOAP -ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<?xml version="1.0' encoding="UTF-8" standalone="yes"?> <Response> ResponseStatus>1</ResponseStatus> lesponseCode>51</ResponseCode> <ResponseMessage>{"invoiceNo":"01","pin": "13245787", "controlNo":"87987987",carrierControlNo":"1245678","customerServiceNo" : "54879878", "transac tionDateTime":"05/22/201617:25:54:110","responseMessage": "PIN: 1236-50- 0382", "transactionId" : "124567688" }</ResponseMessage> </Response>]]></return> /ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP -ENV:Envelopex - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 315 of 341 121. executeCommand - DigitalProductService This service allows to sell Facey MobileGo digital products like Apple iTunes pin products. Request Parameters Parameter Tag Type Required Notes command String Y DigitalProductService parameters String Y { "site_id" "8015458", "clerk_id":"1234", "invoice_id":"1", "amount":"10", "product_id":" "1" "account_i id' : "3005284504", "client_pin": "9876" } Where the JSON structure has the following parameters: Parameter Tag Type Required Notes site_id String Y Id of the terminal or site clerk_id String Y Password of the clerk operator invoice_id String Y Unique identifier to identify the transaction amount String Y Value of the top up it can have up to 2 decimals ####.## product_id String Y Product identifier account_id String Y Phone number of the customer who want to do the topup. client_pin String Y Customer identifier which validates the phone number. Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" mlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommandsoapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">DigitalProductService</command> <parameters xsitype="xsd:string"> "site_id": "8015458", This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 316 of 341 "clerk_id": "1234", "invoice_id":"1 "amount": "10", "product_id": "1" "account_id" "3005284504", "client_pin": "9876" }</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope> Respose Parameters Parameter Tag Type Notes String String When fail <SOAP-ENV:Envelope xmlns: SOAP- ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> s1:executeCommandResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services"> <return si:type="xsd:string"><![CDATA[<ProductFlowlnfoServiceRespons ex<Version>1</Version><ResponseCode>10</ResponseCode><F esponseMessage>INVALID SITE- ID</ResponseMessage></ProductFlowlnfoServiceResponse>]]></r eturn> /ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Response Example For TopUp: <SOAP-ENV:Envelope mlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> <ns1:executeCommandResponse SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/' hIns:ns1="urn:debisys-soap-services"> <return xsi:type="xsd:string"><![CDATA[<Product><ProductCategory>RTR</ProductCategory> <CarrierName>TMobile TopUp</CarrierName> <Productld>8813416</Productld> <NameProduct>T-Mobile TopUp $15</NameProduct> <ProductUFee>0.0000</ProductUFee> <CurrencyCode>USD</CurrencyCode> <Amount>15.0000</Amount> <AmountMin>0</AmountMin> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 317 of 341 <AmountMax>0</AmountMax> <PaymentType>Total-Parcial-Vencidos</PaymentTypex <ProductSubCategory>Balance TAE</ProductSubCategory> <ReferenceParameters> <Reference1> <ReferenceNamexTelcel Sin Limite 50 = 7 days 300 MB data + WhatsApp minutes and unlimited sms + 500 MB Twitter Facebook Instagram and Snapchat</ReferenceName> <FieldType>NM</FieldType> LengthMin>12</LengthMin> <LengthMax>12</LengthMax> <Prefix>NA</Prefix> <ToolTip></ToolTip> <URLImage></URLImage> <ExtraReference1> <Mandatory>NO</Mandatory> </ExtraReference1> </Reference1> </ReferenceParameters></Product>]]></return> </ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 318 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 319 of 341 122. Get Last 5 Transactions Report With Profit This call allows to get the last five transactions with profit for the terminal and clerk passed as parameters. Request Fields: Parameter Type Required Notes reportCode String Yes getLastFiveTrxReportProfit version Numeric No Defaults to 01. Reserved for future use. siteld Numeric Yes Terminal identifier for the Emida network. clerkld Numeric Yes Clerk identifier for the Emida Network. languageld String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" s:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">AdministrativeReport</command> <parameters ksi:type="xsd:string">{ "reportCode": :"getLastFiveTrxReportProfit". "version": "01", "terminalId": "9758219", clerkId":"1234","language" "2" }</parameters> </urn:executeCommandx /soapenv:Body> </soapenv:Envelope> Response fields Parameter Tag Type Notes ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String JSON object with the corresponding records or the error message in case of failure. This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 320 of 341 Sample response: astFiveTrxReportProfitResponse> <ResponseCode>00</ResponseCode <ResponseMessage> {"reportName":"Últimas5 Transacciones" "columnNames":["Fecha","Hora","Trx.Id","Pin","Monto" Trx.", "Ingreso"], "records":[{"date":"08/01/19","time":"12:19","trxId":" 218707826","pin":"","amount":"3","product":"SPIFf2","trxType":"18","ani":"","profit":"0,02"} "date":"08/01/19","time":"12:19","trxId":"2187 ":"","amount":"3","product":"SPIFF2","trxType":"18","ani":"","profit":"0,02"} {"date":"08/01/19","time":"09:59","trxId":" : "pin":"","amount":"3","product":"SPIFF2","trxType":"18","ani":"","profit":"0,02"} "date":"08/01/19","time":"08:57","trxId":"21870 ","pin":"21820","amount":"3","product":"SPIFF2","trxType":"18","ani":"218700","profit":"0,02"} {"date":"07/31/19","time":"15:17","trxId":" 218707813","pin":"21812","amount":"3","product":"SPIFf2","trxType":"18","ani":"2187012","profit":"0,02"}] "totals":{)}</ResponseMessage) </LastFiveTrxReportProfitResponse> <LastFiveTrxReportProfitResponse> <ResponseCode>00</ResponseCode> <ResponseMessage> ("reportName":"Ultimas 5 Transacciones", "columnNames":["Fecha","Hora","Trx. Id", "Pin", "Monto", "Producto", "Tipo Trx.", "Teléfono", "Ingreso"], "records":[{"date":"08/01/19","time":"12:19","trxld":' 218707826", "pin":"","amount":"3","product":"SPIFF2","trxType":"18","ani":"","profit":"0,02"), {"date":"08/01/19","time":"12:19","trxld"." 218707825","pin"."","amount":"3","product":"SPIFF2","trxType":"18","ani"."","profit":"0,02"}, {"date":"08/01/19","time":"09:59","trxld"." 218707824", "pin":"" ","amount":"3","product":"SPIFF2","trxType":"18","ani":"","profit":"0,02"}, {"date":"08/01/19","time":"08:57","trxld"." 218707821","pin":"21820","amount":"3","product":"SPIFF2","trxType":"18","ani":"218700","profit":"0,02"} {"date":"07/31/19","time":"15:17","trxld"." 218707813","pin":"21812","amount":"3","product":"SPIFF2","trxType":"18","ani":"2187012","profit":"0,02"}], "totals":{}}</ResponseMessage> /LastFiveTrxReportProfitResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 321 of 341 123. executeCommand - ApplyPaymentToRep User should be logged in like sub-agent, agent or ISO to apply payments to rep. Request Fields: Parameter Type Required Notes version Numeric No Defaults to 01. userName String Yes User name associated to rep and logged as sub- agent, agent, or ISO. userPass String Yes User password associated to rep and logged as sub-agent, agent, or ISO. description String No Payment description. Size allowed is 221 characters. repld Numeric Yes Rep identifier which is going to receive the payment. amount Numeric Yes Indicates the value of the payment to be made. This amount will be interpreted in local currency. invoiceNo Numeric No Information about transaction language String No Single-digit number to indicate preferred language for the response message. 1 = English, 2 = Spanish Sample Request <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys -soap-services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <command ksi:type="xsd:string">ApplyRepPayment</command> <parameters xsi:type="xsd:string">{"version":"01", "userName": "testName", "userPass": "testPass123", "description" "Sent", "repId": 1111111111111, " amount" : 1, "invoiceNo": "01", "language" : 1}</parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 322 of 341 Response fields Parameter Tag Type Notes Response Status Numeric - Zero (0) if the process was successful. Otherwise 1 ResponseCode Numeric - Zero (00) if the process was successful. Otherwise the error code. ResponseMessage String If the process was successful shows information with sale result. Referenceld String Transaction Code. Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" <SOAP-ENV:Body> Ins1:executeCommandResponse SOAP -ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap-services": - <return xsi:type="xsd:string"><![CDATA[<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <Response> ResponseStatus>o</ResponseStatus> ResponseCode>00</ResponseCode> <ResponseMessage>Success</ResponseMessage: referenceId>69088</referenceId> </Response>]]></return> </ns1:executeCommandResponsex </SOAP-ENV:Body> - </SOAP-ENV:Envelope: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 323 of 341 124. executeCommand - TelikomMeteringService This service allows the recharge of meter devices for PNG Power Telikom. Request Fields: Parameter Type Required Notes command String Yes TelikomMeteringService parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes Clerk_Id Numeric Yes Clerk identifier for the Emida Network. Account_Id String Yes The phone number of the subscriber where the notification will be sent Invoice_id String Yes Information about transaction. External transaction id amount String Yes Indicates the value of the payment to be made. This amount will be interpreted in local currency. Product_Id String Yes Product identifier Site_Id String Yes Id of the terminal or site meter_no String Yes Customer identifier which validates the meter device. Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' - xmlns :xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> kurn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">TelikomMeteringService</command> <parameters xsi:type="xsd:string">- { "product_id": "8928105", This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 324 of 341 "account_id": "30055284050", "site_id": "8965706", "invoice_id" "123", "meter_no" "M123", "clerk_id" "1234", "amount": "10" } </parameters> </urn:executeCommand> /soapenv:Body> </soapenv:Envelopex Sample response: <SOAP -ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> - <ns1:executeCommandResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[<?xml version="1.0 encoding="UTF-8' standalone="yes <Response> ResponseStatus>o</ResponseStatus> ResponseCode>0o</ResponseCode> ResponseMessage>Success</ResponseMessage referenceId>69088</referenceId> </Response>]]></return> /ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 325 of 341 125. executeCommand - InternalReport this method allows the execution of the reports 411,412,451,453 Request Fields: Parameter Type Required Notes command String Yes InternalReport parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes version Numeric Yes Defaults to 01. invoiceNo String Yes identification number for the transaction clerkId String Yes Clerk of terminal Product_Id String Yes Product identifier Site_Id String Yes Id of the terminal or site language String No Single-digit number to indicate preferred language for the response message. 1 = English Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' - xmlns sxsd="http://www.w3.org/2001/XMLSchema" xmlns :soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">InternalReport</command> <parameters xsi:type="xsd:string"> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 326 of 341 { "version":"1 , "terminalId" : "2591196", "productId" : "412", "clerkId":"2591196", "language": "1", "invoiceNo" : "12345" } </parameters> </urn:executeCommand> </soapenv:Body> </soapenv:Envelopex Sample response. <SOAP -ENV:Envelope - xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/' xmlns :xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - <ns1:executeCommandResponse SOAP ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap - services"> <return <si:type="xsd ng"><![CDATA[<InternalReport><Version></Version><ResponseCode>0</Response Code><ResponseMessage> DAILY SUMMARY REPORT For SUMMARY BY CATEGORY ******** COUNT CATEGORY COLLECTED PROFIT 8 Test 1000.0000 0.0 2 TOP UP 31.0000 0.0 TOTAL 1031.0000 0.0 LESS PROFIT 0.0 TOTAL COST 1031.0000 Tue Apr 07 17:45:22 COT 2020 /ResponseMessage></InternalReport>]]></return> </ns1:executeCommandResponse> </S0AP-ENV:Body> - </SOAP-ENV:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 327 of 341 125. executeCommand - BillPayment_GetBills This service allows to return a list of bills given a merchant account and a date range for CWC. Request Fields: Parameter Type Required Notes command String Yes BillPayment_GetBills parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes Clerk_Id Numeric Yes Clerk identifier for the Emida Network. Account_Id String Yes The phone number of the merchant. site_Id String Yes Id of the terminal or site Invoice_id String Yes Information about transaction. External transaction id Product_Id String Yes Product identifier start_date String No Start date format yyyy-MM-dd HH:mm. 2020-01- 01 00:00 end_date String No Start date format yyyy-MM-dd HH:mm. 2020-01- 31 23:59 Request Example <soapenv: Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xmlns:xsd="http://www.w3.org/2001/XMLSchema" = xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" <command xsi:type="xsd:string">BillPaymentService</command> <parameters xsi:type="xsd:string">{ "site_id" "9793203", "clerk_id": "9793203", This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 328 of 341 "invoice_id" "1234", "account_id": "6758305001", "product_id": "9000906", "start_date": '2020-01-01 00:00" , "end_date": "2020-01-31 23:59" }</parameters> /urn:executeCommand> </soapenv:Body> </soapenv:Envelope> Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <SOAP-ENV:Body> - hs1:executeCommandResponse SOAP- ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap services"> <returnxsi:type="xsd:string"><![CDATA[<?xml version="1.0 encoding="UTF-8' standalone="yes"?> <Response> ResponseStatus>o</ResponseStatus> ResponseCode>0o</ResponseCode> <ResponseMessage> {JSON document}</ResponseMessage> </Response>]]></return> </ns1:executeCommandResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelopex Where JSON Document JSON Bill Payment Response { "businessId" "JM", "accountNo": 177103170000, "startDate": "2019-05-01T00:00:01-05:00", "endDate": "2020-04-14T00:00:01-05:00", "sourceBSS": "LIBERATE", "billable": true, "billableAccountNo": 177103170000, "totalAdjustmentCredit": 0, "totalDepositPaid": 0, "totalDepositRequirement": 0, "directDebit": false, "totalOutstandingBalance": 37.18, "paymentPlan": false, "totalserviceChargeCredit": 0, "totalBillableAmount": 37.18, "totalQueryAmount": 0, "totalQueryTaxAmount": 0, "totalUnallocatedCredit" 0, "totalWriteOffamount": 0, "totalRewardPoints": 0, "totalRewardPointsCurrencyValue": 0, "checkAlertCode": "0", This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 329 of 341 "noOfBills": 12, "bills" : [ { "billReference": "2020031", "billDate": "2020-04-05T19:00:01-05:00", "billOverdue": false, "billDueDate" : "2020-04-25T00:00:00-05:00", "billCleared": false, "billclearedDate": "9999-12-31T00:00:00-05:00", "balanceBroughtForward" 28.71, "balanceCarriedForward": 37.18, "billAmount": 8.47, "billoutstandingBalance": 8.47, "billPaidAmount": 0, "billDisputed" : false, "billAdjustmentAmount": 0 }, "billReference": "2020021", "billDate" "2020-03-05T19:00:01-05:00", "billOverdue": true, "billDueDate": 2020-03-25T00:00:00-05:00". "billCleared": false, "billclearedDate": "9999-12-31T00:00:00-05:00", "balanceBroughtForward": 25.36, "balanceCarriedForward" 28.71, "billAmount": 3.35, "billOutstandingBalance": 3.35, "billPaidAmount": 0, "billDisputed": false, "billAdjustmentAmount": 0 }, "billReference": "2020011", "billDate": "2020-02-05T19:00:01-05:00", "billOverdue": true, "billDueDate" : "2020-02-25T00:00:00-05:00", "billCleared": false, "billclearedDate": "9999-12-31T00:00:00-05:00", "balanceBroughtForward" : 19.09, "balanceCarriedForward": 25.36, "billAmount": 6.27, "billOutstandingBalance": 6.27, "billPaidAmount": 0, "billDisputed": false, "billAdjustmentAmount": 0 }, { "billReference": "2019121", "billDate": "2020-01-05T19:00:01-05:00", "billOverdue": false, "billDueDate" : '2020-01-25T00:00:00-05:00", "billCleared": true, "billclearedDate": "2020-01-05T19:00:01-05:00" "balanceBroughtForward" 19.09, "balanceCarriedForward": 19.09, "billAmount": 0, "billOutstandingBalance": 0, "billPaidAmount" : 0, "billDisputed": false, "billAdjustmentAmount": 0 } ] } This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 330 of 341 This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 331 of 341 126. executeCommand - PaymentReview this method will query the current status of a payment Request Fields: Parameter Type Required Notes command String Yes PaymentReview parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes paymentID Numeric Yes id of payment to query it status language Numeric Yes Single-digit number to indicate preferred language for the response message. 0 = English 1 = Spanish Request Example <soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> kurn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">PaymentReview </command> <parameters ksi:type="xsd:string"> ("language":"0" 'paymentID" "125906"} </parameters> </urn:executeCommand> /soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 332 of 341 Sample response: loapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" mlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema- instance"> <soapenv:Body> hs1:executeCommandResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <PaymentReview> <ResponseCode>0</ResponseCode> <ResponseBody> {"resultMessage": 'Payment Found", "resultCode":"0", "paymentReviewModel" : {"status":"NOT_APPLIED","rejectReason":"" "idDoc":"Tfasdfsd" "dateDoc"."2017-06-27 00:00:00.0", "bank": "Santander" " "depositType":"Transfer' ", , "amount":"100.0000", 'dateRequest": 2017-06-27 18:13:00.99"}} </ResponseBody> </PaymentReview>]]></return> </ns1:executeCommandResponse> </soapenv:Body> </soapenv:Envelope> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 333 of 341 127. executeCommand - BillPayment_PayBill This method allows execute a transaction with bill payment information. Request Fields: Parameter Type Required Notes command String Yes BillPayment_PayBill parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes site_id String Yes Terminal identifier for the Emida network. clerk_id String Yes The ClerkID identifies a clerk that is authorized to sell products via the associated terminal. amount String Yes Amount of the product invoice_id String Yes Unique identifier to identify the transaction account_id String Yes Phone number of the customer who want to do the topup. product_id String Yes Product identifier in Emida bill_reference String Yes Short text to identify the transaction payment_comment String Yes Comment about this process billing_system String Yes Billing System option with only the following options: "LIBERATE" or "CERILLION" payment_method String Yes Payment method option with only the following options: "CASH" or "CREDIT" This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 334 of 341 Request Example <soapenv : Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance - xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:debisys-soap- services"> <soapenv:Header/> <soapenv:Body> <urn:executeCommand soapenv:encodingstyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">BillPaymentExecuteService</command> <parameters xsi:type="xsd:string"> {"site_id" "9019090", "clerk_id" "1234", "amount": "1", "invoice_id": "1", "account_id": '3112227788", "product_id" "200000023", "bill_reference" "2020/03", "payment_comment": "My Bill payment", "billing_system" "LIBERATE", "payment_method": "CREDIT"} </parameters> /urn:executeCommand> </soapenv:Body> (soapenv:Envelope> Sample response: <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance' xmlns:xsd="http://www.w3.org/2001/XMLSchema": <SOAP-ENV:Body> s1:executeCommandResponse SOAP ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap services"; <return xsi:type="xsd:string"><![CDATA[<?xml version="1.0" encoding="UTF-8 standalone="yes"? <Response> ResponseStatus>o</ResponseStatus> lesponseCode>o</ResponseCode> <ResponseMessage>{ "businessId" : "JM", "accountNo": "273402240000", "paymentNo": "433065946" }</ResponseMessage> </Response>]) </return> (ns1:executeCommandResponse> </SOAP-ENV:Body> - This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 335 of 341 128. executeCommand - GenMobileActivation this method allows the execution of the reports 411,412,451,453 Request Fields: Parameter Type Required Notes command String Yes GenMobileActivation parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes version Numeric Yes Defaults to 01. invoiceNo String Yes identification number for the transaction clerkID String Yes Clerk of terminal productID String Yes Product identifier terminalID String Yes Id of the terminal or site amount String Yes Must be the value of plan sim String Yes Sim to activate zip String Yes Zip of activation city String Yes City to activation state String Yes Zip of activation language String No Single-digit number to indicate preferred language for the response message. 1 = English Request Example This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 336 of 341 <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/": <command xsi:type="xsd:string">GenMobileActivation</command> <parameters (si:type="xsd:string"> { "version":"1", "invoiceNo":"1", "clerkID":"1234", "productID" : '1016084", "terminalID" '4086984", "language" "1", "amount": "30.00", "sim" 1471471471472583693", "zip" '12345", "city" "rodriguez", "state" "12345 } /parameters> </urn:executeCommand> Sample response: <ns1:executeCommandResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys- soap-services"> <return xsi:type="xsd:string"><![CDATA[ <GenMobileActivation> <ResponseCode>0</ResponseCode <ResponseBody> { "result": 252226762 trx success PhoneNumber: 22893321", "code": "0" } </ResponseBody> </GenMobileActivation>]]></return (/ns1:executeCommandResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 337 of 341 129. executeCommand - GenMobilePortin this method allows the execution of the reports 411,412,451,453 Request Fields: Parameter Type Required Notes command String Yes GenMobilePortin parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes version Numeric Yes Defaults to 01. invoiceNo String Yes identification number for the transaction clerkID String Yes Clerk of terminal productID String Yes Product identifier terminalID String Yes Id of the terminal or site accountNumber String Yes Field required to the integration phoneNumber String Yes Field required to the integration passwordPin String Yes Field required to the integration ospFirstName String Yes Field required to the integration ospLastName String Yes Field required to the integration ospAddress1 String Yes Field required to the integration ospCity String Yes Field required to the integration ospState String Yes Field required to the integration ospZip String Yes Field required to the integration amount String Yes Must be the value of plan This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 338 of 341 sim String Yes Sim to activate zip String Yes Zip of activation city String Yes City to activation state String Yes Zip of activation language String No Single-digit number to indicate preferred language for the response message. 1 = English Request Example <urn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">GenMobilePortin</command <parameters xsi:type="xsd:string"> { "terminalID" "4086984", "productID":"1016084", "clerkID":"1234", "version":"1", "language":"1", "invoiceNo":"1" "amount":"15.00" "accountNumber" 123456789123456", "phoneNumber' "1234", "sim" "1471471471472583693", "zip":"15234", "passwordPin":"12345' "city":"1234", "state":"12345", 'ospFirstName":"1234", "ospLastName":"1234 "ospAddress1":"1234" "ospCity":"1234", "ospState" : 12354", "ospZip": '12344"} </parameters> </urn:executeCommand> Sample response: This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 339 of 341 ns1:executeCommandResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <GenMobilePortin> <ResponseCode>0</ResponseCode: <ResponseBody> {"result":" "test response 6x6x6x252226760". "code":"0"] </ResponseBody> </GenMobilePortin>]]> </return> </ns1:executeCommandResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 340 of 341 130. executeCommand - GenMobileQuery this method allows the execution of the reports 411,412,451,453 Request Fields: Parameter Type Required Notes command String Yes InternalReport parameters String Yes JSON document format. JSON Document parameters Parameter Type Required Notes version Numeric Yes Defaults to 01. invoiceNo String Yes identification number for the transaction clerkId String Yes Clerk of terminal Product_Id String Yes Product identifier Site_Id String Yes Id of the terminal or site accountNumber String Yes Number To Query Status language String No Single-digit number to indicate preferred language for the response message. 1 = English Request Example kurn:executeCommand soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> <command xsi:type="xsd:string">GenMobileQuery</command> <parameters xsi:type="xsd:string"> { "terminalID":"4086984", "productID":"1016084" "clerkID":"1234", This information is proprietary to Emida, Inc., and subject to any prior established NDA. Web Services Specification 341 of 341 "version":"1" "language":"1' "invoiceNo":"1" "accountNumber": "555555" } </parameters> </urn:executeCommand> Sample response: is1:executeCommandResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:debisys-soap- services"> <return xsi:type="xsd:string"><![CDATA[ <GenMobileQueryPortin> <ResponseCode>0</ResponseCode> <ResponseBody> { "result":"INPROGRESS::6G-PORT COMPLEXITY", "code":"0" } </ResponseBody> </GenMobileQueryPortin>]]></retur </ns1:executeCommandResponse> This information is proprietary to Emida, Inc., and subject to any prior established NDA.

Last updated: 3 years ago