Blu Voucher

BluVoucher is a South African prepaid voucher. Customers buy a voucher for cash and use its PIN to pay online.

You can use BluVoucher as a Payment Method for:

REST APIWebSDKHosted Payment Page
Payments✅ Available⛔️ Unavailable⛔️ Unavailable
Verification✅ Available➖ N/A➖ N/A
Split Auth & Capture⛔️ Unavailable⛔️ Unavailable⛔️ Unavailable
Payouts⛔️ Unavailable⛔️ Unavailable⛔️ Unavailable
Refunds⛔️ Unavailable⛔️ Unavailable⛔️ Unavailable

Payment

The BR-DGE bluVoucher Payment Instrument can be used to redeem BluVoucher vouchers. BR-DGE takes the voucher PIN and sends it to BluVoucher to redeem.

The outcome of a voucher redemption is either CAPTURED or REJECTED.

BR-DGE StatusDescription
CAPTUREDIf the voucher is successfully redeemed, then the BR-DGE payment status will be set to CAPTURED.
REJECTEDIf the voucher could not be redeemed, the BR-DGE payment will be updated with a REJECTED status.

Payment API Examples

BluVoucher Redemption

BluVoucher vouchers must be redeemed in full. Set the amount to 0 to redeem the full value of the voucher, or send the exact voucher value. The amount redeemed is returned in the amount field of the API response.

🚧

Partial redemption is not permitted. A request for less than the voucher value is rejected with code 4804 (Partial voucher redemption not permitted).

Request

To create a BluVoucher payment, send a request similar to the following to the BR-DGE POST /v1/payments REST API Endpoint.

For a full view of all available API request fields please view the Create a Payment REST API endpoint documentation directly.

{
    "amount": 0,    
    "currencyCode": "ZAR",
    "paymentInstrument": {
        "type": "bluVoucher",
        "pin": "1616161616161616"
    }
}

Response

You should expect to receive a response similar to the below indicating whether the voucher redemption was successful, or not.

{
    "code": "1000",
    "message": "Approved",
    "id": "691ca00b78759f29aa82ec4597b2d512",
    "paymentId": "8f48a327-e043-4e91-ab07-e2d645a95c84",
    "pspId": "BLUVOUCHER",
    "customerOrderCode": "ff163246-eb94-4763-9a2a-f5d6d48b026e",
    "psp": {
        "name": "BluVoucher"
    },
    "amount": 2000,
    "currencyCode": "ZAR"
}

Verification

You can check a BluVoucher before redeeming it. A verification returns the voucher's status, serial number and value. It does not redeem the voucher.

Request

Send a request similar to the following to the BR-DGE POST /v1/payment-instrument-verifications REST API Endpoint.

{
    "psp": "BluVoucher",
    "verificationDetails": {
        "type": "bluVoucher",
        "pin": "1616161616161616"
    }
}

Response

verificationResult.status is ACTIVE for a voucher that can be redeemed. amount is the voucher value in South African Rand cents, so 2000 is R20.00.

{
    "id": "907e304694fbc72b1b53c9e0fc8dc031",
    "verificationId": "81f39986-2ff6-42e2-afec-6ea85b4658c3",
    "psp": "BluVoucher",
    "code": "1004",
    "message": "Request succeeded",
    "verificationResult": {
        "type": "bluVoucher",
        "status": "ACTIVE",
        "serial": "BL01F275FD64F2A7",
        "amount": 2000
    }
}
{
    "psp": "BluVoucher",
    "code": "4505",
    "message": "Voucher not found",
    "verificationResult": {
        "type": "bluVoucher",
        "status": "NOT_FOUND"
    }
}

Testing

If your BR-DGE sandbox retail channels are connected to the BR-DGE BluVoucher simulator, use the values below to trigger each scenario. Values not listed here will not match a test scenario.

🚧

These test values only work with the BR-DGE BluVoucher simulator. If your sandbox retail channels are connected to BluVoucher's own sandbox, these values will not work. Ask your contacts at BluVoucher for their sandbox test vouchers.

FlowScenarioTest valueExpected result
PaymentSuccessful redemptionpin: 1616161616161616, amount: 0 or 2000CAPTURED, code 1000, amount 2000 (R20.00)
PaymentPartial redemptionpin: 1616161616161616, amount: 1999REJECTED, code 4804 (Partial voucher redemption not permitted)
PaymentVoucher already redeemedpin: 1234123412341234REJECTED, code 4504 (Voucher Already Redeemed)
VerificationActive voucherpin: 1616161616161616Status ACTIVE, amount 2000 (R20.00)
VerificationVoucher already redeemedpin: 1234123412341234Status REDEEMED
VerificationVoucher not foundpin: 404404404404Status NOT_FOUND, code 4505

Onboarding & Support

To enable BluVoucher on your BR-DGE retail channels, please get in contact with support.


Did this page help you?