eCheckSelect WithdrawalReturn (ACHeCheckWithdrawalReturn)
Payment Method ACHeCheck(Token)Withdrawal (provider naming Instant Bank Transfer, formerly eCheckSelect) is bank transfer withdrawal for the US. The page describes the return method associated to the withdrawal.
The following method IDs are covered in this section:
ID | Name | Credit/Debit State |
---|---|---|
356 | ACHeCheckWithdrawalReturn | ReturnedByProvider |
Payment method interaction type: Notification from External Payment Provider (see Interaction Types).
Redirect Integration
Currently not supported.
Backend2BackendIntegration
The following state can be reached:
Payment state | Description |
---|---|
ReturnedByProvider | This state is set for a withdrawal return. The return code is saved as payment state detail ProviderReturnCode (see below for the list ACH Return Codes). |
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 for a ReturnedPayment in state ReturnedByProvider:
<?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>150001</shopID>
<paymentMethod>
<key>356</key>
<value>ACHeCheckWithdrawalReturn</value>
</paymentMethod>
<merchantTransactionID>407e5e42-8e2e-4941-a75c-1fe6120a67b0</merchantTransactionID>
<paymentID>96f3b65f-9df6-430a-ad08-097608b85de2</paymentID>
<userID>30e75aac-bfed-475d-b25a-5a72bb</userID>
<paymentProvider>
<key>122</key>
<value>Mazooma</value>
</paymentProvider>
<amount currencyCode="USD">24.9000</amount>
<creationType>
<key>1</key>
<value>User</value>
</creationType>
<userIP>127.0.0.1</userIP>
<state>
<id>e9e1f643-3490-415e-878a-90e426eb2b09</id>
<definition>
<key>279</key>
<value>ReturnedByProvider</value>
</definition>
<createdOn>2020-08-11T09:52:12.14</createdOn>
<paymentStateDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderReturnCode</key>
<value>R22</value>
</detail>
</paymentStateDetails>
</state>
<isExecuted>true</isExecuted>
<baseAmount currencyCode="EUR">18.7100</baseAmount>
<paymentDetails>
<detail xsi:type="keyStringValuePair">
<key>ProviderTransactionID</key>
<value>20190220167779999999900003</value>
</detail>
</paymentDetails>
</payment>
</handlePaymentStateChangedNotificationRequest>
ACH Return Codes
ACH return codes and definitions commonly used by US financial institutions:
Updated over 3 years ago