Simplify Node.js API Docs

API Docs for:
Show:

TransactionReview Class

Defined in: simplify.js:2441

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

Constructor

TransactionReview

(
  • appKeys
)

Defined in simplify.js:2441

Parameters:

  • appKeys Object

    Object containing the public & private API keys

Item Index

Methods

Methods

create

(
  • params
  • callback
)

Defined in simplify.js:2467

Function to create a TransactionReview object.

Parameters:

  • params Object

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

    Valid parameters include:


      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:2492

    Function to delete a TransactionReview object.

    Parameters:

    • A Object

      string ID of the TransactionReview 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:2534

    Function to retrieve a TransactionReview object from the API.

    Parameters:

    • id String

      The ID of the TransactionReview 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:2509

    Function to retrieve a list TransactionReview objects.

    Parameters:

    • params Object

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

      Valid parameters include:


        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.

      update

      (
      • params
      • callback
      )

      Defined in simplify.js:2551

      Function to update a TransactionReview object.

      Parameters:

      • params Object

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

        Valid parameters include:

        • id : A string ID of the TransactionReview object to update

        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.