API Reference
Contact Us

Use the POST method to create a checkout page.

post
https://gateway-am.apps.okd.inswhubts.com/hostedcheckout/1.0/checkout

With a valid object representation, this endpoint allows creating a hosted checkout object.

This step is required before you use a hosted checkout page for making a payment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

The language to be used for the Checkout template.

Allowed:
integer

Time (in seconds) in which the payment expires if it is not completed.

integer

Time (in seconds) in which the customer can use the checkout page.

string

URL where the customer is redirected when payment is successful.

string

URL where the customer is redirected when payment is not successful.

string
enum
required

ISO-4217 Currency Code

string
enum
number
required

The amount of the payment, in units of the currency defined in currency.

purchaseItems
array of objects
length ≤ 10

Array with purchase items.

purchaseItems
entity

Customer Information

Headers
string

Header parameter to uniquely identifies the request. Must be supplied as an UUID.

date-time

Header parameter that informs the date and time when the message was originated. It is used for basic message integrity checks, to ensure that the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

string

It is used to send the pre-shared client API key to the server.

string
required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

Responses

Updated 7 months ago

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

Updated 7 months ago