Net::Simplify::Payment - A Simplify Commerce Payment object
use Net::Simplify;
$Net::Simplify::public_key = 'YOUR PUBLIC KEY';
$Net::Simplify::private_key = 'YOUR PRIVATE KEY';
# Create a new Payment.
my $payment = Net::Simplify::Payment->create{ {...});
# Retrieve a Payment given its ID.
my $payment = Net::Simplify::Payment->find('a7e41');
# Update existing Payment.
my $payment = Net::Simplify::Payment->find('a7e41');
$payment->{PROPERTY} = "NEW VALUE";
$payment->update();
# Retrieve a list of objects
my $payments = Net::Simplify::Payment->list({max => 10});
foreach my $v ($payments->list) {
# ...
}
Creates a Net::Simplify::Payment object. The parameters are:
%paramsHash map containing initial values for the object. Valid keys are:
Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00USD [min value: 50, max value: 9999900]
The ID of the authorization being used to capture the payment.
City of the cardholder. [max length: 50, min length: 2]
Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
Address of the cardholder. [max length: 255]
Address of the cardholder if needed. [max length: 255]
State code (USPS code) of residence of the cardholder. [max length: 2, min length: 2]
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]
CVC security code of the card. This is the code on the back of the card. Example: 123
Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12] (required)
Expiration year of the card. Format is YY. Example: 2013 = 13 [max value: 99] (required)
Name as it appears on the card. [max length: 50, min length: 2]
Card number as it appears on the card. [max length: 19, min length: 13] (required)
Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] (required)
ID of customer. If specified, card on file of customer will be used.
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]
ID of invoice for which this payment is being made.
Custom reference field to be used with outside systems.
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]
If specified, card associated with card token will be used. [max length: 255]
$authAuthentication 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::Payment objects. The parameters are:
%criteriaHash map representing the criteria to limit the results of the list operation. Valid keys are:
filterFilters to apply to the list.
maxAllows up to a max of 50 list items to return. [max value: 50, default: 20]
offsetUsed in paging of the list. This is the start offset of the page. [default: 0]
sortingAllows 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:
dateCreatedamountiddescriptionpaymentDateRetrieve a Net::Simplify::Payment object from the API. Parameters are:
$idIdentifier of the object to retrieve.
$authAuthentication object for accessing the API. If no value is passed the global keys $Net::Simplify::public_key and $Net::Simplify::private_key are used.
Update Net::Simplify::Payment object. The properties that can be updated are:
Authentication is done using the same credentials used when the AccessToken was created.
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.