GetCustomerPaymentMethodProfile

Description

The GetCustomerPaymentMethodProfile method retrieves a specific stored payment method for a Customer.

Syntax

PaymentMethodProfile GetCustomerPaymentMethodProfile(SecurityToken securityToken, string customerToken, string paymentMethodId)

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 method. Note: Retrieve this value using GetCustomerToken.
string	paymentMethodId	R	Identifies the PaymentMethodProfile to retrieve.

Type

Name

Req.

Description

SecurityToken

securityToken

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

string

customerToken

Identifies the Customer associated with the stored payment method.

Note: Retrieve this value using GetCustomerToken.

string

paymentMethodId

Identifies the PaymentMethodProfile to retrieve.

Return Value

Type	Description
PaymentMethodProfile	On success, returns the requested stored payment method. 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:GetCustomerPaymentMethodProfile>
         <ebiz:securityToken>
            <ebiz:SecurityId>***********4621-b899***********</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:customerToken>*****3432</ebiz:customerToken>
         <ebiz:paymentMethodId>115</ebiz:paymentMethodId>
      </ebiz:GetCustomerPaymentMethodProfile>
   </soapenv:Body>
</soapenv:Envelope>

var client = new IeBizServiceClient();

SecurityToken securityToken = new SecurityToken
{
    SecurityId = "***********4bf0-91cd***********",
    UserId = "",
    Password = ""
};

string customerToken = "****3803";
string paymentMethodId = "12097";

PaymentMethodProfile paymentMethodProfile = client.GetCustomerPaymentMethodProfile(securityToken, customerToken, paymentMethodId);
Console.WriteLine($"Card Type: {paymentMethodProfile.CardType}");

function getCustomerPaymentMethodProfile(){
  $client = new SoapClient('End point URL');
  $securityToken = array(
    'SecurityId' => '***********4757-4567***********',
    'UserId' => 'merchant1',
    'Password' => 'merchant1'
  );
  $getCustomerPaymentMethodProfile = array(
    'securityToken' => $securityToken,
    'customerToken' => '****3504',
    'paymentMethodId' => 1,
  );
  $getCustomerPaymentMethodProfileResponse = $client-
    >GetCustomerPaymentMethodProfile($getCustomerPaymentMethodProfile);
  $getCustomerPaymentMethodProfileResponseResult = $getCustomerPaymentMethodProfileResponse-
    >GetCustomerPaymentMethodProfileResult;
}

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">
      <GetCustomerPaymentMethodProfileResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetCustomerPaymentMethodProfileResult>
            <MethodType>cc</MethodType>
            <MethodID>115</MethodID>
            <MethodName/>
            <SecondarySort>123456</SecondarySort>
            <Created>2025-11-18T07:15:33+00:00</Created>
            <Modified>2025-11-18T07:15:33+00:00</Modified>
            <AccountHolderName>Sally</AccountHolderName>
            <AvsStreet>123 Orange Ave.</AvsStreet>
            <AvsZip>90909</AvsZip>
            <CardExpiration>2025-11</CardExpiration>
            <CardNumber>XXXXXXXXXXXX2228</CardNumber>
            <CardType>V</CardType>
            <Balance>0</Balance>
            <MaxBalance>0</MaxBalance>
            <ReloadSchedule>{"cardholder":"Sally"}</ReloadSchedule>
         </GetCustomerPaymentMethodProfileResult>
      </GetCustomerPaymentMethodProfileResponse>
   </s:Body>
</s:Envelope>

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <s:Fault>
         <faultcode>s:PaymentMethodProfileNotFound</faultcode>
         <faultstring xml:lang="en-US">PaymentMethodProfile Not Found</faultstring>
      </s:Fault>
   </s:Body>
</s:Envelope>