VIP Preferred Deposit Return

VIP Cashline / VIP Preferred Deposit allows to pay by eChecks in the US.

The following method IDs are covered in this section:

ID	Name	Credit/Debit State
302	VIPPreferredDepositReturn	ReturnedByProvider (279)

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

When a VIPPreferredDeposit 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 deposit transaction was returned by the provider.

PaymentDetail	Description
ReasonCode	The reason for the deposit return / stop payment, eg. "AUTHORIZATION REVOKED", "NOT AUTHORIZED" or "STOP PAYMENT".

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>VIPPreferredDepositShop</shopID>
      <paymentMethod>
         <key>302</key>
         <value>VIPPreferredDepositReturn</value>
      </paymentMethod>
      <merchantTransactionID>2d113952-cb6b-4d1e-b8db-ae7d80812f9d</merchantTransactionID>
      <paymentID>f1146fd5-e79f-4760-bb90-dfda8d9d34d7</paymentID>
      <userID>2ecb52c3-d04b-4a5c-8c6f-785e1c</userID>
      <paymentProvider>
         <key>155</key>
         <value>GlobalPayments</value>
      </paymentProvider>
      <amount currencyCode="USD">2.0000</amount>
      <creationType>
         <key>6</key>
         <value>Provider</value>
      </creationType>
      <state>
         <id>4e78cee4-6392-4df8-b43b-50c681797832</id>
         <definition>
            <key>279</key>
            <value>ReturnedByProvider</value>
         </definition>
         <createdOn>2021-10-12T12:18:04.203</createdOn>
         <paymentStateDetails xsi:nil="true" />
      </state>
      <isExecuted>true</isExecuted>
      <baseAmount currencyCode="EUR">1.5000</baseAmount>
      <paymentDetails>
         <detail xsi:type="keyStringValuePair">
            <key>ProviderExternalID</key>
            <value>0fd4c095-a333-493a-8f27-1a48df11f7a7</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>AUTHORIZATION REVOKED</value>
         </detail>
         <detail xsi:type="keyDecimalValuePair">
            <key>SettlementAmount</key>
            <value>2.000000000</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentID</key>
            <value>e6844531-12e0-4fd7-ab1c-840605ab47ff</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMerchantTransactionID</key>
            <value>2d113952-cb6b-4d1e-b8db-ae7d80812f9d</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMethodID</key>
            <value>252</value>
         </detail>
         <detail xsi:type="keyStringValuePair">
            <key>OriginalPaymentMethodName</key>
            <value>VIPPreferredDeposit</value>
         </detail>
      </paymentDetails>
      <paymentAccount>
         <paymentAccountID>5586eda0-9388-4307-8aee-4cd5cc6824b1</paymentAccountID>
      </paymentAccount>
   </payment>
</handlePaymentStateChangedNotificationRequest>

Updated about 3 years ago