POS Tenders

Access tender (payment method) configuration from your POS system. Tenders define the types of payments accepted at a location.

Overview

The POS Tender API provides access to tender configurations in your POS system. Tenders represent payment methods such as cash, credit cards, gift cards, and mobile payments.

Tender data is used for:

Payment Processing - Understanding accepted payment types
Payment Reporting - Breaking down sales by payment method
Cash Management - Tracking cash vs. card transactions
Reconciliation - Matching POS data to payment processor records

API Endpoints

Retrieve Tenders

Returns all tender configurations for a specific location.

Method: GET

Endpoint: /pos/v2/{locationId}/tenders

Authentication: Bearer token required

Retrieve all tender (payment method) configurations from the POS system.

Path Parameters

Name	Type	Description
`locationId` *	integer	The unique identifier for the location

Query Parameters

Name	Type	Description
`page`	integer	Page number for pagination (default: 1)
`pageSize`	integer	Number of results per page (default: 50, max: 100)
`active`	boolean	Filter by active/inactive status

Request

GET

/pos/v2/{locationId}/tenders

curl -X GET https://conecto-api.shift4payments.com/pos/v2/12345/tenders \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

{
  "results": [
    {
      "posRef": "TENDER-CASH",
      "name": "Cash",
      "type": "CASH",
      "isActive": true,
      "allowsChange": true,
      "opensDrawer": true,
      "requiresAuthorization": false,
      "locationId": 12345
    },
    {
      "posRef": "TENDER-CC",
      "name": "Credit Card",
      "type": "CARD",
      "isActive": true,
      "allowsChange": false,
      "opensDrawer": false,
      "requiresAuthorization": true,
      "processorType": "SHIFT4",
      "locationId": 12345
    },
    {
      "posRef": "TENDER-GIFT",
      "name": "Gift Card",
      "type": "GIFT_CARD",
      "isActive": true,
      "allowsChange": false,
      "opensDrawer": false,
      "requiresAuthorization": true,
      "locationId": 12345
    },
    {
      "posRef": "TENDER-CHECK",
      "name": "Check",
      "type": "CHECK",
      "isActive": false,
      "allowsChange": false,
      "opensDrawer": true,
      "requiresAuthorization": true,
      "locationId": 12345
    }
  ],
  "meta": {
    "page": 1,
    "pageSize": 50,
    "totalCount": 4
  }
}

Models

Tender

Represents a tender (payment method) configuration in the POS system.

Name
posRef
Type
string
Description
Unique POS system reference ID for the tender
Name
name
Type
string
Description
Display name of the tender
Name
type
Type
string
Description
Tender type: CASH, CARD, GIFT_CARD, CHECK, MOBILE_PAYMENT, OTHER
Name
isActive
Type
boolean
Description
Whether the tender is currently active and can be used
Name
allowsChange
Type
boolean
Description
Whether change can be given with this tender (typically true for cash)
Name
opensDrawer
Type
boolean
Description
Whether using this tender opens the cash drawer
Name
requiresAuthorization
Type
boolean
Description
Whether this tender requires external authorization (e.g., payment processor)
Name
processorType
Type
string
Description
Payment processor type if applicable (e.g., "SHIFT4", "SQUARE", etc.)
Name
displayOrder
Type
integer
Description
Order in which tender should be displayed to staff
Name
requiresManagerApproval
Type
boolean
Description
Whether manager approval is required to use this tender
Name
minimumAmount
Type
number
Description
Minimum transaction amount for this tender
Name
maximumAmount
Type
number
Description
Maximum transaction amount for this tender
Name
locationId
Type
integer
Description
Location ID where the tender is configured
Name
createdAt
Type
datetime
Description
When the tender was created
Name
updatedAt
Type
datetime
Description
When the tender was last updated

Tender Types

CASH

Physical currency payment.

Characteristics:

Allows change to be given
Opens cash drawer
No authorization required
Requires counting and reconciliation

CARD

Credit or debit card payment.

Characteristics:

No change given
Doesn't open cash drawer
Requires authorization from payment processor
May have card type (Visa, Mastercard, etc.)

GIFT_CARD

Store gift card or gift certificate payment.

Characteristics:

No change given (typically)
Doesn't open cash drawer
Requires authorization/balance check
May be store-branded or third-party

CHECK

Paper check payment.

Characteristics:

No change given
May open cash drawer
May require manager approval
Requires verification

MOBILE_PAYMENT

Mobile wallet or contactless payment.

Characteristics:

No change given
Doesn't open cash drawer
Requires authorization
Examples: Apple Pay, Google Pay, Samsung Pay

Use Cases

Payment Processing

Determine which payment methods to accept:

Filter for active tenders only
Display tenders in configured order
Enforce minimum/maximum amounts
Route to appropriate payment processor

Reporting & Analytics

Break down sales by payment method:

Cash vs. card sales
Payment method preferences
Tender-specific fees or costs
Reconciliation by tender type

Cash Management

Track cash flow and drawer operations:

Identify cash tenders
Track drawer opens by tender
Calculate expected cash drawer balance
Monitor change requirements

Best Practices

Name
Active Tenders Only
Description
Only display active tenders to staff and customers. Inactive tenders may exist for historical data but shouldn't be selectable.
Name
Authorization Requirements
Description
Respect the requiresAuthorization flag. Don't allow payments to be processed without proper authorization when required.
Name
Amount Limits
Description
Enforce minimum and maximum amount limits when configured. This helps prevent processing errors and fraud.
Name
Cash Drawer Management
Description
Honor the opensDrawer setting. Don't open drawers for non-cash payments to maintain security and cash control.
Name
Tender Mapping
Description
Maintain mapping between POS tenders and your payment processors. Not all tenders may be processed through the same system.