Remote API - hosted menu session

Returns a single-use URL to the Scan to Pay hosted biller menu for the consumer. Call it from the wallet back end, then open the URL as given in a webview before expiresIn elapses. When the consumer completes the menu, the webview is redirected to the wallet's deep link with the payment reference, which is then paid as a scanned QR code.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
^[1-9]\d{8,16}

MSISDN (mobile number) of the consumer in international format. Either msisdn or clientIdentifier is required.

string
length between 0 and 100

Client Identifier. Either msisdn or clientIdentifier is required.

string
^(ACCOUNTS|PREPAID|DONATIONS)$

Optional. Limits the hosted menu to one group. All configured groups are shown when omitted.

string
^[A-Za-z0-9_-]{16,128}$

Optional opaque value generated by the wallet. It is appended to the deep link that returns the consumer to the app, so the app can check the callback belongs to the session it started.

Responses

400

Invalid request

401

Not Authenticated

403

Not Authorized

500

Internal Server Error

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json