Simplify Node.js API Docs

API Docs for:
Show:

CardToken Class

Defined in: simplify.js:432

This is a Simplify domain object. In order to get access to a domain object, a client needs to be created. The client is then used to invoke the different methods e.g.

var client = Simplify.getClient({
                            publicKey: 'YOUR_PUBLIC_API_KEY',
                            privateKey: 'YOUR_PRIVATE_API_KEY'
                        });
                        
                        client.cardtoken.METHOD_NAME(params, function(error, data){
                            if(error){
                                // handle the error
                            }
                        
                            // Awesome...no error, handle the data
                        });

Constructor

CardToken

(
  • appKeys
)

Defined in simplify.js:432

Parameters:

  • appKeys Object

    Object containing the public & private API keys

Item Index

Methods

Methods

create

(
  • params
  • callback
)

Defined in simplify.js:458

Function to create a CardToken object.

Parameters:

  • params Object

    A map of parameters in which to create the CardToken from.

    Valid parameters include:

    • 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]

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                    param: {
                                                    subParam1: 'value', 
                                                    subParam2: 'value'
                                                }
                                            }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

find

(
  • id
  • callback
)

Defined in simplify.js:503

Function to retrieve a CardToken object from the API.

Parameters:

  • id String

    The ID of the CardToken to retrieve

  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.

update

(
  • params
  • callback
)

Defined in simplify.js:520

Function to update a CardToken object.

Parameters:

  • params Object

    A map of parameters on which to update the CardToken object.

    Valid parameters include:

    • id : A string ID of the CardToken object to update
    • 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

    NOTE: Any parameters with a sub-parameter (e.g. param.subParam) need to be nested when passed as an argument in e.g.

    {
                                                    param: {
                                                    subParam1: 'value', 
                                                    subParam2: 'value'
                                                }
                                            }
  • callback Function

    A function to handle success/error responses from the API.
    The function takes 2 parameters, the first is an error object. This is null if no error occurs. The second parameter is the response data. This is null if an error occurs.