The response includes country, name, logo, dial/USSD prefix, amount/currency, and step-by-step instructions you can show to the customer.

This reads the merchant + token config and returns only the options that apply to that transaction.

📱
Mobile money integrations are subject to country-specific requirements defined by Mobile Network Operators (MNOs), including supported networks, transaction limits, and approval flows.
See the MNO Advisory for detailed guidance before enabling mobile payment options.

Endpoint

POST https://secure.3gdirectpay.com/API/v6/

Headers

Content-Type: application/xml; charset=utf-8
Accept: application/xml

Request

Required Fields

Field	Required	Description
`CompanyToken`	Yes	Your merchant token
`Request`	Yes	Must be `GetMobilePaymentOptions`
`TransactionToken`	Yes	Token returned by `createToken`

Example Request (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <CompanyToken>YOUR_COMPANY_TOKEN</CompanyToken>
  <Request>GetMobilePaymentOptions</Request>
  <TransactionToken>72983CAC-5DB1-4C7F-BD88-352066B71592</TransactionToken>
</API3G>

Response

Returns one or more <mobileoption> items within <paymentoptions>.

Example Success Response (XML)

<?xml version="1.0" encoding="utf-8"?>
<API3G>
  <paymentoptions>
    <mobileoption>
      <country>kenya</country>
      <countryCode>KE</countryCode>
      <paymentname>airtel</paymentname>
      <logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/airtel.png</logo>
      <celluarprefix>254</celluarprefix>
      <amount>120</amount>
      <currency>KES</currency>
      <instructions>
        1.Go to Airtel Money SIM toolkit;
        2.Select Airtel Money;
        3.Select 'Make payments';
        4.Select 'Pay bill';
        5.Select 'Other';
        6.Business name: 369369;
        7.Enter amount: 200;
        8.Enter Airtel Money PIN;
        9.Reference: 676CC8;
        10.OK to send.
      </instructions>
    </mobileoption>
    <mobileoption>
      <country>tanzania</country>
      <countryCode>TZ</countryCode>
      <paymentname>vodacom</paymentname>
      <logo>https://s3-eu-west-1.amazonaws.com/directpaystorage/vodacom.png</logo>
      <celluarprefix>255</celluarprefix>
      <amount>70</amount>
      <currency>TZS</currency>
      <instructions>
        1.Dial *150*00#;
        2.Select Pay by M-Pesa;
        3.Enter business number;
        4.Business: 644644;
        5.Reference: 676CC8;
        6.Amount: 4456.92;
        7.Enter PIN;
        8.Confirm (1) to proceed.
      </instructions>
    </mobileoption>
  </paymentoptions>
</API3G>

▶️ Test in Postman

Field Reference (per `mobileoption`)

Field	Description
`country` / `countryCode`	Human name & ISO-2 code (e.g., `kenya` / `KE`)
`paymentname`	Provider name (e.g., `airtel`, `vodacom`)
`logo`	HTTPS URL to a provider logo you can display
`celluarprefix`	Country calling code (e.g., `254`, `255`)
`amount`, `currency`	Amount & ISO currency for this option
`instructions`	Steps the customer follows to complete payment

Note: Steps often include business number and reference values tied to the token (e.g., CompanyRef or a short code). Display them exactly as returned.

Usage Notes & Best Practices

Call after createToken and before you show mobile money choices to the customer.
Render each option with logo + name + country, and show a “How to pay” expander with instructions.
Preserve line breaks/numbering in instructions (they’re customer-facing).
If you support multiple regions, filter or sort options by countryCode.
Cache options per token briefly (they may depend on token amount/currency).

Typical Flow

sequenceDiagram
  participant M as Merchant Server
  participant D as DPO API
  participant U as Customer

  M->>D: createToken → TransToken
  M->>D: GetMobilePaymentOptions (TransToken)
  D-->>M: List of mobile options & instructions
  M-->>U: Display options user follows steps
  D-->>M: BackURL callback with result
  M->>D: (optional) verifyToken for reconciliation

Troubleshooting

Empty list: Option not enabled for your merchant, or currency/amount not supported for that method.
XML errors (804): Check exact tag names and encoding; ensure Request is GetMobilePaymentOptions.
Logos not loading: Ensure your front-end allows remote images from the S3 domain via HTTPS.