CloseBatch

  • Method

    SlimCD.Transact.CloseBatch

    Purpose

    Closes the current batch of transactions on SLIM CD’s servers by releasing them to the processor.

    Description

    Transactions processed through SLIM CD are stored in batches. These transactions will not be funded to the merchant until the batch is closed. After closing a batch you can no longer perform VOID, TIPEDIT, or UPDATE transactions against a previous transaction included in the batch.

    Business Rules

    Link to something

    Argument List

    Name Required Usage
    CloseBatchRequest Required Object containing properties for the request
    timeout Optional Integer wait time, in seconds, before timeout response is generated
    callback* Optional Function to call upon completion of asynchronous request

    *for JavaScript only

    CloseBatchRequest Fields

    Field Name Type Length Required Description
    Username string 20 require 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 not required 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.

    Reply Fields

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

    Reply Hierarchy

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

    Remarks

    • General
      1. Names in name/value pairs are NOT case-sensitive
      2. Names inside XML tags ARE case-sensitive
    • Function-Specific
      1. None
  • Include

    Method

    Request

    Reply

    Sample Code

    Downloads

    Download full sample source.


     

  • Include

    Method

    Request

    JSON Reply

    Sample Code

    Downloads

    Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference: Client

    Sample Code

    Downloads

    Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference: Client

    Sample Code

    Downloads

    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

    • For .NET programmers, this is a discoverable web serivce using Visual Studio
    • This routine can take a long time. Please set your HTTP connection’s timeout appropriately (600 seconds)
    • SiteID is defined as an “int” and must contain a numeric (non-blank) value
    • BatchNumber is defined as a “string” and can/should be blank
    • Only SLIM CD’s support will use a value for the batch number, so you should hardcode this to blank
  • 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. The jsonpayment.asp entry point returns a standard datablock on approved, declined, and errors for credit card transactions, making it easier to parse for class libraries.
    2. The jsonscript.asp entry point can also be called with service=ProcessTransaction (or PostXML or PostHTTP), but the datablock may not contain all elements on decline or error responses
    3. Check and gift card transactions may return different elements in the datablock than credit card transactions