Simplify_Payment

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/Payment.php  
  1. class Simplify_Payment extends Simplify_Object { 
  2. /** 
  3. * Creates an Simplify_Payment object 
  4. * @param array $hash a map of parameters; valid keys are:<dl style="padding-left:10px;"> 
  5. * <dt><tt>amount</tt></dt> <dd>Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD </dd> 
  6. * <dt><tt>authorization</tt></dt> <dd>The ID of the authorization being used to capture the payment. </dd> 
  7. * <dt><tt>card.addressCity</tt></dt> <dd>City of the cardholder. [max length: 50, min length: 2] </dd> 
  8. * <dt><tt>card.addressCountry</tt></dt> <dd>Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2] </dd> 
  9. * <dt><tt>card.addressLine1</tt></dt> <dd>Address of the cardholder. [max length: 255] </dd> 
  10. * <dt><tt>card.addressLine2</tt></dt> <dd>Address of the cardholder if needed. [max length: 255] </dd> 
  11. * <dt><tt>card.addressState</tt></dt> <dd>State of residence of the cardholder. For the US, this is a 2-digit USPS code. [max length: 255, min length: 2] </dd> 
  12. * <dt><tt>card.addressZip</tt></dt> <dd>Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 9, min length: 3] </dd> 
  13. * <dt><tt>card.cvc</tt></dt> <dd>CVC security code of the card. This is the code on the back of the card. Example: 123 </dd> 
  14. * <dt><tt>card.expMonth</tt></dt> <dd>Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] <strong>required </strong></dd> 
  15. * <dt><tt>card.expYear</tt></dt> <dd>Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99] <strong>required </strong></dd> 
  16. * <dt><tt>card.name</tt></dt> <dd>Name as it appears on the card. [max length: 50, min length: 2] </dd> 
  17. * <dt><tt>card.number</tt></dt> <dd>Card number as it appears on the card. [max length: 19, min length: 13] <strong>required </strong></dd> 
  18. * <dt><tt>currency</tt></dt> <dd>Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] <strong>required </strong></dd> 
  19. * <dt><tt>customer</tt></dt> <dd>ID of customer. If specified, card on file of customer will be used. </dd> 
  20. * <dt><tt>description</tt></dt> <dd>Free form text field to be used as a description of the payment. This field is echoed back with the payment on any find or list operations. [max length: 1024] </dd> 
  21. * <dt><tt>invoice</tt></dt> <dd>ID of invoice for which this payment is being made. </dd> 
  22. * <dt><tt>reference</tt></dt> <dd>Custom reference field to be used with outside systems. </dd> 
  23. * <dt><tt>replayId</tt></dt> <dd>An identifier that can be sent to uniquely identify a payment request to facilitate retries due to I/O related issues. This identifier must be unique for your account (sandbox or live) across all of your payments. If supplied, we will check for a payment on your account that matches this identifier. If found will attempt to return an identical response of the original request. [max length: 50, min length: 1] </dd> 
  24. * <dt><tt>statementDescription.name</tt></dt> <dd>Merchant name. <strong>required </strong></dd> 
  25. * <dt><tt>statementDescription.phoneNumber</tt></dt> <dd>Merchant contact phone number. </dd> 
  26. * <dt><tt>token</tt></dt> <dd>If specified, card associated with card token will be used. [max length: 255] </dd></dl> 
  27. * @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/> 
  28. * @return Payment a Payment object. 
  29. */ 
  30. static public function createPayment($hash, $authentication = null) { 
  31.  
  32. $args = func_get_args(); 
  33. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  34.  
  35. $instance = new Simplify_Payment(); 
  36. $instance->setAll($hash); 
  37.  
  38. $object = Simplify_PaymentsApi::createObject($instance, $authentication); 
  39. return $object; 
  40.  
  41.  
  42.  
  43. /** 
  44. * Retrieve Simplify_Payment objects. 
  45. * @param array criteria a map of parameters; valid keys are:<dl style="padding-left:10px;"> 
  46. * <dt><tt>filter</tt></dt> <dd>Filters to apply to the list. </dd> 
  47. * <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> 
  48. * <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> 
  49. * <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> dateCreated</tt><tt> createdBy</tt><tt> amount</tt><tt> id</tt><tt> description</tt><tt> paymentDate</tt>.</dd></dl> 
  50. * @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> 
  51. * @return ResourceList a ResourceList object that holds the list of Payment objects and the total 
  52. * number of Payment objects available for the given criteria. 
  53. * @see ResourceList 
  54. */ 
  55. static public function listPayment($criteria = null, $authentication = null) { 
  56.  
  57. $args = func_get_args(); 
  58. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  59.  
  60. $val = new Simplify_Payment(); 
  61. $list = Simplify_PaymentsApi::listObject($val, $criteria, $authentication); 
  62.  
  63. return $list; 
  64.  
  65.  
  66. /** 
  67. * Retrieve a Simplify_Payment object from the API 
  68. * @param string id the id of the Payment object to retrieve 
  69. * @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> 
  70. * @return Payment a Payment object 
  71. */ 
  72. static public function findPayment($id, $authentication = null) { 
  73.  
  74. $args = func_get_args(); 
  75. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 2); 
  76.  
  77. $val = new Simplify_Payment(); 
  78. $val->id = $id; 
  79.  
  80. $obj = Simplify_PaymentsApi::findObject($val, $authentication); 
  81.  
  82. return $obj; 
  83.  
  84.  
  85. /** 
  86. * Updates an Simplify_Payment object. 
  87. * The properties that can be updated: 
  88. * <dl style="padding-left:10px;"></dl> 
  89. * @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> 
  90. * @return Payment a Payment object. 
  91. */ 
  92. public function updatePayment($authentication = null) { 
  93.  
  94. $args = func_get_args(); 
  95. $authentication = Simplify_PaymentsApi::buildAuthenticationObject($authentication, $args, 1); 
  96.  
  97. $object = Simplify_PaymentsApi::updateObject($this, $authentication); 
  98. return $object; 
  99.  
  100. /** 
  101. * @ignore 
  102. */ 
  103. public function getClazz() { 
  104. return "Payment";