v1

latestOpenAPI 3.0.12026-07-242871595.3 MB

MERCHANTS

Get all tenders for a merchant

Retrieves all tenders for a merchant.

get/v3/merchants/{mId}/tenders

Path parameters

mIdstring required

Merchant identifier.

Query parameters

filterstring

Filter fields to display search results: [modifiedTime, visible, merchantId, instruction, systemTenderId, label, id, labelKey, opensCashDrawer, deletedTime, enabled]

offsetinteger

Position of the first line item returned in the search results. Indicates the number of line items that are excluded from the search results.

limitinteger

Maximum number of line items returned in the search result. Default: 100 Maximum limit: 1000

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Response

Successful response. Displays all tenders for the merchant.

idstring

Unique identifier of the merchant tender.

editableboolean

Indicates whether merchant tender is editable.

labelKeystring

Internal name of the payment tender, for example: label_key value is com.clover.tender.check.

labelstring

Payment tender name that displays to the merchant and customer.

opensCashDrawerboolean

Indicates whether the Open Cash Drawer option is selected for the cash tender. Values: True - When the Open Cash Drawer option is selected, all the cash drawers associated with a device hub or connected printer are opened. False - Open Cash drawer option is not selected.

supportsTippingboolean

Indicates whether tipping is allowed using the selected tender.

enabledboolean

Indicates whether tenders stored at the merchant level or custom merchant tenders are enabled. Note: Merchant can also create custom tenders that are not referenced with the system_tender, such as credit, debit, and cash.

visibleboolean

Indicates whether the merchant tender is visible.

instructionsstring

Instructions for how to process tender.