Flash1VoucherDeposit

Flash1VoucherDeposit is a popular voucher payment method allowing user to purchase vouchers at various outlets in South Africa.

The following method IDs are covered in this section:

ID	Name	Credit/Debit State
340	Flash1VoucherDeposit	ExecutedByProvider

Payment method interaction type: Synchronous call (see Interaction Types).

Redirect Integration

Cashier support is not available at the moment.

Backend2BackendIntegration

The following parameters can be provided in initiatePaymentRequest.specificPaymentAccountData:

key (value type, account type, required)	value
PIN (string)	The Voucher PIN.

Example initiatePaymentRequest:

<initiatePaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
    <merchantID>B2BTestMerchant</merchantID>
    <shopID>FlashApiV4ProviderShop</shopID>
    <merchantTransactionID>{{merchantTransactionID}}</merchantTransactionID>
    <paymentMethodID>340</paymentMethodID>
     <amount currencyCode="zar">0</amount>
    <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
    <userData>
        <username>ccd13196-9e96-49e7-9782-6fe575</username>
    </userData>
    <userIP>127.0.0.1</userIP>
    <userSessionID>e23359da-a786-43b5-9af7-c30e6920b478</userSessionID>
    <creationTypeID>1</creationTypeID>
    <paymentAccount>
        <specificPaymentAccountData>
            <data xsi:type="keyStringValuePair">
                <key>PIN</key>
                <value>1190822372720054</value>
            </data>
        </specificPaymentAccountData>
    </paymentAccount>
</initiatePaymentRequest>

Example initiatePaymentResponse successful payment:

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>FlashApiV4ProviderShop</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>hc-20250304-152434</merchantTransactionID>
        <paymentID>efca30f2-92c5-4699-befc-3da3b8ab9b99</paymentID>
        <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">20</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>b62952b9-bcd0-458c-b551-9095cbf0910a</id>
            <definition>
                <key>142</key>
                <value>ExecutedByProvider</value>
            </definition>
            <createdOn>2025-03-04T14:24:38.2265034Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>0</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>Success</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>true</isExecuted>
        <baseAmount currencyCode="EUR">1.51</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>11023220</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>E0001721</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>749a6431-759b-4e2b-a4d0-201bc099f333</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

Example initiatePaymentResponse unsuccessful payment:

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>FlashApiV4ProviderShop</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>hc-20250304-154143</merchantTransactionID>
        <paymentID>6b9e5270-a4fe-42a9-bb63-06e0089ddf4c</paymentID>
        <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>4449621f-f2f0-417b-a04c-5c2b53358007</id>
            <definition>
                <key>143</key>
                <value>ExecuteErrorReportedByProvider</value>
            </definition>
            <createdOn>2025-03-04T14:41:45.3002705Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>2401</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>The voucher you have entered has already been used, please use another voucher pin.</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">0</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>11023221</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>E0001722</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>749a6431-759b-4e2b-a4d0-201bc099f333</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>FlashApiV4ProviderShop</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>hc-20250304-171108</merchantTransactionID>
        <paymentID>9b0a8c7a-5d7e-4908-bf70-50c50cf518e3</paymentID>
        <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>7e9251bc-c9d6-463e-9051-f3bc219f25f6</id>
            <definition>
                <key>339</key>
                <value>ExecuteRequestSentToProviderCommunicationErrorOccured</value>
            </definition>
            <createdOn>2025-03-04T16:11:09.8985966Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">0</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>E0001731</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>070ab3e2-2dde-4286-90ab-1bdc3b99edbf</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>FlashApiV4ProviderShop</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>hc-20250304-155720</merchantTransactionID>
        <paymentID>3420b221-542a-40bf-bb44-75571627f35b</paymentID>
        <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>84acc819-e394-4fdd-a97f-fc6158d5a94b</id>
            <definition>
                <key>143</key>
                <value>ExecuteErrorReportedByProvider</value>
            </definition>
            <createdOn>2025-03-04T14:57:22.5099798Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>2403</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>The voucher you have entered has been cancelled.</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">0</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>11023223</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>E0001724</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>db916ebe-a97c-46de-9fc6-c7c1f540a73a</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>FlashApiV4ProviderShop</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>hc-20250304-160201</merchantTransactionID>
        <paymentID>35c4be3e-b6fd-4770-8b3c-03212276c171</paymentID>
        <userID>ccd13196-9e96-49e7-9782-6fe575</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>9cd124fb-8bb9-4158-baff-b7e793a220ff</id>
            <definition>
                <key>143</key>
                <value>ExecuteErrorReportedByProvider</value>
            </definition>
            <createdOn>2025-03-04T15:02:04.1285914Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>2405</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>The voucher you have entered has expired.</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">0</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>11023225</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>E0001726</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>070ab3e2-2dde-4286-90ab-1bdc3b99edbf</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

Payment State	Description
ExecutedByProvider (142)	Success state; Redirect user to SuccessPage,
UserAuthenticationFailed (28)	Error state; Technical error due to incorrect credentials at merchant
ExecuteErrorReportedByProvider (324)	Error state; Communication error during payment finalization

Error codes (v4 API)

2400 3rd party system error
2401 The voucher you have entered has already been used, please use another voucher pin.
2402 The voucher you have entered could not be found
2403 The voucher you have entered has been cancelled
2405 The voucher you have entered has expired
2406 Amount entered is too small
2408 Amount entered is too large
2409 The voucher has already been cancelled
2410 Refund amount does not match the redemption amount
2412 The voucher you have entered cannot be reversed
2413 The voucher has already been reversed
2414 The voucher cannot be cancelled

QA Environment (v4 API)

These test vouchers are for testing failed cases:

Cancelled - 1148012471316791

Invalid- 11919009804153931

Expired - 1349050685110149

Already used -1107477562497306

Invalid/Not found - 1807477522497507

Please reach out to your PXP contact for test vouchers for successful payments.