Payment Options

GET /locations/:locationId/payment-options

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/payment-options

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//payment-options' \
--header 'x-api-key;'

Retrieves all payment options for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a JSON array of payment option objects. Each object in the array will be structured as follows:

Field Name	Field Type	Field Description	Org Level Attribute*
id	string	The unique ID for the payment option.	Yes
locationId	string	The unique ID for the location.
name	string	The name of the payment option.	Yes
deleted	boolean	True if the payment option has been marked as deleted.	Yes
enabled	boolean	True if the payment option is enabled at the location.
kind	string	One of the following constants: "CASH" for cash "CC" for credit card "OTHER" for everthing else, which includes "unkown" payment options Only those payment options that are collected directly by the POS as credit cards will be classified as "CC". Payment options for services such as "Grub Hub", "Door Dash", "Level Up", etc. will be classified as "OTHER" since the POS does not directly collect such payments.

📘
*Note that the values of fields marked as "Org Level Attribute" are shared amongst all locations that reside in the same POS organization.

Example Response

[
     {
        "id": "luwdxmgy0bb5tbhtezv23ulppe",
        "locationId": "LocationX",
        "name": "Online Card Connect",
        "deleted": false,
        "enabled": false,
        "kind": "CC"
    }
]

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location

GET /locations/:locationId/payment-options/:paymentOptionId

https://restaurantapi-qa.spoton.com/posexport/v1/locations/:locationId/payment-options/:paymentOptionId

curl --location --request GET 'https://restaurantapi-qa.spoton.com/posexport/v1/locations//payment-options/' \
--header 'x-api-key;'

Retrieves a single payment option for the supplied location.

Response Payload Structure

The response body for a "200 OK" response will contain a single JSON payment option object. See the parent route's documentation for more details.

Headers
x-api-key	Your API Key

Path Variables
locationId	The unique ID for the location
paymentOptionId	The unique ID for the payment option