Card Withdrawals - Payper

The following method IDs are covered in this section:

IDNameCredit/Debit StateReversal State
12VISA WithdrawalWithdrawnByProviderCancelled(113)
38ECMC WithdrawalWithdrawnByProviderCancelled(113)

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

Redirect Integration

Not applicable.

Backend2Backend Integration

The following table contains the fields to be sent in the initiatePaymentRequest.specificPaymentAccountData xml section for card withdrawals:

key (value type, account type, required)value
CardNumber
(string,Cards, required)
PAN, e.g. 4111111111111111
HolderName
(string,Cards, required)
Card holder name, e.g. John Doe
ExpiryMonth
(string,Cards, required)
Expiration month of the card, e.g. 12
ExpiryYear
(string,Cards, required)
Expiration year of the card, e.g. 2019

Example initiatePaymentRequest for Card Withdrawal (VISA):

<?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>{{merchant}}</merchantID>
    <shopID>{{shop}}</shopID>
    <merchantTransactionID>{{merchantTransactionID}}</merchantTransactionID>
    <paymentMethodID>12</paymentMethodID>
    <amount currencyCode="CAD">40.01</amount>
    <userID>{{newUserID}}</userID>
    <userData>
        <username>{{newUserName}}</username>
        <firstname>HC</firstname>
        <lastname>Ko</lastname>
        <currencyCode xsi:nil="true" />
        <languageCode xsi:nil="true" />
        <email>{{newUserEmail}}</email>
        <address>
            <street>4737 Yonge Street</street>
            <houseName xsi:nil="true" />
            <houseNumber xsi:nil="true" />
            <houseNumberExtension xsi:nil="true" />
            <postalCode>M4W 1J7</postalCode>
            <city>Toronto</city>
            <state>ON</state>
            <countryCode2>CA</countryCode2>
            <telephoneNumber>+14165152886</telephoneNumber>
        </address>
    </userData>
    <userIP>127.0.0.1</userIP>
    <userSessionID>742f374a-08ec-4b1d-ad13-8acf6005ec6f</userSessionID>
    <creationTypeID>1</creationTypeID>
    <specificPaymentData>
            <data xsi:type="keyStringValuePair">
                <key>PaymentDescription</key>
                <value>some description</value>
            </data>
            <data xsi:type="keyStringValuePair">
                <key>PaymentDescriptionLanguageCode</key>
                <value>en</value>
            </data>
            <data xsi:type="keyIntValuePair">
                <key>PaymentProviderID</key>
                <value>204</value>
            </data>
        </specificPaymentData>
        <paymentAccount>
            <specificPaymentAccountData>
                <data xsi:type="keyStringValuePair">
                    <key>CardNumber</key>
                    <value>4111111372680044</value>
                </data>
                <data xsi:type="keyStringValuePair">
                    <key>CardVerificationCode</key>
                    <value>111</value>
                </data>
                <data xsi:type="keyStringValuePair">
                    <key>HolderName</key>
                    <value>John Doe</value>
                </data>
                <data xsi:type="keyIntValuePair">
                    <key>ExpiryMonth</key>
                    <value>1</value>
                </data>
                <data xsi:type="keyIntValuePair">
                    <key>ExpiryYear</key>
                    <value>2033</value>
                </data>
            </specificPaymentAccountData>
        </paymentAccount>
</initiatePaymentRequest>

Example initiatePaymentRequest for Card Withdrawal (Mastercard):

<?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>{{merchant}}</merchantID>
    <shopID>{{shop}}</shopID>
    <merchantTransactionID>{{merchantTransactionID}}</merchantTransactionID>
    <paymentMethodID>38</paymentMethodID>
    <amount currencyCode="CAD">40.01</amount>
    <userID>{{newUserID}}</userID>
    <userData>
        <username>{{newUserName}}</username>
        <firstname>HC</firstname>
        <lastname>Ko</lastname>
        <currencyCode xsi:nil="true" />
        <languageCode xsi:nil="true" />
        <email>{{newUserEmail}}</email>
        <address>
            <street>4737 Yonge Street</street>
            <houseName xsi:nil="true" />
            <houseNumber xsi:nil="true" />
            <houseNumberExtension xsi:nil="true" />
            <postalCode>M4W 1J7</postalCode>
            <city>Toronto</city>
            <state>ON</state>
            <countryCode2>CA</countryCode2>
            <telephoneNumber>+14165152886</telephoneNumber>
        </address>
    </userData>
    <userIP>127.0.0.1</userIP>
    <userSessionID>742f374a-08ec-4b1d-ad13-8acf6005ec6f</userSessionID>
    <creationTypeID>1</creationTypeID>
    <specificPaymentData>
            <data xsi:type="keyStringValuePair">
                <key>PaymentDescription</key>
                <value>some description</value>
            </data>
            <data xsi:type="keyStringValuePair">
                <key>PaymentDescriptionLanguageCode</key>
                <value>en</value>
            </data>
            <data xsi:type="keyIntValuePair">
                <key>PaymentProviderID</key>
                <value>204</value>
            </data>
        </specificPaymentData>
        <paymentAccount>
            <specificPaymentAccountData>
                <data xsi:type="keyStringValuePair">
                    <key>CardNumber</key>
                    <value>5266248793296818</value>
                </data>
                <data xsi:type="keyStringValuePair">
                    <key>CardVerificationCode</key>
                    <value>111</value>
                </data>
                <data xsi:type="keyStringValuePair">
                    <key>HolderName</key>
                    <value>John Doe</value>
                </data>
                <data xsi:type="keyIntValuePair">
                    <key>ExpiryMonth</key>
                    <value>1</value>
                </data>
                <data xsi:type="keyIntValuePair">
                    <key>ExpiryYear</key>
                    <value>2033</value>
                </data>
            </specificPaymentAccountData>
        </paymentAccount>
</initiatePaymentRequest>

States reached after initiatePaymentRequest

StateDetailsDescription
InitiatedByProviderPayment accepted by Payper for payout
PreInitiateErrorReportedByProviderProviderErrorResponseCode and ProviderErrorResponseMessageError state on first call
PreInitiateRefusedByProviderRefusal state on first call
PreInitiateRequestCommunicationErrorOccurredCommunication error on first call
InitiateErrorReportedByProviderProviderErrorResponseCode and ProviderErrorResponseMessageError state on second call
InitiateRefusedByProviderRefusal state on second call
InitiateRequestProviderCommunicationErrorOccurredCommunication error on second call

Example initiatePaymentResponse for Card Withdrawal - InitiatedByProvider:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayperGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>7c2fb06f-2639-4ad8-83c9-f83f57bf2e88</merchantTransactionID>
	<paymentID>b26cc86b-e123-4a86-97c6-124c681ea86c</paymentID>
	<userID>33bd3a12-9c62-497a-88b1-44a27d</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">10</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>3f2b1c28-dbae-42d1-bee5-0db554d9072b</id>
		<definition>
			<key>3</key>
			<value>InitiatedByProvider</value>
		</definition>
		<createdOn>2023-11-08T16:16:15.761915Z</createdOn>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">7.22</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderTransactionID</key>
			<value>483625689495936188614598450693</value>
		</detail>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120673</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>627456f8-b7c8-4e3e-9895-28eb5b66a504</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>AT</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Credit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value/>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - InitiatedByProvider (with Approval code)

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.cqrpayments.com/PaymentProcessing">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>PayperGWMockShop</shopID>
        <paymentMethod>
            <key>12</key>
            <value>VISA Withdrawal</value>
        </paymentMethod>
        <merchantTransactionID>21410e44-4dbd-4e5b-9010-4abd01fa7fd3</merchantTransactionID>
        <paymentID>ade9067c-8aed-4a4c-91dd-88e08b879274</paymentID>
        <userID>329719ce-9ce7-4e1e-9cee-8f18b4</userID>
        <paymentProvider>
            <key>204</key>
            <value>Payper</value>
        </paymentProvider>
        <amount currencyCode="CAD">10</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.0</userIP>
        <state>
            <id>20561a24-834e-4d41-ade5-76a2fc3d1ec3</id>
            <definition>
                <key>3</key>
                <value>InitiatedByProvider</value>
            </definition>
            <createdOn>2024-03-08T09:31:23.0276063Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ApprovalCode</key>
                    <value>123456</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>100</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>Transaction was approved.</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">7.22</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>596209065100833643409169023037</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>170702</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>5b785708-9461-4a0b-981f-e7e7698045c4</paymentAccountID>
            <details>
                <detail xsi:type="keyStringValuePair">
                    <key>IssuerCountry</key>
                    <value>AT</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>AccountFundingSource</key>
                    <value>Credit</value>
                </detail>
                <detail xsi:type="keyBooleanValuePair">
                    <key>FastFunds</key>
                    <value>false</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>IssuerName</key>
                    <value />
                </detail>
            </details>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - PreInitiateErrorReportedByProvider:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayPerGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>a18db658-2d7e-41c4-80c5-4f62d69ca450</merchantTransactionID>
	<paymentID>196c664b-9d32-4a1e-874b-1525efd07224</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">99.01</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>decb5436-9bf9-4529-87bc-3dcaab4a2de6</id>
		<definition>
			<key>329</key>
			<value>PreInitiateErrorReportedByProvider</value>
		</definition>
		<createdOn>2023-11-08T16:08:29.3293902Z</createdOn>
		<description>Unexpected Response with tx_action=request and status=invalid</description>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderErrorResponseCode</key>
				<value>1107</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderErrorResponseMessage</key>
				<value>first name not defined!</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">71.5</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120666</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>d390cc44-6464-4573-8951-a490be7e3ffe</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>GB</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>UNKNOWN</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - PreInitiateRefusedByProvider:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
                         xmlns:xsd=http://www.w3.org/2001/XMLSchema
                         xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment
         xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayPerGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>9d2ea8dd-2a9b-40c7-b0e8-ba7db1ac1d27</merchantTransactionID>
	<paymentID>c9edafb2-bc6d-4e07-8021-04ec87be4a20</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">99.01</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>9fd2805b-bc9a-4f30-a0dc-e39b20fff5bc</id>
		<definition>
			<key>636</key>
			<value>PreInitiateRefusedByProvider</value>
		</definition>
		<createdOn>2023-11-08T16:09:42.549141Z</createdOn>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">71.5</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderTransactionID</key>
			<value>769098609896327092929153939856</value>
		</detail>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120667</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>9ad31b03-3170-4618-83d2-a7ab8a7e3b2b</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>GB</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>UNKNOWN</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - PreInitiateRequestCommunicationErrorOccurred:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
                         xmlns:xsd=http://www.w3.org/2001/XMLSchema
                         xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment
         xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayPerGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>6f5d7cef-fcbc-4cae-a3bb-618f114f496b</merchantTransactionID>
	<paymentID>9ac0ce39-ad63-4349-a461-6ce539d5bf9e</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">99.01</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>4ef72829-4d06-4e0e-a41c-269f5ae4177f</id>
		<definition>
			<key>334</key>
			<value>PreInitiateRequestCommunicationErrorOccurred</value>
		</definition>
		<createdOn>2023-11-08T16:12:09.6163371Z</createdOn>
		<description>Error occurred while processing payment communication for Payment[ID='49520698'].</description>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">71.5</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120670</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>35d06822-f258-4491-b248-c892d508a4f5</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>GB</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>UNKNOWN</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - InitiateRefusedByProvider:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
                         xmlns:xsd=http://www.w3.org/2001/XMLSchema
                         xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment
         xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayPerGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>1821858b-6fa7-4710-b52e-c273cd06050c</merchantTransactionID>
	<paymentID>b66b39ba-6af3-4947-a247-d301df308ff2</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">99.01</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>446e3c59-5594-47fc-8252-d572f0fad3b9</id>
		<definition>
			<key>550</key>
			<value>InitiateRefusedByProvider</value>
		</definition>
		<createdOn>2023-11-08T16:13:11.5401729Z</createdOn>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">71.5</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderTransactionID</key>
			<value>811541226145033114206895148325</value>
		</detail>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120671</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>620366b7-1217-4880-8e3b-16a8d02f95c1</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>GB</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>UNKNOWN</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - InitiateRefusedByProvider (with ApprovalCode):

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://www.cqrpayments.com/PaymentProcessing">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>B2BTestMerchant</merchantID>
        <shopID>PayPerGWMockShop</shopID>
        <paymentMethod>
            <key>12</key>
            <value>VISA Withdrawal</value>
        </paymentMethod>
        <merchantTransactionID>64ebd9ba-83bc-4ab0-8b46-dcd5d4bc1420</merchantTransactionID>
        <paymentID>63674a2a-4ab4-47f7-bd4f-3909e5ce9b34</paymentID>
        <userID>PayperCCUserWithAddr</userID>
        <paymentProvider>
            <key>204</key>
            <value>Payper</value>
        </paymentProvider>
        <amount currencyCode="CAD">99.01</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.0</userIP>
        <state>
            <id>e6a530a9-33d5-41fa-9c8a-83d1470ad85a</id>
            <definition>
                <key>550</key>
                <value>InitiateRefusedByProvider</value>
            </definition>
            <createdOn>2024-03-08T09:34:47.9439651Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>ApprovalCode</key>
                    <value>987654</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseCode</key>
                    <value>200</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderResponseMessage</key>
                    <value>Transaction was declined by processor.</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">71.5</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>408317729979461357468552936148</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>170704</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>7590b350-31a3-4141-bb0b-1a25f71f7caf</paymentAccountID>
            <details>
                <detail xsi:type="keyStringValuePair">
                    <key>IssuerCountry</key>
                    <value>GB</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>AccountFundingSource</key>
                    <value>Debit</value>
                </detail>
                <detail xsi:type="keyBooleanValuePair">
                    <key>FastFunds</key>
                    <value>false</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>IssuerName</key>
                    <value>UNKNOWN</value>
                </detail>
            </details>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>

Example initiatePaymentResponse for Card Withdrawal - InitiateRequestProviderCommunicationErrorOccurred:

<initiatePaymentResponse xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
                         xmlns:xsd=http://www.w3.org/2001/XMLSchema
                         xmlns=http://www.cqrpayments.com/PaymentProcessing>
<payment
         xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayperGWMockShop</shopID>
	<paymentMethod>
		<key>12</key>
		<value>VISA Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>d186d7d2-27c0-45e3-b2b8-f65bd91f901e</merchantTransactionID>
	<paymentID>e8972425-ef02-4811-b995-5941653970f5</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">99.01</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.0</userIP>
	<state>
		<id>731be515-f2a2-46a6-abd4-75106bd90a87</id>
		<definition>
			<key>325</key>
			<value>InitiateRequestProviderCommunicationErrorOccurred</value>
		</definition>
		<createdOn>2023-11-08T16:15:09.4170558Z</createdOn>
		<description>Error occurred while processing payment communication for Payment[ID='49520705'].</description>
		<paymentStateDetails>
			<detail xsi:type="keyStringValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">71.5</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderTransactionID</key>
			<value>837678036212199723761250846276</value>
		</detail>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>120672</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>38b571a0-e7e6-4d91-870a-67369000a40c</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>GB</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>UNKNOWN</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</initiatePaymentResponse>

Notifications

States reached after initiatePaymentRequest

StateDetailsDescription
WithdrawnByProviderFinal success state
RefusedByProviderRefusal state

Example handlePaymentStateChangedNotificationRequest for VISA Withdrawal in WithdrawnByProvider state (with ApprovalCode):

<?xml version="1.0" encoding="utf-8"?>
<handlePaymentStateChangedNotificationRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<payment xsi:type="paymentWithPaymentAccount">
		<merchantID>B2BTestMerchant</merchantID>
		<shopID>PayperGWMockShop</shopID>
		<paymentMethod>
			<key>38</key>
			<value>ECMC Withdrawal</value>
		</paymentMethod>
		<merchantTransactionID>e4b5d9b6-21d4-4546-ac6a-7e0bfa60a465</merchantTransactionID>
		<paymentID>99906835-633d-4c87-aa1b-95107d002fd0</paymentID>
		<userID>PayperCCUserWithAddr</userID>
		<paymentProvider>
			<key>204</key>
			<value>Payper</value>
		</paymentProvider>
		<amount currencyCode="CAD">100.1000</amount>
		<creationType>
			<key>1</key>
			<value>User</value>
		</creationType>
		<userIP>127.0.0.1</userIP>
		<state>
			<id>68d91464-9abc-4ce3-8f16-13b61fdedad4</id>
			<definition>
				<key>20</key>
				<value>WithdrawnByProvider</value>
			</definition>
			<createdOn>2024-03-08T09:49:24.037</createdOn>
			<paymentStateDetails>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseCode</key>
					<value>100</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseMessage</key>
					<value>Transaction was approved.</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ApprovalCode</key>
					<value>123456</value>
				</detail>
			</paymentStateDetails>
		</state>
		<isExecuted>true</isExecuted>
		<baseAmount currencyCode="EUR">72.2900</baseAmount>
		<paymentDetails>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderExternalID</key>
				<value>170705</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderTransactionID</key>
				<value>291142478292702555051054215053</value>
			</detail>
		</paymentDetails>
		<paymentAccount>
			<paymentAccountID>f8d9a26f-830d-4ed0-8bb1-0947a5f50091</paymentAccountID>
			<details>
				<detail xsi:type="keyStringValuePair">
					<key>IssuerCountry</key>
					<value>AT</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AccountFundingSource</key>
					<value>Debit</value>
				</detail>
				<detail xsi:type="keyBooleanValuePair">
					<key>FastFunds</key>
					<value>false</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>IssuerName</key>
					<value>Some Bank</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>MaskedNumber</key>
					<value>526624******6818</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AccountOwnerToken</key>
					<value>acda11b6-3410-4a8b-bb84-59b26943bf0a</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryMonth</key>
					<value>12</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>ExpiryYear</key>
					<value>2099</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>HolderName</key>
					<value>6f4d7f3c-508c-47b3-960d-a826cc1314f1</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>CardType</key>
					<value>Mastercard</value>
				</detail>
			</details>
		</paymentAccount>
	</payment>
</handlePaymentStateChangedNotificationRequest>

Example handlePaymentStateChangedNotificationRequest for VISA Withdrawal in RefusedByProviderState state:

<?xml version="1.0" encoding="utf-16"?>
<handlePaymentStateChangedNotificationRequest xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance>
<payment xmlns:q1=http://www.cqrpayments.com/PaymentProcessing xsi:type="paymentWithPaymentAccount">
	<merchantID>B2BTestMerchant</merchantID>
	<shopID>PayperGWMockShop</shopID>
	<paymentMethod>
		<key>38</key>
		<value>ECMC Withdrawal</value>
	</paymentMethod>
	<merchantTransactionID>587b4aaf-9ef8-4866-9eed-96917825e314</merchantTransactionID>
	<paymentID>da9f222b-924d-416d-a6dd-75a383721785</paymentID>
	<userID>PayperCCUserWithAddr</userID>
	<paymentProvider>
		<key>204</key>
		<value>Payper</value>
	</paymentProvider>
	<amount currencyCode="CAD">100.1000</amount>
	<creationType>
		<key>1</key>
		<value>User</value>
	</creationType>
	<userIP>127.0.0.1</userIP>
	<state>
		<id>51427eb8-84b9-43a8-b2a2-bfb68553fc92</id>
		<definition>
			<key>100</key>
			<value>RefusedByProvider</value>
		</definition>
		<createdOn>2023-11-09T17:15:02.883</createdOn>
		<paymentStateDetails>
			<detail xsi:type="keyIntValuePair">
				<key>PaymentStateReasonID</key>
				<value>1</value>
			</detail>
		</paymentStateDetails>
	</state>
	<isExecuted>false</isExecuted>
	<baseAmount currencyCode="EUR">72.2900</baseAmount>
	<paymentDetails>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderExternalID</key>
			<value>121998</value>
		</detail>
		<detail xsi:type="keyStringValuePair">
			<key>ProviderTransactionID</key>
			<value>103423527615497070521692848273</value>
		</detail>
	</paymentDetails>
	<paymentAccount>
		<paymentAccountID>ff670123-8662-455d-95b5-f5595aab2a52</paymentAccountID>
		<details>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerCountry</key>
				<value>AT</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountFundingSource</key>
				<value>Debit</value>
			</detail>
			<detail xsi:type="keyBooleanValuePair">
				<key>FastFunds</key>
				<value>false</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>IssuerName</key>
				<value>Some Bank</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>MaskedNumber</key>
				<value>526624******6818</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>AccountOwnerToken</key>
				<value>acda11b6-3410-4a8b-bb84-59b26943bf0a</value>
			</detail>
			<detail xsi:type="keyIntValuePair">
				<key>ExpiryMonth</key>
				<value>12</value>
			</detail>
			<detail xsi:type="keyIntValuePair">
				<key>ExpiryYear</key>
				<value>2099</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>HolderName</key>
				<value>876957ea-b68b-4ee2-82f6-219cd43b9fb5</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>CardType</key>
				<value>Mastercard</value>
			</detail>
		</details>
	</paymentAccount>
</payment>
</handlePaymentStateChangedNotificationRequest>

Example handlePaymentStateChangedNotificationRequest for VISA Withdrawal in InitiateRefusedByProvider state (with ApprovalCode):

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentFromReferenceResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                                      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                                      xmlns="http://www.cqrpayments.com/PaymentProcessing">
	<payment xsi:type="paymentWithPaymentAccount">
		<merchantID>B2BTestMerchant</merchantID>
		<shopID>PayperGWMockShop</shopID>
		<paymentMethod>
			<key>12</key>
			<value>VISA Withdrawal</value>
		</paymentMethod>
		<merchantTransactionID>64ebd9ba-83bc-4ab0-8b46-dcd5d4bc1420</merchantTransactionID>
		<paymentID>63674a2a-4ab4-47f7-bd4f-3909e5ce9b34</paymentID>
		<userID>PayperCCUserWithAddr</userID>
		<paymentProvider>
			<key>204</key>
			<value>Payper</value>
		</paymentProvider>
		<amount currencyCode="CAD">99.0100</amount>
		<creationType>
			<key>1</key>
			<value>User</value>
		</creationType>
		<userIP>127.0.0.0</userIP>
		<state>
			<id>e6a530a9-33d5-41fa-9c8a-83d1470ad85a</id>
			<definition>
				<key>550</key>
				<value>InitiateRefusedByProvider</value>
			</definition>
			<createdOn>2024-03-08T09:34:47.943</createdOn>
			<paymentStateDetails>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseCode</key>
					<value>200</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ProviderResponseMessage</key>
					<value>Transaction was declined by processor.</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>ApprovalCode</key>
					<value>987654</value>
				</detail>
				<detail xsi:type="keyIntValuePair">
					<key>PaymentStateReasonID</key>
					<value>1</value>
				</detail>
			</paymentStateDetails>
		</state>
		<isExecuted>false</isExecuted>
		<baseAmount currencyCode="EUR">71.5000</baseAmount>
		<paymentDetails>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderExternalID</key>
				<value>170704</value>
			</detail>
			<detail xsi:type="keyStringValuePair">
				<key>ProviderTransactionID</key>
				<value>408317729979461357468552936148</value>
			</detail>
		</paymentDetails>
		<paymentAccount>
			<paymentAccountID>7590b350-31a3-4141-bb0b-1a25f71f7caf</paymentAccountID>
			<details>
				<detail xsi:type="keyStringValuePair">
					<key>IssuerCountry</key>
					<value>GB</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>AccountFundingSource</key>
					<value>Debit</value>
				</detail>
				<detail xsi:type="keyBooleanValuePair">
					<key>FastFunds</key>
					<value>false</value>
				</detail>
				<detail xsi:type="keyStringValuePair">
					<key>IssuerName</key>
					<value>UNKNOWN</value>
				</detail>
			</details>
		</paymentAccount>
	</payment>
</handlePaymentStateChangedNotificationRequest>

Payment States for Card Withdrawal

StateDescription
WithdrawnByProviderSuccess state; payment has been executed
RefusedByProviderRefusal state, payment was not accepted by provider
RefusedByPaymentScoringRefusal state, Declined by PXP risk engine during risk checks
ValidationFailedError state, Technical validation failed. Example: Mandatory parameters not available
ProviderCommunicationErrorOccurredError state; a communication error has occured. Please note that the payment can still be moved to a success state through the reconciliation
NotifyPaymentStateErrorReportedByMerchantError state; error reported by merchant during withdrawal approval.
DuplicatePaymentValidationFailedUnsuccessful state; Duplication of payment.