PaymentMethod.fetchByMerchantPaymentMethodId

The fetchByMerchantPaymentMethodId method returns a PaymentMethod object whose merchantPaymentMethodId (assigned by you) matches the input.

Input

srd: sparse response description, a SOAP string (which must be a JSON object), in which you specify the elements you want returned.This parameter enables the calling system to constrain a method call to return only components you specify. This gives you greater control over returned content, and improves response time within the Vindicia platform by reducing the processing needed for the call.

Some fields are required, either practically or in the WSDL, and will be returned regardless of the srd. A null srd returns the complete response.

paymentMethodId: the payment method ID (merchantPaymentMethodId), which serves as the search criterion.

Output

return: an object of type Return that indicates the success or failure of the call.

paymentMethod: the PaymentMethod object whose merchantPaymentMethodId matches the input.

Returns

In addition to those listed in Standard Return Codes, this call returns:

Return Code	Return String
400	Missing required parameter paymentMethodId.
404	Unable to find requested PaymentMethod: error-description.

Example

$merchantId = '12345';

// Create a payment method object to make the call

$paymentMethod = new PaymentMethod();

$pmId = 'PM34922012';

$response = $paymentMethod->fetchByMerchantPaymentMethodId($pmId);

if($response['returnCode'] == 200) {

$fetchedPm = $response['data']->paymentMethod;

if($fetchedPm != null) {

// process the fetched payment method object here

$accountHolder = $fetchedPm->getAccountHolderName();
if ($fetchedPm->getType() == "CreditCard") {

$cc = $fetchedPm->getCreditCard();

// process other credit card attributes here

}

else if($fetchedPm->getType() == "ECP") {

$ecp = $fetchedPm->getEcp();

// process other ecp attributes here

}

}

}