Net::Simplify::Refund - A Simplify Commerce Refund object
use Net::Simplify; $Net::Simplify::public_key = 'YOUR PUBLIC KEY'; $Net::Simplify::private_key = 'YOUR PRIVATE KEY'; # Create a new Refund. my $refund = Net::Simplify::Refund->create{ {...}); # Retrieve a Refund given its ID. my $refund = Net::Simplify::Refund->find('a7e41'); # Retrieve a list of objects my $refunds = Net::Simplify::Refund->list({max => 10}); foreach my $v ($refunds->list) { # ... }
Creates a Net::Simplify::Refund
object. The parameters are:
%params
Hash map containing initial values for the object. Valid keys are:
Amount of the refund in the smallest unit of your currency. Example: 100 = $1.00USD [min value: 1, max value: 9999900] (required)
ID of the payment for the refund (required)
Reason for the refund
Custom reference field to be used with outside systems.
An identifier that can be sent to uniquely identify a refund 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 refunds. If supplied, we will check for a refund on your account that matches this identifier. If found we will return an identical response to that of the original request. [max length: 50, min length: 1]
$auth
Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key
and $Net::Simplify::private_key
are used.
Retrieve a list of Net::Simplify::Refund
objects. The parameters are:
%criteria
Hash map representing the criteria to limit the results of the list operation. Valid keys are:
filter
Filters to apply to the list.
max
Allows up to a max of 50 list items to return. [max value: 50, default: 20]
offset
Used in paging of the list. This is the start offset of the page. [default: 0]
sorting
Allows for ascending or descending sorting of the list. The value maps properties to the sort direction (either asc
for ascending or desc
for descending). Sortable properties are:
id
amount
description
dateCreated
paymentDate
Retrieve a Net::Simplify::Refund
object from the API. Parameters are:
$id
Identifier of the object to retrieve.
$auth
Authentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key
and $Net::Simplify::private_key
are used.
Net::Simplify, Net::Simplify::Domain, Net::Simplify::DomainList, Net::Simplify::Authentication, Net::Simplify::ApiException, http://www.simplify.com
1.1.0
Copyright (c) 2013, 2014 MasterCard International Incorporated 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. Neither the name of the MasterCard International Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 COPYRIGHT HOLDER 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.