SOAP API – GetCardTypes

GetCardTypes( username ) : CardType[]

Since: EngageIP v25.2

Returns the list of credit card types available to a user, or throws exception if the user does not exist.

The returned value from this method call is an array of CardType objects. A card type object consists of the following properties:

ID (Integer) - The unique ID of the card type
Name (String) - The name of the card type
OwnerID (Integer) - The ID of the owner to which the user and card type configurations belong
CardProcessorID (Integer) - The ID of the card processor used for the card type
EnableAVS (Boolean) - Indicates if address verification is being used for the card type
MinimumPayment (Double) - Deprecated field that represents a threshold for minimum payment amount. Int.Min value if no minimum
CardTypeTypeID (String) - The ID referring to the underlying type of card, for example Amex, Bankcard, Visa, Mastercard etc...
PreAuthReq (Boolean) - Indicates if a PreAuth is required
PreAuthAmountOverridable (Boolean) -Indicates if the PreAuth amount can be overridden
PreAuthDefaultAmount (Double) - The default PreAuth amount

Parameters:

username (String) - The username you would like to check available card types for. An exception will be thrown if the user does not exist.

Returns:

An array of CardType objects for the specified user.

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>
    <GetCardTypes xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetCardTypes>
  </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>
    <GetCardTypesResponse xmlns="Logisense_EngageIP">
      <GetCardTypesResult>
        <CardType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <CardProcessorID>int</CardProcessorID>
          <EnableAVS>boolean</EnableAVS>
          <MinimumPayment>double</MinimumPayment>
          <CardTypeTypeID>int</CardTypeTypeID>
          <PreAuthReq>boolean</PreAuthReq>
          <PreAuthAmountOverridable>boolean</PreAuthAmountOverridable>
          <PreAuthDefaultAmount>double</PreAuthDefaultAmount>
        </CardType>
        <CardType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <CardProcessorID>int</CardProcessorID>
          <EnableAVS>boolean</EnableAVS>
          <MinimumPayment>double</MinimumPayment>
          <CardTypeTypeID>int</CardTypeTypeID>
          <PreAuthReq>boolean</PreAuthReq>
          <PreAuthAmountOverridable>boolean</PreAuthAmountOverridable>
          <PreAuthDefaultAmount>double</PreAuthDefaultAmount>
        </CardType>
      </GetCardTypesResult>
    </GetCardTypesResponse>
  </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/GetCardTypes"

<?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>
    <GetCardTypes xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetCardTypes>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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:Body>
    <GetCardTypesResponse xmlns="Logisense_EngageIP">
      <GetCardTypesResult>
        <CardType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <CardProcessorID>int</CardProcessorID>
          <EnableAVS>boolean</EnableAVS>
          <MinimumPayment>double</MinimumPayment>
          <CardTypeTypeID>int</CardTypeTypeID>
          <PreAuthReq>boolean</PreAuthReq>
          <PreAuthAmountOverridable>boolean</PreAuthAmountOverridable>
          <PreAuthDefaultAmount>double</PreAuthDefaultAmount>
        </CardType>
        <CardType>
          <Validate />
          <ID>int</ID>
          <Name>string</Name>
          <OwnerID>int</OwnerID>
          <CardProcessorID>int</CardProcessorID>
          <EnableAVS>boolean</EnableAVS>
          <MinimumPayment>double</MinimumPayment>
          <CardTypeTypeID>int</CardTypeTypeID>
          <PreAuthReq>boolean</PreAuthReq>
          <PreAuthAmountOverridable>boolean</PreAuthAmountOverridable>
          <PreAuthDefaultAmount>double</PreAuthDefaultAmount>
        </CardType>
      </GetCardTypesResult>
    </GetCardTypesResponse>
  </soap:Body>
</soap:Envelope>