Getting started with Provisioning

Provisioning in PPaaS involves the process of creating, maintaining, updating, and deleting a merchant, organization, store, physical and logical devices.

To understand about bulk provisioning, see Getting started with Bulk Provisioning

Important: Deleting an entity is only allowed when it does not have any dependency. For example, you can only delete a merchant, if there is no store attached to it. PPaaS provides a set of provisioning APIs to manage each use case.

Merchant provisioning

Merchant provisioning includes creating, maintaining, updating, and deleting a merchant in PPaaS system. This includes the following scenarios:

  • Create a merchant: to create a merchant
  • Read merchant details: to view a merchant by the unique identifier
  • Edit a merchant: to update a merchant detail by its unique identifier
  • Delete a merchant: to delete a merchant label by the unique identifier

Store provisioning

Store provisioning includes creating, maintaining, updating, and deleting a store in PPaaS system. This includes the following use cases:

  • Create a store: to create a store
  • Read store details: to view a store by its unique identifier
  • Edit a store: to edit a store by its unique identifier
  • Delete a store: to delete a store by its unique identifier

Logical device provisioning

Logical device provisioning includes creating, maintaining, updating, and deleting a logical device in PPaaS system. This includes the following use cases:

  • Create a logical device: to create a logical device
  • Read logical device details: to view a logical device by its unique identifier
  • Edit a logical device: to edit a logical device by its unique identifier
  • Delete a logical device: to delete a logical device by its unique identifier

Physical device provisioning

Physical device provisioning includes creating, maintaining, updating, and deleting a physical device in PPaaS system. This includes the following use cases.

  • Create a physical device: to create a physical device
  • Read physical device details: to view a physical device by its unique identifier
  • Edit a physical device: to edit a physical device by its unique identifier
  • Delete a physical device: to delete a physical device by its unique identifier

Note that you can delete a physical device only when no logical device is attached to the physical device. A logical device is a configuration holder for a physical device.

The links can only be established between an existing logical device unique identifier and physical device unique identifier.

Getting started with Bulk Provisioning

PPaaS offers the bulk provisioning feature, allowing PPaaS clients to provision multiple entities such as; merchants, stores, logical as well as physical devices at the same time to PPaaS.

When you intend to bulk upload the details, make sure that you use the .csv template. After you enter the details of the required entities, upload the .csv file to PPaaS and then launch a provisioning campaign. Once the process is successful, you can download a detailed report of the provisioning campaign. The report includes unique identifiers of the created elements and errors that occurred during the process.

Follow these steps and load bulk data from a .csv file:

  • Request a template for the required type of bulk provisioning
  • Post a .csv file with the bulk data to provision for the required entity type
  • Get the list of possible campaigns to launch and the details of a specific campaign
  • Request to start/abort a campaign
  • Request report for a campaign
  • Download a campaign file
  • Delete campaign
All the external references to PPaaS in the submitted file must be unique. If the reference is already available in the database, PPaaS does not create a new or a duplicate entry; it modifies the existing reference with the updated details.

Creating a child organization

The concept of a child organization conveys the fact that there is an organization (called as a child organization) under the PPaaS client. Hence in this scenario, child organization will then further have its own merchants which would be indirect merchants to the MA organization.

PPaaS offers APIs to:

  • Creating & managing a child organization
  • Merchant provisioning for child organization
  • Store provisioning for child organization
  • Logical device provisioning for child organization
  • Physical device provisioning for child organization

Creating & managing a child organization

This includes creating, maintaining, updating, and deleting a child organization in PPaaS system. This includes the following scenarios:

  • Create a child organization: to create a child organization
  • Read a child organization: to read child organization details
  • Update a child organization: to update a child organization
  • Delete a child organization: to delete a child organization

Merchant provisioning for child organization

Merchant provisioning includes creating, maintaining, updating, and deleting a merchant in PPaaS system. This includes the following scenarios:

  • Create a merchant: to create a merchant
  • Read merchant details: to view a merchant by its unique identifier
  • Edit a merchant: to update a merchant detail by its unique identifier
  • Delete a merchant: to delete a merchant label by its unique identifier

Store provisioning for child organization

Store provisioning includes creating, maintaining, updating, and deleting a store in PPaaS system. This includes the following use cases:

  • Create a store: to create a store
  • Read store details: to view a store by its unique identifier
  • Edit a store: to edit a store by its unique identifier
  • Delete a store: to delete a store by its unique identifier

Logical device provisioning for child organization

Logical device provisioning includes creating, maintaining, updating, and deleting a logical device in PPaaS system. This includes the following use cases:

  • Create a logical device: to create a logical device
  • Read logical device details: to view a logical device by its unique identifier
  • Edit a logical device: to edit a logical device by its unique identifier
  • Delete a logical device: to delete a logical device by its unique identifier

Physical device provisioning for child organization

Physical device provisioning includes creating, maintaining, updating, and deleting a physical device in PPaaS system. This includes the following use cases:

  • Create a physical device: to create a physical device
  • Read physical device details: to view a physical device by its unique identifier
  • Edit a physical device: to edit a physical device by its unique identifier
  • Delete a physical device: to delete a physical device by its unique identifier

Creating merchant, store, and device using single API (minimum provisioning)

Minimum provisioning APIs are designed for the following scenarios:

• If the MA organization wishes to do the provisioning of organization, merchants, stores, and devices in one go • Or, if MA organization has only one store and one device for any given merchant

It contains two APIs:

Creation of merchant, store, and device

In case information pertaining to physical and logical devices exists, this API can complete the provisioning which also include provisioning of the mapping of the device mapping.

Attaching physical device with logical device

In case information pertaining to device mapping isn’t available, this API can be used to do the mapping between physical & logical devices. This, once the physical device is delivered to the merchant and is activated by the merchant.