GetMobilePaymentOptionsByCompanyToken(V7)

Description

The GetMobilePaymentOptionsByCompanyToken request will be used to receive the list of available mobile payment options per company

URL: https://3g.rogersm.dev.directpay.online/api/v7/index.php

Response

The method will response with the result of your request

Variables to send:

Parameter	Data Type	Description

Parameter	Data Type	Description
Request	Text		Mandatory
CompanyToken	Token	Token you got from 3G to Operate this API	Mandatory

Request example:

Request Sample

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>90EC1DA4-A7C5-432C-930C-098715D3130E</CompanyToken>
  <Request>GetMobilePaymentOptionsByCompanyToken</Request>
</API3G>

Respond:

The server will respond for the GetMobilePaymentOptionsByCompanyToken request according to the following results:

Parameter	Data Type	Description

Parameter	Data Type	Description
terminalmnocountry	Text	Country
terminalmno	Text	Provider name
terminaltype	Text	Terminal Type
terminalredirecturi	Text	If redirect uri is set
celluarprefix	Number	Country Prefix
`terminallogo`	url	Contains image for the terminalmno

Response codes:

Code	Explanation

Code	Explanation
802	Wrong CompanyToken
999	Wrong Request
904	Can’t return Mobile Terminals

Response example:

<?xml version="1.0" encoding="UTF-8"?>
<API3G>
    <paymentoptionsmobile>
        <terminalmobile>
            <terminalredirecturi>0</terminalredirecturi>
            <terminaltype>Mobile</terminaltype>
            <terminalmno>SafaricomSTKv2</terminalmno>
            <terminalmnocountry>Kenya</terminalmnocountry>
            <terminallogo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mpesa.png</terminallogo>
            <cellularprefix>254</cellularprefix>
        </terminalmobile>
        <terminalmobile>
            <terminalredirecturi>0</terminalredirecturi>
            <terminaltype>Mobile</terminaltype>
            <terminalmno>LAMBDA</terminalmno>
            <terminalmnocountry>uganda</terminalmnocountry>
            <terminallogo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mpesa.png</terminallogo>
            <cellularprefix>256</cellularprefix>
        </terminalmobile>
        <terminalmobile>
            <terminalredirecturi>1</terminalredirecturi>
            <terminaltype>Mobile</terminaltype>
            <terminalmno>MTN</terminalmno>
            <terminalmnocountry>Ghana</terminalmnocountry>
            <terminallogo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/mtn.png</terminallogo>
            <cellularprefix>233</cellularprefix>
        </terminalmobile>
        <terminalmobile>
            <terminalredirecturi>0</terminalredirecturi>
            <terminaltype>Mobile</terminaltype>
            <terminalmno>AirtelMobiquity_USSD</terminalmno>
            <terminalmnocountry>Kenya</terminalmnocountry>
            <terminallogo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/airtelmoney.png</terminallogo>
            <cellularprefix>254</cellularprefix>
        </terminalmobile>
        <terminalmobile>
            <terminalredirecturi>0</terminalredirecturi>
            <terminaltype>Mobile</terminaltype>
            <terminalmno>AirtelMobiquity_USSD</terminalmno>
            <terminalmnocountry>Uganda</terminalmnocountry>
            <terminallogo>https://s3-eu-west-1.amazonaws.com/directpaystorage/icons/airtelmoney.png</terminallogo>
            <cellularprefix>256</cellularprefix>
        </terminalmobile>
    </paymentoptionsmobile>
</API3G>