NAME

Net::Simplify::Payment - A Simplify Commerce Payment object

SYNOPSIS

  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) {
      # ...
  }

DESCRIPTION

METHODS

create(%params, $auth)

Creates a Net::Simplify::Payment object. The parameters are:

%params

Hash map containing initial values for the object. Valid keys are:

amount: Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00
authorization: The ID of the authorization being used to capture the payment.
card.addressCity: City of the cardholder. [max length: 50, min length: 2]
card.addressCountry: Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]
card.addressLine1: Address of the cardholder. [max length: 255]
card.addressLine2: Address of the cardholder if needed. [max length: 255]
card.addressState: State of residence of the cardholder. State abbreviations should be used. [max length: 255]
card.addressZip: Postal code of the cardholder. The postal code size is between 5 and 9 in length and only contain numbers or letters. [max length: 32]
card.cvc: CVC security code of the card. This is the code on the back of the card. Example: 123
card.expMonth: Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]
card.expYear: Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]
card.name: Name as it appears on the card. [max length: 50, min length: 2]
card.number: Card number as it appears on the card. [max length: 19, min length: 13]
currency: Currency code (ISO-4217) for the transaction. Must match the currency associated with your account. [default: USD] (required)
customer: ID of customer. If specified, card on file of customer will be used.
description: 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]
invoice: ID of invoice for which this payment is being made.
invoiceReference: Invoice reference number.
order.commodityCode: Standard classification code for products and services. [max length: 5]
order.customer: ID of the customer associated with the order.
order.customerEmail: Customer email address.
order.customerName: Customer name.
order.customerNote: Additional notes provided by the customer. [max length: 255]
order.customerReference: A merchant reference for the customer.
order.items.amount: Cost of the item.
order.items.description: Description of the item.
order.items.name: Item name.
order.items.product: Product information associated with the item.
order.items.quantity: Quantity of the item contained in the order [min value: 1, max value: 999999, default: 1] (required)
order.items.reference: A merchant reference for the item. [max length: 255]
order.items.tax: Taxes associated with the item.
order.merchantNote: Additional notes provided by the merchant. [max length: 255]
order.payment: ID of the payment associated with the order.
order.reference: A merchant reference for the order. [max length: 255]
order.shippingAddress.city: City, town, or municipality. [max length: 255, min length: 2]
order.shippingAddress.country: 2-character country code. [max length: 2, min length: 2]
order.shippingAddress.line1: Street address. [max length: 255]
order.shippingAddress.line2: (Opt) Street address continued. [max length: 255]
order.shippingAddress.name: Name of the entity being shipped to. [max length: 255]
order.shippingAddress.state: State or province. [max length: 255]
order.shippingAddress.zip: Postal code. [max length: 32]
order.shippingFromAddress.city: City, town, or municipality. [max length: 255, min length: 2]
order.shippingFromAddress.country: 2-character country code. [max length: 2, min length: 2]
order.shippingFromAddress.line1: Street address. [max length: 255]
order.shippingFromAddress.line2: (Opt) Street address continued. [max length: 255]
order.shippingFromAddress.name: Name of the entity performing the shipping. [max length: 255]
order.shippingFromAddress.state: State or province. [max length: 255]
order.shippingFromAddress.zip: Postal code. [max length: 32]
order.shippingName: Name of the entity being shipped to.
order.source: Order source. [default: WEB] (required)
order.status: Status of the order. [default: INCOMPLETE] (required)
reference: Custom reference field to be used with outside systems.
replayId: 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]
statementDescription.name: Merchant name. (required)
statementDescription.phoneNumber: Merchant contact phone number.
taxExempt: Specify true to indicate that the payment is tax-exempt.
token: If specified, card associated with card token will be used. [max length: 255]

$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.

list(%criteria, $auth)

Retrieve a list of Net::Simplify::Payment objects. The parameters are:

%criteria

Hash map representing the criteria to limit the results of the list operation. Valid keys are:

filter

<table class="filter_list"><tr><td>filter.id</td><td>Filter by the payment Id</td></tr><tr><td>filter.replayId</td><td>Filter by the compoundReplayId</td></tr><tr><td>filter.last4</td><td>Filter by the card number (last 4 digits)</td></tr><tr><td>filter.amount</td><td>Filter by the payment amount (in the smallest unit of your currency)</td></tr><tr><td>filter.text</td><td>Filter by the description of the payment</td></tr><tr><td>filter.amountMin & filter.amountMax</td><td>The filter amountMin must be used with amountMax to find payments with payments amounts between the min and max figures</td></tr><tr><td>filter.dateCreatedMin<sup>*</sup></td><td>Filter by the minimum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.dateCreatedMax<sup>*</sup></td><td>Filter by the maximum created date you are searching for - Date in UTC millis</td></tr><tr><td>filter.deposit</td><td>Filter by the deposit id connected to the payment</td></tr><tr><td>filter.customer</td><td>Filter using the Id of the customer to find the payments for that customer</td></tr><tr><td>filter.status</td><td>Filter by the payment status text</td></tr><tr><td>filter.reference</td><td>Filter by the payment reference text</td></tr><tr><td>filter.authCode</td><td>Filter by the payment authorization code (Not the authorization ID)</td></tr><tr><td>filter.q</td><td>You can use this to filter by the Id, the authCode or the amount of the payment</td></tr></table><br><sup>*</sup>Use dateCreatedMin with dateCreatedMax in the same filter if you want to search between two created dates

max

Allows up to a max of 50 list items to return. [min value: 0, max value: 50, default: 20]

offset

Used in paging of the list. This is the start offset of the page. [min value: 0, 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:

dateCreated
createdBy
amount
id
description
paymentDate

find($id, $auth)

Retrieve a Net::Simplify::Payment 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.

update()

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.

VERSION

1.6.0

LICENSE

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.