Card Refund Returns

Card Refund Returns occur when a certain refund transaction is rejected during clearing by the issuer. In these rare occasions we are creating the respective Refund Return payments which are then notified to the merchant.

The following method IDs are covered in this section:

ID

Name

Credit/Debit State

333

ECMC Refund Return

ReturnedByProvider (279)

334

VISA Refund Return

ReturnedByProvider (279)

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

Notifications

The standard notification mechanism is used for notifying the merchant in the background (asynchronously) about payment state changes. For more information see PaymentStateChangedNotification.

Example handlePaymentStateChangedNotificationRequest for a Refund Return in ReturnedByProvider state:

<?xml version="1.0" encoding="utf-8"?>
<handlePaymentStateChangedNotificationRequest
    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>YourMerchantID</merchantID>
        <shopID>YourShopID</shopID>
        <paymentMethod>
            <key>333</key>
            <value>ECMC Refund Return/value>
        </paymentMethod>
        <merchantTransactionID>8a51e8c9-bf11-4393-8139-9b83aab0961f</merchantTransactionID>
        <paymentID>f1147803-edb4-48f1-a9dd-ac595e1341b9</paymentID>
        <userID>52658a81-1c4b-4b8e-b73a-ceb7cec94fa5</userID>
        <paymentProvider>
            <key>92</key>
            <value>CQRUK</value>
        </paymentProvider>
        <amount currencyCode="EUR">30.0000</amount>
        <creationType>
            <key>2</key>
            <value>Provider</value>
        </creationType>
        <userIP>195.72.132.1</userIP>
        <state>
            <id>d08ff23f-1374-47b6-ae92-ee4655f7911c</id>
            <definition>
                <key>279</key>
                <value>ReturnedByProvider</value>
            </definition>
            <createdOn>2014-12-15T11:39:22.867</createdOn>
            <paymentStateDetails xsi:nil="true" />
        </state>
        <isExecuted>true</isExecuted>
        <isExecutedSpecified>true</isExecuted>
        <baseAmount currencyCode="EUR">30.0000</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>1239876</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentID</key>
                <value>1263876</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentMerchantTransactionID</key>
                <value>19af31f4-361a-4df3-bd67-5d3a14f40120</value>
            </detail>
            <detail xsi:type="keyDecimalValuePair">
                <key>InterchangePercentage</key>
                <value>0</value>
            </detail>
            <detail xsi:type="keyIntValuePair">
                <key>OriginalPaymentMethodID</key>
                <value>89</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentMethodName</key>
                <value>ECMC Refund</value>
            </detail>
            <detail xsi:type="keyDecimalValuePair">
                <key>SettlementAmount</key>
                <value>30.0000</value>
            </detail>
            <detail xsi:type="keyIntValuePair">
                <key>SettlementCurrencyCode</key>
                <value>826</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>e766550c-b96d-4243-8f01-455386921a1e</paymentAccountID>
        </paymentAccount>
    </payment>
</handlePaymentStateChangedNotificationRequest>
<?xml version="1.0" encoding="utf-8"?>
<handlePaymentStateChangedNotificationRequest
    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>YourMerchantID</merchantID>
        <shopID>YourShopID</shopID>
        <paymentMethod>
            <key>334</key>
            <value>VISA Refund Return/value>
        </paymentMethod>
        <merchantTransactionID>8a51e8c9-bf11-4393-8139-9b83aab0961f</merchantTransactionID>
        <paymentID>f1147803-edb4-48f1-18dd-ac595e1341b9</paymentID>
        <userID>526582s1-1c4b-4b8e-b73a-ceb7cec94fa5</userID>
        <paymentProvider>
            <key>92</key>
            <value>CQRUK</value>
        </paymentProvider>
        <amount currencyCode="EUR">30.0000</amount>
        <creationType>
            <key>2</key>
            <value>Provider</value>
        </creationType>
        <userIP>195.72.132.1</userIP>
        <state>
            <id>d08ff23f-82f74-47b6-ae92-e23655f7911c</id>
            <definition>
                <key>279</key>
                <value>ReturnedByProvider</value>
            </definition>
            <createdOn>2014-11-15T11:39:22.867</createdOn>
            <paymentStateDetails xsi:nil="true" />
        </state>
        <isExecuted>true</isExecuted>
        <isExecutedSpecified>true</isExecuted>
        <baseAmount currencyCode="EUR">30.0000</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>12397656</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentID</key>
                <value>13863876</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentMerchantTransactionID</key>
                <value>19af31f4-361a-4df3-bd67-5d3a14f40120</value>
            </detail>
            <detail xsi:type="keyDecimalValuePair">
                <key>InterchangePercentage</key>
                <value>0</value>
            </detail>
            <detail xsi:type="keyIntValuePair">
                <key>OriginalPaymentMethodID</key>
                <value>88</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>OriginalPaymentMethodName</key>
                <value>VISA Refund</value>
            </detail>
            <detail xsi:type="keyDecimalValuePair">
                <key>SettlementAmount</key>
                <value>30.0000</value>
            </detail>
            <detail xsi:type="keyIntValuePair">
                <key>SettlementCurrencyCode</key>
                <value>826</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>e766550c-b96d-4243-8f01-455386921a1e</paymentAccountID>
        </paymentAccount>
    </payment>
</handlePaymentStateChangedNotificationRequest>