VIP Preferred Withdrawal Return

VIP Cashline / VIP Preferred Withdrawal Deposit allows to pay out to bank account (ACH) in the US.

The following method IDs are covered in this section:

ID	Name	Credit/Debit State
301	VIPPreferredWithdrawalReturn	ReturnedByProvider (279)

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

When a VIPPreferredWithdrawal is returned, a notification is sent to the merchant.

Partial returns are not possible.

When ACH items are returned, GlobalPayments is notified and updates the system on the same day. Per NACHA rules, someone has up to 2 years to dispute an ACH transaction.

Notifications

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

PaymentStates	Description
ReturnedByProvider	A withdrawal transaction was returned by the provider.

PaymentDetail	Description
ReasonCode	The reason for the withdrawal return, e.g. "NO ACCOUNT/UNABLE TO LOCATE", "ACCOUNT CLOSED", " INVALID ACCOUNT NUMBER", "CREDIT ENTRY REFUSED BY RECEIVER" or "ACCOUNT FROZEN".

Example handlePaymentStateChangedNotificationRequest:

<?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">
   <payment xmlns:q1="http://www.cqrpayments.com/PaymentProcessing" xsi:type="paymentWithPaymentAccount">
      <merchantID>B2BTestMerchant</merchantID>
      <shopID>VIPPreferredWithdrawalShop</shopID>
      <paymentMethod>
         <key>301</key>
         <value>VIPPreferredWithdrawalReturn</value>
      </paymentMethod>
      <merchantTransactionID>76fa55c4-d498-49de-b434-d985748df577</merchantTransactionID>
      <paymentID>e49aaf00-f77a-4729-bde7-3688f3c03045</paymentID>
      <userID>7137931d-b701-459e-a1dd-a25cbb</userID>
      <paymentProvider>
         <key>155</key>
         <value>GlobalPayments</value>
      </paymentProvider>
      <amount currencyCode="USD">500.0000</amount>
      <creationType>
         <key>6</key>
         <value>Provider</value>
      </creationType>
      <state>
         <id>9875a74d-7401-41c8-a9b8-28244feacaba</id>
         <definition>
            <key>279</key>
            <value>ReturnedByProvider</value>
         </definition>
         <createdOn>2021-10-12T12:29:33.477</createdOn>
         <paymentStateDetails xsi:nil="true" />
      </state>
      <isExecuted>true</isExecuted>
      <baseAmount currencyCode="EUR">375.6900</baseAmount>
      <paymentDetails>
         <detail xsi:type="keyStringValuePair">
            <key>ProviderExternalID</key>
            <value>d714654d-be14-400f-89af-19aacae1718f</value>
         </detail>
         <detail xsi:type="keyIntValuePair">
            <key>SettlementCurrencyCode</key>
            <value>840</value>
         </detail>
         <detail xsi:type="keyIntValuePair">
            <key>MerchantSettlementCurrencyID</key>
            <value>2</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>ReasonCode</key>
            <value>NO ACCOUNT/UNABLE TO LOCATE</value>
         </detail>
         <detail xsi:type="keyDecimalValuePair">
            <key>SettlementAmount</key>
            <value>500.000000000</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentID</key>
            <value>b489de6c-c9e0-461b-80f5-2515e93b791c</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMerchantTransactionID</key>
            <value>76fa55c4-d498-49de-b434-d985748df577</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMethodID</key>
            <value>253</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMethodName</key>
            <value>VIPPreferredWithdrawal</value>
         </detail>
      </paymentDetails>
      <paymentAccount>
         <paymentAccountID>4d427ab7-dded-4e2e-9ce6-80121023d95c</paymentAccountID>
      </paymentAccount>
   </payment>
</handlePaymentStateChangedNotificationRequest>