SendSession

  • Method

    SlimCD.Sessions.SendSession

    Purpose

    Sends a link via email or sms-text that allows the session to be displayed/filled on a remote PC.

    Description

    SendSession is used to send a session URL via Email or SMS text message. The recipient can then follow this link on their PC or Mobile device to the previously created hosted payment page where they can enter their payment information and complete the transaction.

    Business Rules

    Link to something

    Request Fields

    FieldName
    Type
    Length
    Required
    Description
    UserName
    string
    20
    required
    Username or API Access Credential that accesses web service.
    Password
    string
    20
    required
    Plaintext password for the client account.
    SiteID
    integer
    10
    optional
    Assigned by the Slim CD administrator.
    BatchNumber
    string
    12
    no
    The processor’s batch number. Do not use unless instructed by SLIM CD.

    1 Passwords are required except when the username is set to an API Access Credential, in which case it should be passed in as an empty string.

    2 If an API Access Credential is only authorized for a single sites, passing in the default siteid value of zero will close the currently open batch for that single site.

    3 If the API Access Credential is authorized for multiple sites, the SiteID must be specified to indicate which batch to close.

    3 If the username is set to a clientid or username other than an API Access Credential, you must specify a non-zero siteidto indicate which batch to close.

    5 The batchnumber should always be passed as an empty string to close the open batch. Specifying a batch number will re-close an existing batch and may result in duplicate charges.

    Reply Fields

    reply
    outer tag for the reply data block
    response
    Success, FAIL, Error
    response code
    0, 1, 2 (respective) matching the above
    reponseurl
    The Slimcd.com url which was called for this operation
    description
    If successful, this will contain the single word, OK. Otherwise it will contain a description of failure or error which occurred
    datablock
    The confirmation text returned from the server.

     

    Reply Hierarchy

    • reply
      • response
      • responsecode
      • description
      • responseurl
      • datablock

    Remarks

    • SendSession Input Values identify the session and authenticate access to the session information.

    Example

        Sample HTTP GET:

        Sample HTTP POST:

     

  • Include

     Method

    request

     Reply

     Sample Code

     Downloads

    Download full sample source.

     

     

  • Include

  • Include
    Download full sample source.


  • Include

    Download full sample source.


  • Include

    Method

    request

    Reply

    Sample Code


  • Method

    request

    Reply

    Sample Code

    Downloads

    Download full sample source.

  • URL 

    Protocols

    • SOAP/XML
    • HTTP POST
    • HTTP GET

    Request 


    The sample above shows the name/value pairs that would be send with HTTP POST

    Status Codes

    Status Code Status Description Explanation
    200 200 OK Approved or declined attempts will return a response with an XML reply block
    500 500 Internal Server Error The response will not contain XML, as a server error has occurred.

    Reply Output is in XML format if a status code of 200 is returned.

    If the block’s tag does not indicate “Success”, the tag will contain an error description which can be displayed to the end-user

    Sample Code


    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    DOWNLOAD

    EXERCISER TOOL

    Remarks

    • Remarks Go here
  • URL

    Protocols

    • HTTP POST
    • HTTP GET

    This function accepts either name/value pairs or JSON

    Request

    Reply

    Sample Code


    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    The sample above shows the use jQuery cross-domain POST with jsonp, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another json data item

    The sample above shows the use jQuery cross-domain POST with name/value pairs, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another name/value pair

    Remarks

    1. None