Refund.fetchDeltaSince

The fetchDeltaSince method returns one or more Refund objects whose time stamp falls on or after the time stamp specified in the input. Limit the number of objects returned by specifying an upper limit on the time stamp as well, using the endTimestamp parameter.

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.

timestamp: time stamp on and after which to return Refund objects.

endTimestamp: time stamp after which to cease returning Refund objects.

paymentMethod: restricts the return to only those Refund objects whose original Transactions were conducted with this payment method. Specify this parameter with either the paymentMethod VID or merchantPaymentMethodId. A null paymentMethod returns all Refund objects matching any payment method within the specified time period.

Output

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

refunds: an array of one or more Refund objects whose time stamp falls on or after timestamp but before endTimestamp (if specified) in the input.

Returns

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

Return Code	Return String
400	Must specify a time stamp to find refunds newer than …
404	Unable to find payment method in database.

Example

$refund = new Refund();
$pm = null;
$startTimeStamp = '2009-11-28T12:40:51-0800';
$endTimeStamp = '2009-12-28T12:40:50-0800';

$response = $refund->fetchDeltaSince($startTimestamp,$endTimestamp, $pm);

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

$fetchedRefunds = $response['data']->refunds;

// process fetched refunds here

if ($fetchedRefunds != null) {

foreach ($fetchedRefunds as $fetchedRef) {

// process a fetched refund here

print "Refund VID " . $fetchedRef->getVID();
print "Refund amount ". $fetchedRef->getAmount();
print "Refund timestamp ". $fetchedRef->getTimestamp();

}

}

}