Skip to main content

API Overview

The API consists of 5 main endpoints. See next guides on the particulars of how to use them in different flows. Please follow the guides in this section before jumping to the API endpoints documentation, as the guide will give you essential business context.

  • Get Products - This API allows you to get a list of products assigned to the merchant. This API is not required to be called during every sequence because the product catalogue changes infrequently. Partners may choose to implement a efficient mechanism to cache the product definitions.
  • Create Order - This API allows you to create an order. After calling this API, the order line items are reserved/added to the cart and the total amount of the order is authorized from the merchant's wallet. At this stage, the order will be in a pending state.
  • Complete Order - This API allows you to fulfill the order. In response, the order line items are received which are to be sent to the user or next steps to be taken to complete the order. At this point, the authorized amount is captured from the merchant's wallet.
  • Usage Check - This API allows you to check usage for any completed order.
  • Notify User - This API allows the merchant to let MobiMatter deliver the purchase via email.

See the integration outline chart below, nodes in blue represent MobiMatter API endpoints.

lifecycle