SOAP API - GetUserPaymentMethod

GetUserPaymentMethod( username ) : ViewUserPaymentMethod[]

Since: EngageIP v25.2

Returns the list of a user's payment methods, or throws an exception if the user does not exist.

This method returns an array of ViewUserPaymentMethod objects which consists of the following properties:

ID (Integer) - The unique ID for the user payment method
UserID (Integer) - The unique ID for the supplied username
PaymentTypeID (Integer) - The ID of the payment type
Name (String) - The name of the payment type configured at the owner level
User (String) - The name of the user
PamentTypeTypeID (Integer) -The ID of the category for the payment type referring the base payment types of EngageIP: ACH, Check, Credit Card, Credit Card Token, ECheck Token, Other

Parameters:

username (String) - The username for which to retrieve the configured payment methods. An exception will be thrown if the username does not exist.

Returns:

An array of ViewUserPaymentMethod Objects representing ways the account may make payments

Possible Exceptions:

INVALID USERNAME

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetUserPaymentMethod xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserPaymentMethod>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserPaymentMethodResponse xmlns="Logisense_EngageIP">
      <GetUserPaymentMethodResult>
        <ViewUserPaymentMethod>
          <ID>int</ID>
          <UserID>int</UserID>
          <Value>string</Value>
          <PaymentTypeID>int</PaymentTypeID>
          <Name>string</Name>
          <User>string</User>
          <PaymentTypeTypeID>int</PaymentTypeTypeID>
          <PaymentTypeType>string</PaymentTypeType>
        </ViewUserPaymentMethod>
        <ViewUserPaymentMethod>
          <ID>int</ID>
          <UserID>int</UserID>
          <Value>string</Value>
          <PaymentTypeID>int</PaymentTypeID>
          <Name>string</Name>
          <User>string</User>
          <PaymentTypeTypeID>int</PaymentTypeTypeID>
          <PaymentTypeType>string</PaymentTypeType>
        </ViewUserPaymentMethod>
      </GetUserPaymentMethodResult>
    </GetUserPaymentMethodResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserPaymentMethod"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetUserPaymentMethod xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserPaymentMethod>
  </soap:Body>
</soap:Envelope>

SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.