GetCustomerPaymentMethodProfile

Description

This method is used to retrieve a specific payment method 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 GetCustomerPaymentMethodProfile( SecurityToken securityToken, string customerToken, string paymentMethodId);

Arguments

Type	Name	Description
SecurityToken	securityToken	Merchant security token: used to identify merchant and validate transaction. (required)
string	customerToken	Unique customer token assigned by the gateway. (required)
string	paymentMethodId	Unique payment method ID assigned by the gateway. (required)

Return Value


PaymentMethodProfile	Returns a PaymentMethodProfile object.

Examples

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

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>********-23f6-4466-a993-********</ebiz:SecurityId>
            <ebiz:UserId>?</ebiz:UserId>
            <ebiz:Password>?</ebiz:Password>
         </ebiz:securityToken>
         <ebiz:customerToken>11558817</ebiz:customerToken>
         <ebiz:paymentMethodId>324</ebiz:paymentMethodId>
      </ebiz:GetCustomerPaymentMethodProfile>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
      <GetCustomerPaymentMethodProfileResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetCustomerPaymentMethodProfileResult>
            <MethodType>cc</MethodType>
            <MethodID>324</MethodID>
            <MethodName>Contoso Dallas</MethodName>
            <SecondarySort>0</SecondarySort>
            <Created>2021-05-20T04:57:55+00:00</Created>
            <Modified>2021-05-20T04:58:24+00:00</Modified>
            <AccountHolderName>Contoso Dallas</AccountHolderName>
            <AvsStreet>789 Orange Street Irving</AvsStreet>
            <AvsZip>75063</AvsZip>
            <CardExpiration>2026-05</CardExpiration>
            <CardNumber>XXXXXXXXXXXX1111</CardNumber>
            <CardType>V</CardType>
            <Balance>0</Balance>
            <MaxBalance>0</MaxBalance>
            <ReloadSchedule>{"cardholder":"Contoso Dallas"}</ReloadSchedule>
         </GetCustomerPaymentMethodProfileResult>
      </GetCustomerPaymentMethodProfileResponse>
   </s:Body>
</s:Envelope>