GET PaymentTypes API

Updated on 2014-05-21
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

Summary:

Returns an array of payment types.

Resource/WSDL Page:

http:///api/1/get.asmx?op=PaymentTypes

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and not expired) 

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

 **Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value). 

 

Example Request

GET

http://demo.cakemarketing.com/api/1/get.asmx/PaymentTypes?api_key=dNJFmId9rI

 

Sample XML Response:

<payment_types_response>
  <success>true</success>
  <row_count>5</row_count>
  <payment_types>
    <payment_type>
      <payment_type_id>1</payment_type_id>
      <payment_type_name>Check</payment_type_name>
    </payment_type>
    <payment_type>
      <payment_type_id>2</payment_type_id>
      <payment_type_name>Wire</payment_type_name>
    </payment_type>
    <payment_type>
      <payment_type_id>3</payment_type_id>
      <payment_type_name>ACH</payment_type_name>
    </payment_type>
    <payment_type>
      <payment_type_id>4</payment_type_id>
      <payment_type_name>PayPal</payment_type_name>
    </payment_type>
    <payment_type>
      <payment_type_id>5</payment_type_id>
      <payment_type_name>Credit Card</payment_type_name>
    </payment_type>
  </payment_types>
</payment_types_response>

Example Error Messages:  

Error Message

Likely Cause

Invalid API Key

API key does not exist or is expired