Paypal Withdrawal Return

PayPal is a online wallet allowing customers to make instant financial transactions to other individuals and businesses world-wide.

The following method IDs are covered in this section:

ID	Name	Credit State
322	PayPalWithdrawalReturn	ReturnedByProvider (279)

A payment method of type PayPalWithdrawalReturn is created when a PayPalWithdrawal is returned by PayPal.

Payment Notification

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

The notification includes details of the original payment - the PayPal Withdrawal transaction - in fields OriginalPaymentID, OriginalPaymentMerchantTransactionID, OriginalPaymentMethodID and OriginalPaymentMethodName.

Please note the detail 'TransactionStatusCode' passed within the notification: This value - called also "Transaction Event Code" by PayPal is:

T1114 for a MassPay reversal transaction. This is a reversal initiated by PayPal because of bank orders or fraud suspicion.
T1115 for a MassPay refund transaction. This indicates a withdrawal that was refunded by the withdrawal recipient.

<detail xsi:type="keyStringValuePair">
        <key>TransactionStatusCode</key>
        <value>T1114</value>
      </detail>

Example handlePaymentStateChangedNotificationRequest for Paypal Withdrawal Return in ReturnedByProvider 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>150001</shopID>
    <paymentMethod>
      <key>322</key>
      <value>PayPalWithdrawalReturn</value>
    </paymentMethod>
    <merchantTransactionID>30ad5f23-3067-4262-9489-331182a8781b</merchantTransactionID>
    <paymentID>3540a0c6-4498-431d-bf2d-84b3baca2edc</paymentID>
    <userID>34a16067-7003-4c55-b4fe-8056a6</userID>
    <paymentProvider>
      <key>56</key>
      <value>PayPal</value>
    </paymentProvider>
    <amount currencyCode="EUR">20.0000</amount>
    <creationType>
      <key>6</key>
      <value>Provider</value>
    </creationType>
    <state>
      <id>5528b1b7-0e6a-4f49-a278-0b784eaef8b9</id>
      <definition>
        <key>279</key>
        <value>ReturnedByProvider</value>
      </definition>
      <createdOn>2019-02-26T16:03:25.817</createdOn>
      <paymentStateDetails xsi:nil="true" />
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">20.0000</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderExternalID</key>
        <value>cb9413b5-0717-43b8-ad0f-84094a0d1824</value>
      </detail>
      <detail xsi:type="keyIntValuePair">
        <key>SettlementCurrencyCode</key>
        <value>978</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>ProviderTransactionID</key>
        <value>4H487488FD677074J</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>TransactionStatusCode</key>
        <value>T1114</value>
      </detail>
      <detail xsi:type="keyDecimalValuePair">
        <key>SettlementAmount</key>
        <value>20.000000000</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>OriginalPaymentID</key>
        <value>9ca556e2-62c5-41b8-b269-691e9b528bbe</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>OriginalPaymentMerchantTransactionID</key>
        <value>30ad5f23-3067-4262-9489-331182a8781b</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>OriginalPaymentMethodID</key>
        <value>64</value>
      </detail>
      <detail xsi:type="keyStringValuePair">
        <key>OriginalPaymentMethodName</key>
        <value>PayPalWithdrawal</value>
      </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>0</paymentAccountID>
    </paymentAccount>
  </payment>
</handlePaymentStateChangedNotificationRequest>