lookupMsisdn

Looks up information associated with the given Msisdn. This includes such information as available products and promotions, operator information etc.

SecurityhttpBasic or oauth2

Request

query Parameters

msisdn required	string The Msisdn. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en).
senderMsisdn	string The sender Msisdn. The MSISDN from which the request originated. This must conform to the ITU E.164 numbering plan (https://www.itu.int/rec/T-REC-E.164/en).
operator	string The provider who processed the original purchase attempt.
productType	string Used to filter the products to lookup for a given msisdn. This should be a value appropriate for the `Product.type` field.
channelName	string Used to filter the products to lookup for a given channel.
productCategory	string Used to filter the products to lookup within a specific category. The `productType` field should be used preferentially if applicable. An example of a relevant `productCategory` would be the name of a promotion if only products within a specific promotion should be retrieved.

Responses

200

400

Bad request

404

Not found

500

Internal server error

503

Service unavailable

504

Gateway timeout

get/msisdn

Request samples

curl
Java
Node.js

Response samples

application/json

{"msisdn": {"msisdn": "string",
"country": "st",
"operator": {"id": "string",
"name": "string"
}
},
"senderMsisdn": {"msisdn": "string",
"country": "st",
"operator": {"id": "string",
"name": "string"
}
},
"amounts": {"requestAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"approvedAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"feeAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"balanceAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"additionalAmounts": {"property1": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"property2": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
}
},
"promotion": {"promotion": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"availableProducts": [{"isDirectTopup": false,
"productId": "string",
"barcode": "string",
"name": "string",
"description": {"additionalDescriptions": {"property1": "string",
"property2": "string"
},
"primaryDescription": "string",
"shortDescription": "string"
},
"type": "AIRTIME_FIXED",
"wholesalePrice": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"recipientAmount": {"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
},
"productValues": [{"amount": 0,
"currency": "string",
"ledgerIndicator": "DEBIT"
}
],
"validityPeriod": {"duration": 0,
"durationUnit": "NANOS"
},
"productContents": [{"amount": 0,
"unit": "KB"
}
],
"operator": {"id": "string",
"name": "string"
},
"channels": [{"channelName": "string",
"productDisplayName": "string",
"productDisplayCategory": "string",
"productDisplaySortOrder": 0,
"channelProductIdentifier": "string"
}
]
}
]
}