API v1 Reference

List Tenders

This method returns a list of system available payment tender types.

This request is used for retrieving a list of different tender types, such as Credit Card, Check, and Cash. These tender types are configured from within NeonCRM, and can be retrieved for applications that involve recording transactions.

REST

Request

https://api.neoncrm.com/neonws/services/api/common/listTenders?userSessionId=[session id]

Response

{ "listTendersResponse": { 
    "operationResult": "SUCCESS", 
    "responseMessage": "7 records were found.", 
    "responseDateTime": "2012-12-26T01:01:47.647-06:00", 
    "tenders": { 
        "tender": [ 
        { "id": 1, "name": "Cash" }, 
        { "id": 2, "name": "On-Site Credit Card Machine" }, 
        { "id": 3, "name": "Check" }, 
        { "id": 4, "name": "Credit Card(Online)" }, 
        { "id": 5, "name": "In-Kind" }, 
        { "id": 8, "name": "Wire Transfer" },
        { "id": 11, "name": "Chicken" },
        { "id": 12, "name": "E-Check/ACH" } 
        ]
        }
    }
}

SOAP

Request

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:neon="http://www.z2systems.com/schemas/neonws/">
   <soapenv:header>
       <soapenv:body>
          <neon:listtendersrequest>
             <usersessionid>T1357624094982</usersessionid>
          </neon:listtendersrequest>
       </soapenv:body>
    </soapenv:header>
</soapenv:envelope>

Response

<soap:envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:body>
      <ns2:listtendersresponse xmlns:ns2="http://www.z2systems.com/schemas/neonws/">
         <operationresult>SUCCESS</operationresult>
         <responsemessage>11 records were found.</responsemessage>
         <responsedatetime>2013-01-07T23:55:55.073-06:00</responsedatetime>
         <tenders>
            <tender>
               <id>1</id>
               <name>Cash</name>
            </tender>
            <tender>
               <id>2</id>
               <name>On-Site Credit Card Machine</name>
            </tender>
            <tender>
               <id>3</id>
               <name>Check</name>
            </tender>
            <tender>
               <id>4</id>
               <name>Credit Card (Online)</name>
            </tender>
            <tender>
               <id>5</id>
               <name>In-Kind</name>
            </tender>
            <tender>
               <id>6</id>
               <name>Stock/Security</name>
            </tender>
            <tender>
               <id>7</id>
               <name>Art/Antique</name>
            </tender>
            <tender>
               <id>8</id>
               <name>Wire Transfer</name>
            </tender>
            <tender>
               <id>9</id>
               <name>Gift Certificate</name>
            </tender>
            <tender>
               <id>10</id>
               <name>Other</name>
            </tender>
            <tender>
               <id>11</id>
               <name>Paypal</name>
            </tender>
         </tenders>
      </ns2:listtendersresponse>
   </soap:body>
</soap:envelope>

Response Parameters

Name Type Required Description
tender.id Yes Tender type ID
tender.name Yes Common name of tender type