GetCustomerPaymentMethodProfiles

Retrieve the customer payment methods for a given customerToken.

Description

This method is used to retrieve all of the payment methods stored for a particular customer.

Further, it requires the use of the customerToken, a unique customer number assigned by the gateway.
If you have lost or cannot remember the customer's customerToken, use the GetCustomerToken method to find the correct customerToken.

Syntax

PaymentMethodProfile [] GetCustomerPaymentMethodProfiles( SecurityToken securityToken, string customerToken)

Arguments

TypeNameDescription
SecurityTokensecurityTokenMerchant security token: used to identify merchant and validate transaction. (required)
stringcustomerTokenUnique customer token assigned by the gateway. (required)

Return Value

PaymentMethodProfile []Returns Array of PaymentMethodProfile objects.

Examples

function getCustomerPaymentMethodProfiles(){
$client = new SoapClient('End point URL');
$securityToken = array(
'SecurityId' => '******-454757-4567457-********',
'UserId' => 'merchant1',
'Password' => 'merchant1'
);
$getCustomerPaymentMethodProfiles = array(
'securityToken' => $securityToken,
'customerToken' => '9197504'
);
$getCustomerPaymentMethodProfilesResponse = $client-
>GetCustomerPaymentMethodProfiles($getCustomerPaymentMethodProfiles);
$getCustomerPaymentMethodProfilesResponseResult = $getCustomerPaymentMethodProfilesResponse-
>GetCustomerPaymentMethodProfilesResult;
}
Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header />
   <soapenv:Body>
      <ebiz:GetCustomerPaymentMethodProfiles>
         <ebiz:securityToken>
            <ebiz:SecurityId>********-794B-4CEE-B4DF-********</ebiz:SecurityId>
            <ebiz:UserId>?</ebiz:UserId>
            <ebiz:Password>?</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:customerToken>11527195</ebiz:customerToken>
      </ebiz:GetCustomerPaymentMethodProfiles>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetCustomerPaymentMethodProfilesResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetCustomerPaymentMethodProfilesResult>
            <PaymentMethodProfile>
               <MethodType>cc</MethodType>
               <MethodID>1716</MethodID>
               <MethodName>Rachel Bayswater</MethodName>
               <SecondarySort>0</SecondarySort>
               <Created>2021-05-19T18:11:26+00:00</Created>
               <Modified>2021-05-19T18:11:27+00:00</Modified>
               <AccountHolderName>Rachel Bayswater</AccountHolderName>
               <CardExpiration>2022-09</CardExpiration>
               <CardNumber>XXXXXXXXXXXX2224</CardNumber>
               <CardType>V</CardType>
               <Balance>0</Balance>
               <MaxBalance>0</MaxBalance>
               <ReloadSchedule>{"cardholder":"Rachel Bayswater"}</ReloadSchedule>
            </PaymentMethodProfile>
            <PaymentMethodProfile>
               <MethodType>cc</MethodType>
               <MethodID>2502</MethodID>
               <MethodName>Rachel Bayswater</MethodName>
               <SecondarySort>123456</SecondarySort>
               <Created>2021-07-04T17:10:08+00:00</Created>
               <Modified>2021-07-04T17:10:08+00:00</Modified>
               <AccountHolderName>Rachel Bayswater</AccountHolderName>
               <AvsStreet>House # 234 Street 34</AvsStreet>
               <AvsZip>31772</AvsZip>
               <CardExpiration>2022-09</CardExpiration>
               <CardNumber>XXXXXXXXXXXX2224</CardNumber>
               <CardType>V</CardType>
               <Balance>0</Balance>
               <MaxBalance>0</MaxBalance>
               <ReloadSchedule>{"cardholder":"Rachel Bayswater"}</ReloadSchedule>
            </PaymentMethodProfile>
         </GetCustomerPaymentMethodProfilesResult>
      </GetCustomerPaymentMethodProfilesResponse>
   </s:Body>
</s:Envelope>