1Voucher
1Voucher is a South African prepaid voucher provided by Flash. Customers buy a voucher for cash and use its PIN to pay online.
You can use 1Voucher as a Payment Method for:
| REST API | WebSDK | Hosted Payment Page | |
|---|---|---|---|
| Payments | ✅ Available | ⛔️ Unavailable | ⛔️ Unavailable |
| Split Auth & Capture | ⛔️ Unavailable | ⛔️ Unavailable | ⛔️ Unavailable |
| Payouts | ⛔️ Unavailable | ⛔️ Unavailable | ⛔️ Unavailable |
| Refunds | ⛔️ Unavailable | ⛔️ Unavailable | ⛔️ Unavailable |
Payment
The BR-DGE oneVoucher Payment Instrument can be used to redeem 1Voucher vouchers. BR-DGE takes the voucher PIN and sends it to Flash to redeem.
The outcome of a voucher redemption is either CAPTURED or REJECTED.
| BR-DGE Status | Description |
|---|---|
CAPTURED | If the voucher is successfully redeemed, then the BR-DGE payment status will be set to CAPTURED. |
REJECTED | If the voucher could not be redeemed, the BR-DGE payment will be updated with a REJECTED status. |
Payment API Examples
1Voucher Redemption
Set the amount to 0 to redeem the full value of the voucher. The amount redeemed is returned in the amount field of the API response.
Request
To create a 1Voucher 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": "oneVoucher",
"pin": "1111222233331000"
}
}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": "FLASH",
"customerOrderCode": "ff163246-eb94-4763-9a2a-f5d6d48b026e",
"psp": {
"name": "Flash"
},
"amount": 100,
"currencyCode": "ZAR"
}Testing
If your BR-DGE sandbox retail channels are connected to the BR-DGE 1Voucher 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 1Voucher simulator. If your sandbox retail channels are connected to Flash's own sandbox, these values will not work. Ask your contacts at Flash for their 1Voucher sandbox test vouchers.
| Flow | Scenario | Test value | Expected result |
|---|---|---|---|
| Payment | Successful redemption | pin: 1111222233331000, amount: 0 | CAPTURED, code 1000, amount 100 |
| Payment | Voucher already used | pin: 1111222233334205, amount: 0 | REJECTED, code 4285 (Do not honor) |
Onboarding & Support
To enable 1Voucher on your BR-DGE retail channels, please get in contact with support.
Updated 9 days ago
