Guides
Guides
  1. Gateway Methods

GetCustomerPaymentMethodProfiles

Description

The GetCustomerPaymentMethodProfiles method retrieves all stored payment methods for the Customer.

Syntax

PaymentMethodProfile[] GetCustomerPaymentMethodProfiles(SecurityToken securityToken, string customerToken)

Arguments

Type

Name

Req.

Description

SecurityToken

securityToken

R

A unique token that is used to identify a merchant and authenticate the API request.

string

customerToken

R

Identifies the Customer associated with the stored payment methods.

Note: Retrieve this value using GetCustomerToken.

Return Value

TypeDescription
PaymentMethodProfile[]On success, returns all stored payment methods for the Customer. Otherwise, a fault is returned.

Example 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>***********4621-b899***********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Passwor/>
         </ebiz:securityToken>
         <ebiz:customerToken>***3343</ebiz:customerToken>
      </ebiz:GetCustomerPaymentMethodProfiles>
   </soapenv:Body>
</soapenv:Envelope>
var client = new IeBizServiceClient();

// Configure the API SecurityToken to use for API authentication
SecurityToken securityToken = new SecurityToken
        {
  SecurityId = "***********4bf0-91cd***********",
  UserId = "",
  Password = ""
  };

string customerToken = "****3803";

PaymentMethodProfile[] paymentMethodProfiles = client.GetCustomerPaymentMethodProfiles(securityToken, customerToken);
Console.WriteLine($"Number of methods returned: {paymentMethodProfiles.Length}");
function getCustomerPaymentMethodProfiles(){
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '***********4757-4567***********',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );
  $getCustomerPaymentMethodProfiles = array(
    'securityToken' => $securityToken,
    'customerToken' => '****504'
  );
  $getCustomerPaymentMethodProfilesResponse = $client-
    >GetCustomerPaymentMethodProfiles($getCustomerPaymentMethodProfiles);
  $getCustomerPaymentMethodProfilesResponseResult = $getCustomerPaymentMethodProfilesResponse-
    >GetCustomerPaymentMethodProfilesResult;
}

Example 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>112</MethodID>
               <MethodName/>
               <SecondarySort>123456</SecondarySort>
               <Created>2025-11-18T06:31:43+00:00</Created>
               <Modified>2025-11-18T06:31:43+00:00</Modified>
               <AccountHolderName>Bob</AccountHolderName>
               <AvsStreet>1234 Home Dr.</AvsStreet>
               <AvsZip>900000</AvsZip>
               <CardExpiration>2028-12</CardExpiration>
               <CardNumber>XXXXXXXXXXXX2224</CardNumber>
               <CardType>V</CardType>
               <Balance>0</Balance>
               <MaxBalance>0</MaxBalance>
               <ReloadSchedule>{"cardholder":"Bob"}</ReloadSchedule>
            </PaymentMethodProfile>
            <PaymentMethodProfile>
               <MethodType>cc</MethodType>
               <MethodID>109</MethodID>
               <MethodName/>
               <SecondarySort>123457</SecondarySort>
               <Created>2025-11-18T06:10:18+00:00</Created>
               <Modified>2025-11-18T06:31:43+00:00</Modified>
               <AccountHolderName>Bob</AccountHolderName>
               <AvsStreet>1234 Home Dr.</AvsStreet>
               <AvsZip>900000</AvsZip>
               <CardExpiration>2028-12</CardExpiration>
               <CardNumber>XXXXXXXXXXXX2224</CardNumber>
               <CardType>V</CardType>
               <Balance>0</Balance>
               <MaxBalance>0</MaxBalance>
               <ReloadSchedule>{"cardholder":"Bob"}</ReloadSchedule>
            </PaymentMethodProfile>
         </GetCustomerPaymentMethodProfilesResult>
      </GetCustomerPaymentMethodProfilesResponse>
   </s:Body>
</s:Envelope>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:InvalidcustomerInternalId</faultcode>
         <faultstring xml:lang="en-US">Invalid customerInternalId</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>

Updated 4 months ago