Service Web Service

Service

Click here for a complete list of operations.

GetCustomerPaymentProfileList

This method is used to retrieve existing customer payment profiles. The merchant must be signed up for the CIM service to use it.

Test

The test form is only available for requests from the local machine.

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 /soap/v1/Service.asmx HTTP/1.1
Host: api2.authorize.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.authorize.net/soap/v1/GetCustomerPaymentProfileList"

<?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>
    <GetCustomerPaymentProfileList xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <getCustomerPaymentProfileListRequestType>
        <searchType>cardsExpiringInMonth</searchType>
        <month>string</month>
        <sorting>
          <orderBy>id</orderBy>
          <orderDescending>boolean</orderDescending>
        </sorting>
        <paging>
          <limit>int</limit>
          <offset>int</offset>
        </paging>
      </getCustomerPaymentProfileListRequestType>
      <clientId>string</clientId>
    </GetCustomerPaymentProfileList>
  </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>
    <GetCustomerPaymentProfileListResponse xmlns="https://api.authorize.net/soap/v1/">
      <GetCustomerPaymentProfileListResult>
        <paymentProfiles>
          <paymentProfile>
            <customerPaymentProfileId>long</customerPaymentProfileId>
            <customerProfileId>long</customerProfileId>
            <billTo xsi:nil="true" />
            <payment xsi:nil="true" />
          </paymentProfile>
          <paymentProfile>
            <customerPaymentProfileId>long</customerPaymentProfileId>
            <customerProfileId>long</customerProfileId>
            <billTo xsi:nil="true" />
            <payment xsi:nil="true" />
          </paymentProfile>
        </paymentProfiles>
        <totalNumInResultSet>int</totalNumInResultSet>
      </GetCustomerPaymentProfileListResult>
    </GetCustomerPaymentProfileListResponse>
  </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.

POST /soap/v1/Service.asmx HTTP/1.1
Host: api2.authorize.net
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>
    <GetCustomerPaymentProfileList xmlns="https://api.authorize.net/soap/v1/">
      <merchantAuthentication>
        <name>string</name>
        <transactionKey>string</transactionKey>
      </merchantAuthentication>
      <getCustomerPaymentProfileListRequestType>
        <searchType>cardsExpiringInMonth</searchType>
        <month>string</month>
        <sorting>
          <orderBy>id</orderBy>
          <orderDescending>boolean</orderDescending>
        </sorting>
        <paging>
          <limit>int</limit>
          <offset>int</offset>
        </paging>
      </getCustomerPaymentProfileListRequestType>
      <clientId>string</clientId>
    </GetCustomerPaymentProfileList>
  </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>
    <GetCustomerPaymentProfileListResponse xmlns="https://api.authorize.net/soap/v1/">
      <GetCustomerPaymentProfileListResult>
        <paymentProfiles>
          <paymentProfile>
            <customerPaymentProfileId>long</customerPaymentProfileId>
            <customerProfileId>long</customerProfileId>
            <billTo xsi:nil="true" />
            <payment xsi:nil="true" />
          </paymentProfile>
          <paymentProfile>
            <customerPaymentProfileId>long</customerPaymentProfileId>
            <customerProfileId>long</customerProfileId>
            <billTo xsi:nil="true" />
            <payment xsi:nil="true" />
          </paymentProfile>
        </paymentProfiles>
        <totalNumInResultSet>int</totalNumInResultSet>
      </GetCustomerPaymentProfileListResult>
    </GetCustomerPaymentProfileListResponse>
  </soap12:Body>
</soap12:Envelope>