You are here

Home » API reference » Commerce Mollie 7 » Refunds.php

class Mollie_API_Resource_Payments_Refunds in Commerce Mollie 7

Copyright (c) 2013, Mollie B.V. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

@license Berkeley Software Distribution License (BSD-License 2) http://www.opensource.org/licenses/bsd-license.php @author Mollie B.V. <info@mollie.nl> @copyright Mollie B.V. @link https://www.mollie.nl

@method Mollie_API_Object_Payment_Refund[]|Mollie_API_Object_List all($offset = 0, $limit = 0) @method Mollie_API_Object_Payment_Refund get($resource_id)

Hierarchy

Expanded class hierarchy of Mollie_API_Resource_Payments_Refunds

File

Mollie/API/Resource/Payments/Refunds.php, line 36

View source 
class Mollie_API_Resource_Payments_Refunds extends Mollie_API_Resource_Base {

  /**
   * @var string
   */
  private $payment_id;

  /**
   * @return Mollie_API_Object_Method
   */
  protected function getResourceObject() {
    return new Mollie_API_Object_Payment_Refund();
  }

  /**
   * @return string
   */
  protected function getResourceName() {
    return "payments/" . urlencode($this->payment_id) . "/refunds";
  }

  /**
   * Set the resource to use a certain payment. Use this method before performing a get() or all() call.
   *
   * @param Mollie_API_Object_Payment $payment
   * @return self
   */
  public function with(Mollie_API_Object_Payment $payment) {
    $this->payment_id = $payment->id;
    return $this;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Mollie_API_Resource_Base::$api protected property
Mollie_API_Resource_Base::all public function Retrieve all objects of a certain resource.
Mollie_API_Resource_Base::copy protected function Copy the results received from the API into the PHP objects that we use.
Mollie_API_Resource_Base::create public function Create a resource with the remote API.
Mollie_API_Resource_Base::DEFAULT_LIMIT constant Default number of objects to retrieve when listing all objects.
Mollie_API_Resource_Base::get public function Retrieve information on a single resource from Mollie.
Mollie_API_Resource_Base::performApiCall protected function Perform an API call, and interpret the results and convert them to correct objects.
Mollie_API_Resource_Base::rest_create private function
Mollie_API_Resource_Base::REST_CREATE constant
Mollie_API_Resource_Base::REST_DELETE constant
Mollie_API_Resource_Base::rest_list private function Get a collection of objects from the REST API.
Mollie_API_Resource_Base::REST_LIST constant
Mollie_API_Resource_Base::rest_read private function Retrieves a single object from the REST API.
Mollie_API_Resource_Base::REST_READ constant
Mollie_API_Resource_Base::REST_UPDATE constant
Mollie_API_Resource_Base::__construct public function
Mollie_API_Resource_Payments_Refunds::$payment_id private property
Mollie_API_Resource_Payments_Refunds::getResourceName protected function Overrides Mollie_API_Resource_Base::getResourceName
Mollie_API_Resource_Payments_Refunds::getResourceObject protected function Overrides Mollie_API_Resource_Base::getResourceObject
Mollie_API_Resource_Payments_Refunds::with public function Set the resource to use a certain payment. Use this method before performing a get() or all() call.