Chargeback.fetchByStatusSince

The fetchByStatusSince method returns one or more Chargeback objects whose statuses match the input and have changed since the specified time stamp. This call is similar the fetchByStatus() (see the preceding section), except that, with this call, you can restrict the retrieved chargebacks to a time window during which they changed to the status specified in the input. Make this call periodically to, for example, retrieve the chargebacks that you have won so as to adjust your revenue statistics accordingly. Be sure to record the time you previously made this call and specify that time in the input for your next call.

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. status: a ChargebackStatus value. See Table 1. timestamp: the date and time on or after which the status of the Chargeback objects changed to status. 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. Value must be greater than 0.

Output

return: an object of type Return that indicates the success or failure of the call. chargebacks: an array of one or more Chargeback objects whose status changed since the time stamp specified in the input.

Returns

This method returns the codes listed in The Return Object.

Example

$cb = new Chargeback();
$page = 0;
$pageSize = 50;
// Assume a function is available that returned time stamp when 
// we last made this call
$since = getLastCallTimestamp();
do {
   $ret = $cb->fetchByStatusSince('Won', $since, $page, $pageSize);
   $count = 0;
   if ($ret['returnCode'] == 200) {
      $fetchedChargebacks = $ret['chargebacks'];
      if ($fetchedChargebacks != null) {
         $count = sizeof($fetchedChargebacks);
         foreach ($fetchedChargebacks as $chargeback) {
         // process a fetched chargeback here …
         $transactionId = $chargeback->getMerchantTransactionId();
         $amount = $chargeback->getAmount();
         }
         $page++;
      }
   }
} while ($count > 0);

Parent topic:Chargeback Methods

Home

Guides

APIs

Input

Output

Returns

Example

​Input

​Output

​Returns

​Example

Input

Output

Returns

Example