GetTenders

Retrieve the Tenders (payment methods) for this location.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 3 — Server Unavailable
- 4 — Access Denied
Tenders Array of Tender — Array of Tender objects for this location.
Tender Properties
- Active bool — True if this Tender is active, False if inactive
- AllowChange bool — True if change can be given for this Tender, False if not
- AllowTips bool — True if tips can be applied to this Tender, False if not
- CardType CardType — Returns one of the following:
  - None
  - MasterCard
  - Visa
  - American Express
  - Diners Club
  - Discover
  - enRoute
  - JCB
  - Private
  - CashBenefit
  - FoodBenefit
- DefaultAmount decimal — Default amount for this Tender, 0 if not set
- Id int — Unique Id of this Tender
- MaximumAccountDigits sbyte — Maximum number of account digits required for this Tender
- MaxTipPercent decimal — Maximum tip percentage allowed for this Tender
- MinimumAccountDigits sbyte — Minimum number of account digits required for this Tender
- Name string — Name of this Tender
- OpenDrawer bool — True if the cash drawer opens when this Tender is used, False if not
- ReconciliationMethod ReconciliationMethod — Returns one of the following:
  - Details — Reconcile by individual transaction details
  - Totals — Reconcile by totals only
- RequiresAuthorization bool — True if this Tender requires authorization, False if not
- SignatureCapture bool — True if this Tender requires signature capture, False if not
- TenderType TenderType — Returns one of the following:
  - None
  - Cash
  - CreditCard
  - GiftCard
  - GiftCertificate
  - Check
  - HouseAccount
  - External
  - Debit
  - EBT
- VarianceAmount decimal — Allowed variance amount for reconciliation of this Tender

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetTenders request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetTenders

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetTenders' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetTenders"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetTenders>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetTenders>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetTendersResponse xmlns="http://tempuri.org/">
      <Settings_GetTendersResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Tenders>
          <Tender>
            <Active>true</Active>
            <AllowChange>true</AllowChange>
            <AllowTips>false</AllowTips>
            <CardType>0</CardType>
            <DefaultAmount>0</DefaultAmount>
            <Id>1</Id>
            <MaximumAccountDigits>0</MaximumAccountDigits>
            <MaxTipPercent>25</MaxTipPercent>
            <MinimumAccountDigits>0</MinimumAccountDigits>
            <Name>Cash</Name>
            <OpenDrawer>true</OpenDrawer>
            <ReconciliationMethod>0</ReconciliationMethod>
            <RequiresAuthorization>false</RequiresAuthorization>
            <SignatureCapture>false</SignatureCapture>
            <TenderType>0</TenderType>
            <VarianceAmount>0</VarianceAmount>
          </Tender>
        </Tenders>
      </Settings_GetTendersResult>
    </Settings_GetTendersResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Tender objects.