These set of APIs allows the platforms to create, manage and delete consumers.

  • To create multi currency virtual accounts, platforms are required to create consumers first.
  • A consumer is the primary owner of the multi-currency virtual account and each multi-currency virtual account is uniquely tagged to a consumer
  • One consumer can have own more than one multi-currency virtual account but it is recommended for platforms to maintain a one to one mapping between virtual account and consumer. This eases ledger maintenance and reconciliation at platform's side.

There are a total of 4 consumer APIs that helps platforms create, update, get and delete consumers. These are:

  1. Create Consumer - This API allows platforms to create a consumer. To do this platforms need to pass the following details in the API request:
    1. Reference id
    2. Name
    3. Mobile
    4. Email address
    5. Narration
    6. Country code
  2. Update Consumer - This API allows platforms to update the details of an existing consumer. To do this, the platforms need to pass the consumer unique reference number in the path parameter, the field name and its updated value in the request body.
  3. Get Consumer - This API allows platforms to get the details of an existing consumer. To do this, the platforms need to pass the consumer unique reference number in the path parameter.
  4. Delete Consumer - This API allows platforms to delete an existing an consumer. To do this, the platforms need to pass the consumer unique reference number in the path parameter.