Simplify_Chargeback

Copyright (c) 2013 - 2015 MasterCard International Incorporated All rights reserved.

Defined (1)

The class is defined in the following location(s).

/includes/gateways/simplify-commerce/includes/Simplify/Chargeback.php  
  1. class Simplify_Chargeback extends Simplify_Object { 
  2.  
  3. /** 
  4. * Retrieve Simplify_Chargeback objects. 
  5. * @param array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;"> 
  6. * <dt><tt>filter</tt></dt> <dd>Filters to apply to the list. </dd> 
  7. * <dt><tt>max</tt></dt> <dd>Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20] </dd> 
  8. * <dt><tt>offset</tt></dt> <dd>Used in paging of the list. This is the start offset of the page. [min value: 0, default: 0] </dd> 
  9. * <dt><tt>sorting</tt></dt> <dd>Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either <tt>asc</tt> for ascending or <tt>desc</tt> for descending). Sortable properties are: <tt> id</tt><tt> amount</tt><tt> description</tt><tt> dateCreated</tt>.</dd></dl> 
  10. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  11. * @return ResourceList a ResourceList object that holds the list of Chargeback objects and the total 
  12. * number of Chargeback objects available for the given criteria. 
  13. * @see ResourceList 
  14. */ 
  15. static public function listChargeback($criteria = null, $authentication = null) { 
  16.  
  17. $args = func_get_args(); 
  18. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  19.  
  20. $val = new Simplify_Chargeback(); 
  21. $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication); 
  22.  
  23. return $list; 
  24.  
  25.  
  26. /** 
  27. * Retrieve a Simplify_Chargeback object from the API 
  28. * @param string id the id of the Chargeback object to retrieve 
  29. * @param $authentication - information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. <i>For backwards compatibility the public and private keys may be passed instead of the authentication object.</i> 
  30. * @return Chargeback a Chargeback object 
  31. */ 
  32. static public function findChargeback($id, $authentication = null) { 
  33.  
  34. $args = func_get_args(); 
  35. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  36.  
  37. $val = new Simplify_Chargeback(); 
  38. $val->id = $id; 
  39.  
  40. $obj = Simplify_PaymentsApi::findObject($val, $authentication); 
  41.  
  42. return $obj; 
  43.  
  44. /** 
  45. * @ignore 
  46. */ 
  47. public function getClazz() { 
  48. return "Chargeback";