SOAP API - GetUserPaymentMethodCreditCards

GetUserPaymentMethodCreditCards( username ) : ViewUserPaymentMethodCreditCard[]

Since: EngageIP v25.2

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

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

ID (Integer) - The unique ID for the user payment method credit card
CardTypeID (Integer) - References the ID of the card type, see CardType below
Number (Integer) - The credit card number
AccountHolder (String) - The name on the credit card
CCExpiryMonth (String) - The month the credit card expires
CCExpiryYear (String) - The year the credit card expires
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
UserPaymentMethodID (Integer) - The ID for the user payment method
Country (Integer) - The country of the card holder
State (Integer) - The state of the card holder
City (String) - The city of the card holder
Address (String) - The address of the card holder
ZipCode (String) - The zip code of the card holder
Email (String) -The email of the card holder
Name (String) - The name of the payment method type which in this case will always be "Credit Card"
CardType (String) - The name of the card type, for example Visa, Mastercard etc.

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 ViewUserPaymentMethodCreditCard Objects representing credit cards linked to the account

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>
    <GetUserPaymentMethodCreditCards xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserPaymentMethodCreditCards>
  </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>
    <GetUserPaymentMethodCreditCardsResponse xmlns="Logisense_EngageIP">
      <GetUserPaymentMethodCreditCardsResult>
        <ViewUserPaymentMethodCreditCard>
          <ID>int</ID>
          <CardTypeID>int</CardTypeID>
          <Number>string</Number>
          <AccountHolder>string</AccountHolder>
          <CCExpiryMonth>string</CCExpiryMonth>
          <CCExpiryYear>string</CCExpiryYear>
          <UserPaymentMethodID>int</UserPaymentMethodID>
          <Country>string</Country>
          <State>string</State>
          <City>string</City>
          <Address>string</Address>
          <ZipCode>string</ZipCode>
          <Phone>string</Phone>
          <Email>string</Email>
          <Name>string</Name>
          <CardType>string</CardType>
        </ViewUserPaymentMethodCreditCard>
        <ViewUserPaymentMethodCreditCard>
          <ID>int</ID>
          <CardTypeID>int</CardTypeID>
          <Number>string</Number>
          <AccountHolder>string</AccountHolder>
          <CCExpiryMonth>string</CCExpiryMonth>
          <CCExpiryYear>string</CCExpiryYear>
          <UserPaymentMethodID>int</UserPaymentMethodID>
          <Country>string</Country>
          <State>string</State>
          <City>string</City>
          <Address>string</Address>
          <ZipCode>string</ZipCode>
          <Phone>string</Phone>
          <Email>string</Email>
          <Name>string</Name>
          <CardType>string</CardType>
        </ViewUserPaymentMethodCreditCard>
      </GetUserPaymentMethodCreditCardsResult>
    </GetUserPaymentMethodCreditCardsResponse>
  </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/GetUserPaymentMethodCreditCards"

<?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>
    <GetUserPaymentMethodCreditCards xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserPaymentMethodCreditCards>
  </soap:Body>
</soap:Envelope>