Get Mobile Payment Options

Description:

Return mobile terminal payment options per merchant, including fee and net amount.

URL: https://secure1.sandbox.directpay.online/API/v7/index.php

Parameter

Data Type

Description

CompanyToken

Token

Token you got from 3G to operate this API

Mandatory

Request

Text

Request reference

Mandatory

TransactionToken

Token

Transaction unique reference

Mandatory

Request Example:

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>68B90B5E-25F6-4146-8AB1-C7A3A0C41A7F</CompanyToken>
  <Request>GetMobilePaymentOptions</Request>
  <TransactionToken>6CDE6B83-AF0E-48E7-81A0-3C308BE62E9D</TransactionToken>
</API3G>

Response Example:

<?xml version="1.0" encoding="UTF-8"?>
<API3G><Code>000</Code>
	<Explanation>Results Found</Explanation>
	<originalCurrency>KES</originalCurrency>
	<originalAmount>100</originalAmount>
	<paymentoptions>
		<mobileoption>
			<country>uganda</country>
			<countryCode>UG</countryCode>
			<paymentname>MTNmobileMoney</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mtn.png</logo>
			<celluarprefix>256</celluarprefix>
			<amount>3610</amount>
			<currency>UGX</currency>
			<instructions>1. MTN will send you a request to complete the payment.;2. You will be requested to select the
				transaction with the amount in UGX.;3. MTN will ask you to accept or reject the payment. Select
				Accept.;4. MTN will prompt you to enter the mobile money pin. Enter your service PIN.;5. You will
				receive an SMS confirmation of your transaction from MTN.;6. MTN online is a service that allows you to
				approve secure payments from your MTN mobile money account.</instructions>
			<fee>0.000</fee>
			<total>3610</total>
		</mobileoption>
		<mobileoption>
			<country>tanzania</country>
			<countryCode>TZ</countryCode>
			<paymentname>TIGOdebitMandate</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/tigo.png</logo>
			<celluarprefix>255</celluarprefix>
			<amount>2281</amount>
			<currency>TZS</currency>
			<instructions>Instructions for Tigo DB</instructions>
			<fee>0.000</fee>
			<total>2281</total>
		</mobileoption>
		<mobileoption>
			<country>kenya</country>
			<countryCode>KE</countryCode>
			<paymentname>SafaricomSTKv2</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mpesa.png</logo>
			<celluarprefix>254</celluarprefix>
			<amount>100</amount>
			<currency>KES</currency>
			<instructions>Please insert your Pin to confirm you order if STK expires use this 174379 and Acc 66CDE6 to
				pay</instructions>
			<fee>0.000</fee>
			<total>100</total>
		</mobileoption>
		<mobileoption>
			<country>ivory coast</country>
			<countryCode>CI</countryCode>
			<paymentname>Orange_MoneyWebPay</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/orange.png</logo>
			<celluarprefix>225</celluarprefix>
			<amount>553</amount>
			<currency>XOF</currency>
			<instructions>1. Instructions for Orange Ivory Coast</instructions>
			<fee>0.000</fee>
			<total>553</total>
		</mobileoption>
		<mobileoption>
			<country>ivory coast</country>
			<countryCode>CI</countryCode>
			<paymentname>MTNbillmap</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mtn.png</logo>
			<celluarprefix>225</celluarprefix>
			<amount>553</amount>
			<currency>XOF</currency>
			<instructions>1. Instructions for MTN Ivory Coast</instructions>
			<fee>0.000</fee>
			<total>553</total>
		</mobileoption>
		<mobileoption>
			<country>ghana</country>
			<countryCode>GH</countryCode>
			<paymentname>MTN</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mtn.png</logo>
			<celluarprefix>233</celluarprefix>
			<amount>6</amount>
			<currency>GHS</currency>
			<instructions>1. Dial *170# select Option 6&amp;#8218 My Wallet;2. Select Option 3 for My Approvals..;3.
				Enter PIN to get your Pending Approval List.;4. Select pending transaction to approve.;5. Select Option
				1 for YES to approve the transaction OR Option 2 for NO to reject the transaction.</instructions>
			<fee>0.000</fee>
			<total>6</total>
		</mobileoption>
		<mobileoption>
			<country>uganda</country>
			<countryCode>UG</countryCode>
			<paymentname>AirtelMobiquity_USSD</paymentname>
			<logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/airtelmoney.png</logo>
			<celluarprefix>256</celluarprefix>
			<amount>3610</amount>
			<currency>UGX</currency>
			<instructions>1. Instructions for Airtel Tigo</instructions>
			<fee>0.000</fee>
			<total>3610</total>
		</mobileoption>
	</paymentoptions>
</API3G>

Empty Response:

<?xml version="1.0" encoding="UTF-8"?>
<API3G><Code>000</Code>
	<Explanation>No transactions found</Explanation>
	<paymentoptions />
</API3G>

Error Response:

<?xml version="1.0" encoding="UTF-8"?>
<API3G><Code>950</Code>
	<Explanation>Request missing mandatory fields – TransactionToken</Explanation>
	<paymentoptions />
</API3G>