Account.fetchCreditHistory

The fetchCreditHistory method returns creditEventLogs for the Account.

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.

account: the (optional) Account object for which you wish to retrieve credit event history. You may populate only the merchantAccountId or VID in this object so that CashBox can locate it in its database. Leave this variable blank if you wish to fetch credit history across all Accounts.

timestamp: the starting time stamp (lower limit) for the range of credit event logs you wish to retrieve.

endTimestamp: the ending time stamp (upper limit) for the range of credit event logs you wish to retrieve.

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 return 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.

creditEventLogs: an array of CreditEventLog objects. Each of these objects describes a specific credit-related event or action associated with the input Account. For more information, see CreditEventLog Object Data Members.

Returns

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

Return Code	Return String
400	One of the following: • Unable to load account. • Invalid value or values of time stamp, and/or page, and/or page size.
404	No matching credit events found.

Example

// to fetch credit history for an account

$acct = new Account();

// account id for an existing customer whose
// credit history you want to retrieve

$acct->setMerchantAccountId('jdoe101');

$page = 0; // paging begins at 0
$pageSize = 5; // five records
$startTime = '2010-01-01T22:34:32.265Z';
$endTime = '2010-01-30T22:34:32.265Z';

do {

$ret =

$acct->fetchCreditHistory($startTime, $endTime, $page, $pageSize);

$count = 0;
if ($ret['returnCode'] == 200) {

$fetchedLogs = $ret['creditEventLogs'];
$count = sizeof($fetchedLogs);
foreach ($fetchedLogs as $log) {

$credit = $log->getCredit();
$ts = $log->getTimeStamp();
$eventType = $log->getType();
// process retrieved credit event log
// details here.

}
$page++;

}

} while ($count > 0);