NAME

Net::Simplify::CardToken - A Simplify Commerce CardToken object

SYNOPSIS

  use Net::Simplify;


  $Net::Simplify::public_key = 'YOUR PUBLIC KEY';
  $Net::Simplify::private_key = 'YOUR PRIVATE KEY';

  # Create a new CardToken.
  my $card_token = Net::Simplify::CardToken->create{ {...});

  # Retrieve a CardToken given its ID.
  my $card_token = Net::Simplify::CardToken->find('a7e41');

  # Update existing CardToken.
  my $card_token = Net::Simplify::CardToken->find('a7e41');
  $card_token->{PROPERTY} = "NEW VALUE";
  $card_token->update();

DESCRIPTION

METHODS

create(%params, $auth)

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

%params

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

authenticatePayer: Set as true to create CardToken for EMV 3DS transaction. [default: false]
callback: The URL callback for the cardtoken
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 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]
key: Key used to create the card token.
secure3DRequestData.amount: Amount of the subsequent transaction in the smallest unit of your currency. Example: 100 = $1.00 (required)
secure3DRequestData.authOnly: Specifies if the subsequent transaction is going to be a Payment or an Authorization (to be Captured later). If false or not specified, it refers to a Payment, otherwise it refers to an Authorization.
secure3DRequestData.currency: Currency code (ISO-4217). Must match the currency associated with your account. (required)
secure3DRequestData.description: A description of the transaction. [max length: 256]
secure3DRequestData.id: 3D Secure data ID.
source: Card Token Source [default: API]

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

find($id, $auth)

Retrieve a Net::Simplify::CardToken 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::CardToken object. The properties that can be updated are:

device.browser

The User-Agent header of the browser the customer used to place the order (required)

device.ipAddress

The IP address of the device used by the payer, in nnn.nnn.nnn.nnn format. (required)

device.language

The language supported for the payer's browser as defined in IETF BCP47.

device.screenHeight

The total height of the payer's browser screen in pixels.

device.screenWidth

The total width of the payer's browser screen in pixels.

device.timeZone

The timezone of the device used by the payer, in Zone ID format. Example: "Europe/Dublin" (required)

key

The public key of the merchant to be used for the token

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.