Venmo Withdrawal

Venmo is a mobile payment service owned by PayPal. Venmo account holders can transfer funds to others via a mobile phone app; both the sender and receiver have to live in the U.S.
The following method IDs are covered in this section:

ID

Name

Credit/Debit State

423

Venmo Withdrawal

WithdrawnByProvider (20)

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

Please refer to the updated workflow here.

Payment flow

744744

Redirect Integration

Currently not supported.

Backend2Backend Integration

The following parameters can be provided in initiatePaymentRequest.specificPaymentData:

key (value type, account type, required)

value

paymentDescription (string, required)

Message to the customer that will be displayed on their statement.

Sample initiatePaymentRequest:

<?xml version="1.0" encoding="utf-8"?>
<initiatePaymentRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.cqrpayments.com/PaymentProcessing">
    <merchantID>YourTestMerchant</merchantID>
    <shopID>YourTestShop</shopID>
    <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
    <paymentMethodID>423</paymentMethodID>
    <amount currencyCode="USD">10.00</amount>
    <userID>5678432</userID>
    <userIP>127.0.0.1</userIP>
    <userSessionID>7495c35f-3c55-4a08-a0a0-03f3ed917fbc</userSessionID>
    <creationTypeID>1</creationTypeID>
    <specificPaymentData>
        <data xsi:type="keyStringValuePair">
            <key>PaymentDescription</key>
            <value>ThisIsPaymentDescription</value>
        </data>
    </specificPaymentData>
    <paymentAccountID>0e65f98a-a11d-4e89-9583-925870659e63</paymentAccountID>
</initiatePaymentRequest>

Sample response:

<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>YourTestMerchant</merchantID>
        <shopID>YourTestShop</shopID>
        <paymentMethod>
            <key>423</key>
            <value>Venmo Withdrawal</value>
        </paymentMethod>
        <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
        <paymentID>46525c9e-8587-4e82-8370-7d645d0b74d9</paymentID>
        <userID>5678432</userID>
        <paymentProvider>
            <key>191</key>
            <value>Braintree</value>
        </paymentProvider>
        <amount currencyCode="USD">10.00</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>eb5b3a86-cdcd-452d-a462-16d3c73d8b18</id>
            <definition>
                <key>3</key>
                <value>InitiatedByProvider</value>
            </definition>
            <createdOn>2021-09-02T13:19:03.9334241Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyStringValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">8.62</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderTransactionID</key>
                <value>4V8B64HHD5S8N</value>
            </detail>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>37542669</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>8fa1f57f-f5b1-4d82-a1c2-53a0b6cc616</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>YourTestMerchant</merchantID>
        <shopID>YourTestShop</shopID>
        <paymentMethod>
            <key>423</key>
            <value>Venmo Withdrawal</value>
        </paymentMethod>
        <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
        <paymentID>46525c9e-8587-4e82-8370-7d645d0b74d9</paymentID>
        <userID>5678432</userID>
        <paymentProvider>
            <key>191</key>
            <value>Braintree</value>
        </paymentProvider>
        <amount currencyCode="USD">10.00</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>eb5bc886-34cd-452d-a462-16d3c73d8b18</id>
            <definition>
                <key>4</key>
                <value>InitiateErrorReportedByProvider</value>
            </definition>
            <createdOn>2021-09-02T14:19:03.9334241Z</createdOn>
            <paymentStateDetails>
                <detail xsi:type="keyIntValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderErrorResponseCode</key>
                    <value>AUTHENTICATION_FAILURE</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderErrorResponseMessage</key>
                    <value>Authentication failed due to invalid authentication credentials or a missing Authorization header.</value>
                </detail>
            </paymentStateDetails>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">8.62</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>37542669</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>8fa1f57f-f5b1-4d82-a1c2-53a0b6cc616</paymentAccountID>
        </paymentAccount>
    </payment>
</initiatePaymentResponse>
<initiatePaymentResponse xmlns="http://www.cqrpayments.com/PaymentProcessing" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <payment xsi:type="paymentWithPaymentAccount">
        <merchantID>YourTestMerchant</merchantID>
        <shopID>YourTestShop</shopID>
        <paymentMethod>
            <key>423</key>
            <value>Venmo Withdrawal</value>
        </paymentMethod>
        <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
        <paymentID>46525c9e-8587-4e82-8370-7d645d0b74d9</paymentID>
        <userID>5678432</userID>
        <paymentProvider>
            <key>191</key>
            <value>Braintree</value>
        </paymentProvider>
        <amount currencyCode="USD">10.00</amount>
        <creationType>
            <key>1</key>
            <value>User</value>
        </creationType>
        <userIP>127.0.0.1</userIP>
        <state>
            <id>eb556846-34cd-452d-a462-16d3c73d8b18</id>
            <definition>
                <key>325</key>
                <value>InitiateRequestProviderCommunicationErrorOccurred</value>
            </definition>
            <createdOn>2021-09-20T14:19:03.9334241Z</createdOn>
            <description>Connection timeout.</description>
        </state>
        <isExecuted>false</isExecuted>
        <baseAmount currencyCode="EUR">8.62</baseAmount>
        <paymentDetails>
            <detail xsi:type="keyStringValuePair">
                <key>ProviderExternalID</key>
                <value>37542669</value>
            </detail>
        </paymentDetails>
        <paymentAccount>
            <paymentAccountID>8fa1f57f-f5b1-4d82-a1c2-53a0b6cc616</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.

Sample 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="q1:paymentWithPaymentAccount">
    <merchantID>YourTestMerchant</merchantID>
    <shopID>YourTestShop</shopID>
    <paymentMethod>
      <key>423</key>
      <value>Venmo Withdrawal</value>
    </paymentMethod>
    <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
    <paymentID>46525c9e-8587-4e82-8370-7d645d0b74d9</paymentID>
    <userID>5678432</userID>
    <paymentProvider>
      <key>191</key>
      <value>Braintree</value>
    </paymentProvider>
    <amount currencyCode="USD">10.0000</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>7845cae2-fdf9-44e9-9505-218f4d3832d1</id>
      <definition>
        <key>20</key>
        <value>WithdrawnByProvider</value>
      </definition>
      <createdOn>2021-09-20T09:15:44.817</createdOn>
      <paymentStateDetails>
                <detail xsi:type="keyIntValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderStatusDescription</key>
                    <value>Payouts batch completed successfully.</value>
                </detail>
            </paymentStateDetails>
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">8.2600</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
                    <key>ProviderTransactionID</key>
                    <value>4V8B64HHD5S8N</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderExternalID</key>
                    <value>37542669</value>
                </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>8fa1f57f-f5b1-4d82-a1c2-53a0b6cc616</paymentAccountID>
    </paymentAccount>
  </payment>
</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="q1:paymentWithPaymentAccount">
    <merchantID>YourTestMerchant</merchantID>
    <shopID>YourTestShop</shopID>
    <paymentMethod>
      <key>423</key>
      <value>Venmo Withdrawal</value>
    </paymentMethod>
    <merchantTransactionID>dd183f76-14b4-48f4-a2b0-1fe5a3b7398e</merchantTransactionID>
    <paymentID>46525c9e-8587-4e82-8370-7d645d0b74d9</paymentID>
    <userID>5678432</userID>
    <paymentProvider>
      <key>191</key>
      <value>Braintree</value>
    </paymentProvider>
    <amount currencyCode="USD">10.0000</amount>
    <creationType>
      <key>1</key>
      <value>User</value>
    </creationType>
    <userIP>127.0.0.1</userIP>
    <state>
      <id>7844cae2-fdf9-44e9-8975-218f4d3832d1</id>
      <definition>
        <key>100</key>
        <value>RefusedByProvider</value>
      </definition>
      <createdOn>2021-09-20T09:15:44.817</createdOn>
      <paymentStateDetails>
                <detail xsi:type="keyIntValuePair">
                    <key>PaymentStateReasonID</key>
                    <value>1</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderStatusDescription</key>
                    <value>Payouts batch got denied.</value>
                </detail>
            </paymentStateDetails>
    </state>
    <isExecuted>true</isExecuted>
    <baseAmount currencyCode="EUR">8.2600</baseAmount>
    <paymentDetails>
      <detail xsi:type="keyStringValuePair">
                    <key>ProviderTransactionID</key>
                    <value>4V8B64HHD5S8N</value>
                </detail>
                <detail xsi:type="keyStringValuePair">
                    <key>ProviderExternalID</key>
                    <value>37542669</value>
                </detail>
    </paymentDetails>
    <paymentAccount>
      <paymentAccountID>8fa1f57f-f5b1-4d82-a1c2-53a0b6cc616</paymentAccountID>
    </paymentAccount>
  </payment>
</handlePaymentStateChangedNotificationRequest>