Simplify Node.js API Docs

API Docs for:
Show:

Authorization Class

Defined in: simplify.js:236

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.authorization.METHOD_NAME(params, function(error, data){
                            if(error){
                                // handle the error
                            }
                        
                            // Awesome...no error, handle the data
                        });
                        

Constructor

Authorization

(
  • appKeys
)

Defined in simplify.js:236

Parameters:

  • appKeys Object

    Object containing the public & private API keys

Item Index

Methods

create

(
  • params
  • callback
)

Defined in simplify.js:262

Function to create a Authorization object.

Parameters:

  • params Object

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

    Valid parameters include:

    • amount : Amount of the payment (in the smallest unit of your currency). Example: 100 = $1.00 (REQUIRED)
    • 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 characters in length and only contains 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]
    • 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, and if one is found we 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.
    • token : If specified, card associated with card token will be used. [max length: 255]

    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.

delete

(
  • A
  • callback
)

Defined in simplify.js:340

Function to delete a Authorization object.

Parameters:

  • A Object

    string ID of the Authorization to delete.

  • 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:386

Function to retrieve a Authorization object from the API.

Parameters:

  • id String

    The ID of the Authorization 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.

list

(
  • params
  • callback
)

Defined in simplify.js:357

Function to retrieve a list Authorization objects.

Parameters:

  • params Object

    A map of parameters in which to define the Authorization list from.

    Valid parameters include:

    • filter :
      filter.idFilter by the Authorization Id
      filter.replayIdFilter by the compoundReplayId
      filter.last4Filter by the card number (last 4 digits)
      filter.amountFilter by the transaction amount (in the smallest unit of your currency)
      filter.textFilter by the description of the authorization
      filter.amountMin & filter.amountMaxThe filter amountMin must be used with amountMax to find authorizations with authorization values between the min and max
      filter.dateCreatedMinFilter by the minimum created date you are searching for - Date in UTC millis
      filter.dateCreatedMaxFilter by the maximum created date you are searching for - Date in UTC millis
      filter.depositFilter by the deposit id
      filter.customerFilter using the Id of the customer to find the authorizations for that customer
      filter.statusFilter by the authorization status text
      filter.authCodeFilter by the authorization code (Not the authorization ID)
      filter.qYou can use this to filter by the ID, the authCode or the amount of the authorization

      *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 pagination 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
      • amount
      • id
      • description
      • paymentDate

    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.