ecoPayz Withdrawal

The following method IDs are covered in this section:

ID

Name

Credit/Debit State

Reversal State

173

ecoPayzWithdrawal

WithdrawnByProvider (20)

Payment method interaction type: Synchronous execution with External Payment Provider (see Interaction Types).

Redirect Integration

Currently not supported.

Backend2BackendIntegration

The following parameters can be provided in initiatePaymentRequest.specificPaymentData:

key (value type, account type, required)

value

PaymentDescription
(string)

Description of the payment, this will be shown in customer’s transaction statement.

Example initiatePaymentRequest:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentRequest xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <merchantID>Merchant</merchantID>
  <shopID>Shop</shopID>
  <merchantTransactionID>0ecf9a22-4642-4f1b-96fa-b92e548e3cc2</merchantTransactionID>
  <paymentMethodID>223</paymentMethodID>
  <amount currencyCode="EUR">10.00</amount>
  <userID>5bca9cd1-60df-410d-b93f-afbbf5</userID>
  <userData>
    <username>5bca9cd1-60df-410d-b93f-afbbf5</username>
  </userData>
  <userIP>127.0.0.1</userIP>
  <userSessionID>ded4308c-5ef0-4077-8b77-eeeb84cf7373</userSessionID>
  <creationTypeID>1</creationTypeID>
  <specificPaymentData>
    <data xsi:type="keyStringValuePair">
      <key>PaymentDescription</key>
      <value>ecoPayz payout BDD:3c277828-3d5e-4784-a26d-babea8eb55d1</value>
    </data>
  </specificPaymentData>
  <paymentAccountID>0fd451ad-90b1-4eea-97ab-496c146defb7</paymentAccountID>
</initiatePaymentRequest>

Example initiatePaymentResponse:

<?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">
  <payment>
    <merchantID>Merchant</merchantID>
    <shopID>Shop</shopID>
    <paymentMethod>
      <key>223</q1:key>
      <value>ecoPayzWithdrawal</q1:value>
    </paymentMethod>
    <merchantTransactionID>0ecf9a22-4642-4f1b-96fa-b92e548e3cc2</merchantTransactionID>
    <paymentID>5ad88528-284d-4573-a7a6-3d1872639483</paymentID>
    <userID>5bca9cd1-60df-410d-b93f-afbbf5</userID>
    <paymentProvider>
      <key>147</key>
      <value>ecoPayz</value>
    </paymentProvider>
    <amount currencyCode="EUR">10.00</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>14afed33-672b-4e4c-a0c7-ae65a0bb93f8</id>
      <definition>
        <key>20</key>
        <value>WithdrawnByProvider</value>
      </definition>
      <createdOn>2016-07-29T14:54:19.9497601Z</createdOn>
      <description>OK</description>
      <paymentStateDetails/>
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">10</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderExternalID</key>
        <value>5ad88528-284d-4573-a7a6-3d1872639483</value>
      </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>0fd451ad-90b1-4eea-97ab-496c146defb7</paymentAccountID>
    </paymentAccount>
  </payment>
</initiatePaymentResponse>

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:

<?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>150001</shopID>
    <paymentMethod>
      <key>223</key>
      <value>ecoPayzWithdrawal</value>
    </paymentMethod>
    <merchantTransactionID>0ecf9a22-4642-4f1b-96fa-b92e548e3cc2-03</merchantTransactionID>
    <paymentID>6261dccf-e6c3-4b2f-b271-475dc88be372</paymentID>
    <userID>5bca9cd1-60df-410d-b93f-afbbf5</userID>
    <paymentProvider>
      <key>147</key>
      <value>ecoPayz</value>
    </paymentProvider>
    <amount currencyCode="EUR">10.0000</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>351b9fd5-d719-4ca8-a7c0-25dddfddf589</id>
      <definition>
        <key>20</key>
        <value>WithdrawnByProvider</value>
      </definition>
      <createdOn>2018-09-11T08:35:02.997</createdOn>
      <paymentStateDetails>
        <detail xsi:type="keyStringValuePair">
          <key>ProviderErrorMessage</key>
          <value>OK</value>
        </detail>
        <detail xsi:type="keyStringValuePair">
          <key>ProviderErrorCode</key>
          <value>0</value>
        </detail>
      </paymentStateDetails>
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">10.0000</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderExternalID</key>
        <value>6261dccf-e6c3-4b2f-b271-475dc88be372</value>
      </detail>
      <detail xsi:type="keyIntValuePair">
        <key>MerchantSettlementCurrencyID</key>
        <value>2</value>
      </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>6cde2d1e-adb6-44f6-9158-bb4952e4a8be</paymentAccountID>
    </paymentAccount>
  </payment>
</handlePaymentStateChangedNotificationRequest>