Provision vouchers by API

While tenants can use the voucher admin portal to create voucher programmes and provision vouchers they can also call a simple API to provision vouchers. This covers the common use case where tenants want to sell vouchers directly from their own platforms.

📘

Note

This scenario covers the provision of vouchers from a funded voucher organisation wallet. The tenant can also utilise Eclipse to collect funds for the payment of vouchers use the range of Eclipse payment capability. For more information please refer to Acquiring Use Cases.

Prerequisites

• Tenants needs to be onboarded as a Scan To Pay voucher partner and be added as an admin user to the Scan To Pay Voucher portal - contact your account manager for more details.
• JWT issued using the Scan To Pay Voucher portal admin user credentials.
• The following tenant configs must be set:
  • allowVoucherWallet - must be set to true
  • source.wallet.config.STP_VOUCHER.{orgId} - must be set to the wallet ID of the wallet from which voucher funds will be disbursed.
  • oltio.config.{orgId}.username - must be set the oltio config for the specific organization if not specified then it will pick tenant level config.
  • oltio.config.{orgId}.password- must be set the oltio config for the specific organization if not specified then it will pick tenant level config.
  • mustache.app.notification.body.{orgId}.program.{programId}- Required to send the notification and it will be configured on tenant level.
  • mustache.app.notification.title.{orgId}.program.{programId} - Required to send the notification and it will be configured on tenant level.
  • mustache.sms.{orgId}.program.{programId} - Required to send the notification and it will be configured on tenant level.
    To provision a voucher, tenants just need to call the POST wallets endpoint for wallet type STP_VOUCHER and pass in the following additional information:

Example request:

POST /eclipse-conductor/rest/v1/tenants/{tenantId}/organisations/{organisactionId}/wallets
{
  "configuration": [
    {
      "att": "voucherProgramme",
      "val": "123445343"
    },
    {
      "att": "voucherValue",
      "val": "10"
    },
    {
      "att": "voucherPhoneNumber",
      "val": "27727863453"
    },
    {
      "att": "createVoucherPin",
      "val": "TRUE"
    }
  ],
  "description": "STP Voucher Wallet 1",
  "externalUniqueId": "123456789013543533534534",
  "name": "STP Voucher Wallet 1",
  "status": "ACTIVE",
  "walletTypeId": 7264
}

📘

Note

A provisioned voucher creates a wallet on Eclipse as well as provisions the voucher to Scan to Pay user identified by phone number so that is it available for use in the STP App. In some scenarios tenants may only want to create wallets in Eclipse and then use voucher pin for redemption. In these scenarios wallet attribute provisionStpVoucher can be included and set to false and the voucherPhoneNumber attribute is then optional.