get
https://sandbox-api.softpoint.io/interface/v1/locations/YOUR_LOCATION_ID/tenders
Returns a paginated list of the tender (payment) types configured for a location, including whether each allows tips.
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer YOUR_ACCESS_TOKEN |
Request Parameters
Path Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| location_id | integer | Yes | Location whose tenders are listed. |
Query Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
| status | integer | No | Filter by status (1 = active). |
| user_id | integer | Yes | The acting user. |
| limit | integer | No | Page size. |
| paginate | string | No | Pagination mode. |
| page | integer | No | Page number. |
| global_on_id | integer | No | Originating channel identifier. |
cURL Example
curl --request GET \
--url "https://sandbox-api.softpoint.io/interface/v1/locations/3000324/tenders?status=1&user_id=1&limit=10&paginate=data&page=1&global_on_id=2" \
--header "Authorization: Bearer YOUR_ACCESS_TOKEN"
Success Response
A HAL-style envelope; tenders are under _embedded.tenders (abridged here).
{
"_links": { "self": { "href": ".../tenders?page=1" } },
"_embedded": {
"tenders": [
{
"id": 2820,
"status": 1,
"location_id": 3000324,
"name": "American Express",
"allows_tips": 1,
"pos_payments": 0,
"_embedded": { "global_type": { "id": 1, "name": "American Express", "code_id": 1, "status": 1 } }
},
{
"id": 2824,
"status": 1,
"location_id": 3000324,
"name": "Visa",
"allows_tips": 1,
"_embedded": { "global_type": { "id": 10, "name": "Visa", "code_id": 1, "status": 1 } }
}
]
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
| _links | object | HAL pagination links. |
| _embedded.tenders | array | Tender records. |
| tenders[].id | integer | Tender ID. |
| tenders[].status | integer | Status. |
| tenders[].location_id | integer | Owning location. |
| tenders[].name | string | Tender name. |
| tenders[].allows_tips | integer | 1 if tips are permitted on this tender. |
| tenders[].pos_payments | integer | Whether the tender is used for POS payments. |
| tenders[]._embedded.global_type | object | The global tender type this maps to. |
Status Codes
| Code | Description |
|---|---|
| 200 | Tenders returned |
| 401 | Token missing or invalid |
Workflow Placement
A reference read used to determine accepted payment methods at a location.
Notes
allows_tipsindicates whether tip addition is valid for the tender.
Common Mistakes
- Looking for results under
datainstead of_embedded.tenders.