Introduction
Guides
API Reference
SPI CRM v2
SPI CRM v1
SPI Events
SPI Gift Card
SPI Payment
SPI Product Search
Shipments v3
Purchase Prices v3

POS Payment Types

Get POS Payment Types

get /sites/{siteid}/pospaymenttypes

Returns all payment types available for the POS. The list returned will be sorted by field sortorder in ascending order.

PARAMETERS
siteid
integer
path
REQUIRED

Site ID. (Use eshopid of the site for this parameter)

Returns

Returns an array of POSPaymentType objects.

POSPaymentType
array
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/pospaymenttypes.json
RESPONSE JSON
[
  {
    "paymenttypeid": 1,
    "paymentmethodid": 100,
    "name": "Cash",
    "externalid": "CASH"
  },
  {
    "paymenttypeid": 16,
    "paymentmethodid": 300,
    "name": "External Card",
    "externalid": "EXT_CARD"
  },
  {
    "paymenttypeid": 3,
    "paymentmethodid": 500,
    "name": "Gift Card",
    "externalid": "GIFT_CARD"
  }
]
HTTP Status Code Summary
200Returns an array of POSPaymentType objects.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Objects

POSPaymentMethod
integer

  • 100 Cash
  • 110 Credit Note
  • 200 Card (Verifone AirPay)
  • 210 Card (Verifone LPP)
  • 220 Card (Host2T)
  • 300 Card (External)
  • 400 Custom Method 5
  • 500 Gift Card
  • 510 Credit Note (as gift card)
  • 600 Invoice
  • 610 Cash on Delivery
  • 700 Klarna (legacy v2)
  • 705 Klarna
  • 710 Swish
  • 711 Swish with QR
  • 720 MobilePay (Deprecated from March 2024)
  • 730 Vipps (Deprecated from March 2024)
  • 800 Vipps MobilePay
  • 1000 Custom Method 1
  • 1100 Custom Method 2
  • 1200 Custom Method 3
  • 1300 Custom Method 4
  • 1400 Custom Invoice
  • 2000 Custom Payment API
  • 2100 Card (Adyen SDK)
  • 2110 Card (Adyen Terminal API)
  • 2200 Card (Nets)
  • 2300 Card (Coiney)
  • 2400 Card (iZettle)
  • 3000 Foreign Currency

POSPaymentType
object

Payment type to be used in the POS

PROPERTIES
paymenttypeid
integer
REQUIRED

ID for the payment type in Sitoo.

paymentmethodid
POSPaymentMethod
REQUIRED

Method for the payment type in Sitoo.

name
string
REQUIRED

Display name for the payment type in Sitoo.

externalid
string
nullable
REQUIRED

External ID for the payment type in Sitoo.

Copyright © 2024 Sitoo AB. All rights reserved.