com.simplify.payments.domain

Class CardToken

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.CardToken

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class CardToken
extends PaymentsObject

A CardToken object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CardToken()
protected	CardToken(java.util.Map m)
protected	CardToken(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static CardToken	create(Authentication auth, java.util.Map map) Creates an CardToken object
static CardToken	create(java.util.Map map) Creates an CardToken object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static CardToken	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
static CardToken	find(Authentication auth, java.lang.String id) Retrieve a CardToken object.
static CardToken	find(java.lang.String id) Retrieve a CardToken object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static CardToken	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
CardToken	update() Updates an CardToken object.

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

CardToken

protected CardToken()

CardToken

protected CardToken(PaymentsObject o)

CardToken

protected CardToken(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static CardToken create(java.util.Map map)
                        throws ApiCommunicationException,
                               AuthenticationException,
                               InvalidRequestException,
                               NotAllowedException,
                               SystemException

Creates an CardToken object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

java.lang.Boolean authenticatePayer

Set as true to create CardToken for EMV 3DS transaction. [default: false]

java.lang.String callback

The URL callback for the cardtoken

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to. required

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String key

Key used to create the card token.

payments.command.api.APISecure3DRequestCommand secure3DRequestData

3D Secure data structure for checking card enrolment.

java.lang.Long secure3DRequestData.amount

Amount of the subsequent transaction in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.Boolean 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.

java.lang.String secure3DRequestData.currency

Currency code (ISO-4217). Must match the currency associated with your account. required

java.lang.String secure3DRequestData.description

A description of the transaction. [max length: 256]

java.lang.String secure3DRequestData.id

3D Secure data ID.

java.lang.String source

Card Token Source [default: API]

Returns:

a CardToken object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static CardToken create(java.lang.String publicKey,
                                           java.lang.String privateKey,
                                           java.util.Map map)
                                    throws ApiCommunicationException,
                                           AuthenticationException,
                                           InvalidRequestException,
                                           NotAllowedException,
                                           SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an CardToken object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Boolean authenticatePayer

Set as true to create CardToken for EMV 3DS transaction. [default: false]

java.lang.String callback

The URL callback for the cardtoken

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to. required

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String key

Key used to create the card token.

payments.command.api.APISecure3DRequestCommand secure3DRequestData

3D Secure data structure for checking card enrolment.

java.lang.Long secure3DRequestData.amount

Amount of the subsequent transaction in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.Boolean 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.

java.lang.String secure3DRequestData.currency

Currency code (ISO-4217). Must match the currency associated with your account. required

java.lang.String secure3DRequestData.description

A description of the transaction. [max length: 256]

java.lang.String secure3DRequestData.id

3D Secure data ID.

java.lang.String source

Card Token Source [default: API]

Returns:

a CardToken object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static CardToken create(Authentication auth,
                               java.util.Map map)
                        throws ApiCommunicationException,
                               AuthenticationException,
                               InvalidRequestException,
                               NotAllowedException,
                               SystemException

Creates an CardToken object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

java.lang.Boolean authenticatePayer

Set as true to create CardToken for EMV 3DS transaction. [default: false]

java.lang.String callback

The URL callback for the cardtoken

payments.command.api.APICardCommand card

Credit or debit card being used to apply the payment to. required

java.lang.String card.addressCity

City of the cardholder. [max length: 50, min length: 2]

java.lang.String card.addressCountry

Country code (ISO-3166-1-alpha-2 code) of residence of the cardholder. [max length: 2, min length: 2]

java.lang.String card.addressLine1

Address of the cardholder. [max length: 255]

java.lang.String card.addressLine2

Address of the cardholder if needed. [max length: 255]

java.lang.String card.addressState

State of residence of the cardholder. State abbreviations should be used. [max length: 255]

java.lang.String 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]

java.lang.String card.cvc

CVC security code of the card. This is the code on the back of the card. Example: 123

java.lang.Integer card.expMonth

Expiration month of the card. Format is MM. Example: January = 01 [min value: 1, max value: 12]

java.lang.Integer card.expYear

Expiration year of the card. Format is YY. Example: 2013 = 13 [min value: 0, max value: 99]

java.lang.String card.name

Name as appears on the card. [max length: 50, min length: 2]

java.lang.String card.number

Card number as it appears on the card. [max length: 19, min length: 13]

java.lang.String key

Key used to create the card token.

payments.command.api.APISecure3DRequestCommand secure3DRequestData

3D Secure data structure for checking card enrolment.

java.lang.Long secure3DRequestData.amount

Amount of the subsequent transaction in the smallest unit of your currency. Example: 100 = $1.00 required

java.lang.Boolean 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.

java.lang.String secure3DRequestData.currency

Currency code (ISO-4217). Must match the currency associated with your account. required

java.lang.String secure3DRequestData.description

A description of the transaction. [max length: 256]

java.lang.String secure3DRequestData.id

3D Secure data ID.

java.lang.String source

Card Token Source [default: API]

Returns:

a CardToken object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

find

public static CardToken find(java.lang.String id)
                      throws ApiCommunicationException,
                             AuthenticationException,
                             InvalidRequestException,
                             ObjectNotFoundException,
                             NotAllowedException,
                             SystemException

Retrieve a CardToken object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the CardToken object to retrieve

Returns:

a CardToken object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static CardToken find(java.lang.String publicKey,
                                         java.lang.String privateKey,
                                         java.lang.String id)
                                  throws ApiCommunicationException,
                                         AuthenticationException,
                                         InvalidRequestException,
                                         ObjectNotFoundException,
                                         NotAllowedException,
                                         SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a CardToken object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the CardToken object to retrieve

Returns:

a CardToken object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static CardToken find(Authentication auth,
                             java.lang.String id)
                      throws ApiCommunicationException,
                             AuthenticationException,
                             InvalidRequestException,
                             ObjectNotFoundException,
                             NotAllowedException,
                             SystemException

Retrieve a CardToken object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the CardToken object to retrieve

Returns:

a CardToken object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public CardToken update()
                 throws ApiCommunicationException,
                        AuthenticationException,
                        InvalidRequestException,
                        ObjectNotFoundException,
                        NotAllowedException,
                        SystemException

Updates an CardToken object. The properties that can be updated:

• device (required)
• browser (required)
• ipAddress (required)
• language
• screenHeight
• screenWidth
• timeZone (required)
• key

Returns:

a CardToken object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException