Skip to main content

Topup

POST 
https://vend.ismartghana.com/api/topup/topup

Request airtime or bundle purchase for a mobile number. Bearer authentication required.

Use type: TOPUP for direct airtime purchases and type: BUNDLE for network bundle purchases. For Ismart Global transfers, send network: ISMART_TRANSFER, provider: ISMART, type: AIRTIME, and the Ismart Global SKU in bundlecode; the service maps these values to Ismart Global transfer fields (AccountNumber, SendValue, SkuCode, and an internal DistributorRef).

Request​

Body

request payload

    mobile phonerequired

    End user mobile number to receive the topup or bundle.

    amount doublerequired

    Purchase amount. For Ismart Global this is sent as SendValue.

    currency stringrequired

    ISO currency code for the purchase amount.

    country stringrequired

    ISO country code for the destination mobile number.

    network stringrequired

    Destination network. Use mtn, telecel, or airteltigo for Ghana network purchases; use ISMART_TRANSFER for Ismart Global.

    type stringrequired

    Purchase type. Use TOPUP for airtime, BUNDLE for network bundles, and AIRTIME for Ismart Global transfers.

    provider string

    Optional provider override. Use ISMART for Ismart Global.

    bundlecode string

    Bundle or product code. Required for Ismart Global as the Ismart Global SKU code; required for network bundle products where a bundle code is available.

    notes string

    Optional transaction notes.

    trackid uuid

    Optional client tracking id. The service generates one when it is not supplied.

    resurl url

    Optional subscriber URL to asynchronously submit results to.

    additionalProperties

Examples​

MTN bundle

{
  "mobile": "233553554911",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "mtn",
  "notes": "Testing",
  "type": "BUNDLE",
  "bundlecode": "DATANVDR5WLY"
}

MTN airtime

{
  "mobile": "233553554911",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "mtn",
  "notes": "Testing",
  "type": "TOPUP"
}

Telecel bundle

{
  "mobile": "233507064001",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "telecel",
  "notes": "Testing",
  "type": "BUNDLE",
  "bundlecode": "DATANVDR5WLY"
}

Telecel airtime

{
  "mobile": "233507064001",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "telecel",
  "notes": "Testing",
  "type": "TOPUP"
}

AirtelTigo bundle

{
  "mobile": "233268401145",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "airteltigo",
  "notes": "Testing",
  "type": "BUNDLE",
  "bundlecode": ""
}

AirtelTigo airtime

{
  "mobile": "233268401145",
  "amount": 3,
  "currency": "EUR",
  "country": "GH",
  "network": "airteltigo",
  "notes": "Testing",
  "type": "TOPUP"
}

Ismart Global

{
  "currency": "EUR",
  "amount": 1,
  "mobile": "233553554911",
  "network": "ISMART_TRANSFER",
  "type": "AIRTIME",
  "provider": "ISMART",
  "bundlecode": "12F785GH99730",
  "notes": "Ismart Global Testing",
  "country": "GH"
}

Responses​

request successful

Schema

    success booleanrequired
    code int32
    message string

    data

    object

    reference stringrequired

    reference no

    statuscode string

    request status

    notes string

    additional notes.

    property name* any
    trackid uuid
    stamp int32
Loading...