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:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cqrpayments.com/PaymentProcessing">
    <merchantID>B2BTestMerchant</merchantID>
    <shopID>150001</shopID>
    <merchantTransactionID>d2a278fb-0238-4100-a1e4-ea99f4ef074a4</merchantTransactionID>
    <paymentMethodID>340</paymentMethodID>
    <userID>B2BTestUser</userID>
    <userData>
        <username>B2BTestUser</username>
    </userData>
    <userIP>127.0.0.1</userIP>
    <userSessionID>7c191daf-1d0b-42f4-a87c-528744c97e64</userSessionID>
    <creationTypeID>1</creationTypeID>
    <paymentAccount>
        <specificPaymentAccountData>
            <data xsi:type="keyStringValuePair">
                <key>PIN</key>
                <value>5256584245111159</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>ProviderTesting</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>d2a278fb-0238-4100-a1e4-ea99f4ef074a8</merchantTransactionID>
        <paymentID>576d5d49-143a-4acc-a00a-2fd60ae009ad</paymentID>
        <userID>B2BTestUser</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="ZAR">10</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>5e2d30e4-83ce-4887-a3d6-150f2dcd678a</id>
            <definition>
                <key>142</key>
                <value>ExecutedByProvider</value>
            </definition>
            <createdOn>2019-06-04T06:30:33.6252909Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>0000</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>04 Jun 08:30;Ref: 732515228;Shop: SPORTING BE;;Transaction Successful;1Voucher PIN Loaded;Amount: R10.00;www.1voucher.co.za;</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>true</isExecuted>
        <baseAmount currencyCode="EUR">1</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>732515228</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>1714401</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>47e5e61a-96d7-4fb2-b89d-83224affc693</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>ProviderTesting</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>d2a278fb-0238-4100-a1e4-ea99f4ef074a4</merchantTransactionID>
        <paymentID>ebf5588b-6337-4b14-992a-ac60ad6ac7b6</paymentID>
        <userID>B2BTestUser</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="EUR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>0983107d-2521-40fc-bbb7-6e316b8adf6e</id>
            <definition>
                <key>143</key>
                <value>ExecuteErrorReportedByProvider</value>
            </definition>
            <createdOn>2019-06-04T06:25:43.5483648Z</createdOn>
            <description>VoucherUsed</description>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>1824</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>VoucherUsed</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>732515224</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>1714397</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>4e2f95a5-adfd-4233-8aa9-f9ff7a203e35</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>ProviderTesting</shopID>
        <paymentMethod>
            <key>340</key>
            <value>Flash1VoucherDeposit</value>
        </paymentMethod>
        <merchantTransactionID>d2a278fb-0238-4100-a1e4-ea99f4ef074a9</merchantTransactionID>
        <paymentID>5ad0701d-de62-422d-993d-e48145516635</paymentID>
        <userID>B2BTestUser</userID>
        <paymentProvider>
            <key>180</key>
            <value>Flash</value>
        </paymentProvider>
        <amount currencyCode="EUR">0</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>3cbf549c-47bb-4ec3-b056-b37a5f565201</id>
            <definition>
                <key>587</key>
                <value>UserAuthenticationFailed</value>
            </definition>
            <createdOn>2019-06-04T06:45:45.3283079Z</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>1714404</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>47e5e61a-96d7-4fb2-b89d-83224affc693</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