API Documentation
\

\Simplify_CardToken

Base class for all domain objects.

Summary

Methods
Properties
Constants
createCardToken()
findCardToken()
updateCardToken()
setAll()
getProperties()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$properties
N/A

Properties

$properties

$properties

Methods

createCardToken()

createCardToken(array $hash, mixed $authentication) : \CardToken

Creates an Simplify_CardToken object

Parameters

array $hash

a map of parameters; 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]
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.<i/>

Returns

\CardToken —

a CardToken object.

findCardToken()

findCardToken( $id, mixed $authentication) : \CardToken

Retrieve a Simplify_CardToken object from the API

Parameters

$id
mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\CardToken —

a CardToken object

updateCardToken()

updateCardToken(mixed $authentication) : \CardToken

Updates an Simplify_CardToken object.

The properties that can be updated:

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

Parameters

mixed $authentication
  • information used for the API call. If no value is passed the global keys Simplify::public_key and Simplify::private_key are used. For backwards compatibility the public and private keys may be passed instead of the authentication object.

Returns

\CardToken —

a CardToken object.

setAll()

setAll(mixed $hash)

Updates the object's properties with the values in the specified map.

Parameters

mixed $hash

array Map of values to set.

getProperties()

getProperties() : array

Returns the object's properties as a map.

Returns

array —

map of properties.