Account.fetchByPaymentMethod

The fetchByPaymentMethod method returns all Account objects with a payment method that matches the input. Use this method to conduct global searches, such as “all the accounts that use a certain credit card as the payment method.” This method supports paging to limit the number of records returned per call. Occasionally, returning a large number of records in one call swamps buffers and might cause a failure. Vindicia recommends that you call this method in a loop, incrementing the page for each loop iteration with an optimal page size (number of records returned in one call) until the page contains a number of records that is less than the given page size.

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. paymentMethod: an object of type PaymentMethod, which serves as the search criterion. Identify the payment method with its VID, your payment method ID (merchantPaymentMethodId), or one of the following, depending on the payment method type:

The account number for a credit card.
The account number-bank routing number combination for ACH and ECP.
The fiscal number for a Boleto.
The PaypalEmail for PayPal.

Note: If you use SOAP releases prior to 3.5, you will not be able to search accounts using the PayPal payment method. If you use SOAP 3.6.0 or later, you can search accounts and transactions using PaypalEmail. page: the page number, starting at 0, for which to return the results. For example, if the total number of results is 85 and pageSize is 10:

Specifying 0 for page gets the results from 1 through 10.
Specifying 2 for page gets the results from 21 through 30.

pageSize: the number of records to display per page per call. This value must be greater than 0.

Output

return: an object of type Return that indicates the success or failure of the call. accounts: one or more Account objects whose payment method matches the input.

Returns

In addition to those listed in The Return Object , this call returns:

Return Code	Return String
`404`	No matching accounts.
`400`	One of the following: - `Payment method type is credit card, but credit card information is incomplete.` - `Payment method type is ECP, but ECP account and routing information is incomplete.` - `Payment method type is Boleto, but Boleto payment information is incomplete.` - `Payment method type is currently not supported.` - `Must specify a PaymentMethod object, a non-negative page number, and a page size greater than 0.`

Example

$pm = new PaymentMethod();
$pm->setType('CreditCard');
$cc = new CreditCard();
$cc->setAccount('4111111111111111'); 
// this is the card number we want to search by
$cc->setExpiration('201108');
$pm->setCreditCard($cc);

$acct = new Account();
$page = 0;
$pageSize = 10; // max 10 records per page

do {
   $response = $acct->fetchByPaymentMethod($pm, $page, $pageSize); 

   if($response['returnCode']==200) {
      $accounts = $response['data']->accounts;
      foreach ($accounts as $account) {
      // process each account found here
      print "Found account with id: " 
      . $account->getMerchantAccountId() . "\n";   
      }
   }
   $page++
} while (count($accounts) == $pageSize);

Parent topic:Account Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example