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

POS Payment Types

Add POS Payment Type

post /sites/{site_id}/pospaymenttypes.json

Add a payment type for the POS.

PARAMETERS
site_id
integer
path
REQUIRED

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

REQUEST BODY
object
REQUIRED

A POS payment type.

PosPaymentType
posthttps://api.mysitoo.com/v2/accounts/1500/sites/1/pospaymenttypes.json
{
  "paymentmethodid": 500,
  "name": "Gift Card",
  "externalid": "GIFT_CARD"
}
RESPONSE JSON
3
HTTP Status Code Summary
200Successful. Returns ID of the added POS payment type.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Get POS Payment Types

get /sites/{site_id}/pospaymenttypes.json

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

PARAMETERS
fields
array (string)
query

Comma separated list of fields to return. Use this to query only the fields you are using. See PosPaymentType object for all fields.

site_id
integer
path
REQUIRED

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

Returns

Successful. Returns 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",
    "sortorder": 0,
    "externalid": "CASH"
  },
  {
    "paymenttypeid": 2,
    "paymentmethodid": 300,
    "name": "External Card",
    "sortorder": 1
  },
  {
    "paymenttypeid": 3,
    "paymentmethodid": 500,
    "name": "Gift Card",
    "sortorder": 2,
    "externalid": "GIFT_CARD"
  }
]
HTTP Status Code Summary
200Successful. Returns 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.

Get POS Payment Type

get /sites/{site_id}/pospaymenttypes/{pos_payment_type_id}.json

Returns the POS payment type for the provided ID.

PARAMETERS
site_id
integer
path
REQUIRED

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

pos_payment_type_id
integer
path
REQUIRED

POS Payment Type ID.

Returns

Successful. Returns the POS payment type for the provided ID.

PosPaymentType
gethttps://api.mysitoo.com/v2/accounts/1500/sites/1/pospaymenttypes/1.json
RESPONSE JSON
{
  "paymenttypeid": 1,
  "paymentmethodid": 100,
  "name": "Cash",
  "sortorder": 0,
  "externalid": "CASH"
}
HTTP Status Code Summary
200Successful. Returns the POS payment type for the provided ID.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Update POS Payment Type

put /sites/{site_id}/pospaymenttypes/{pos_payment_type_id}.json

Updates the POS payment type for the provided ID.

PARAMETERS
site_id
integer
path
REQUIRED

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

pos_payment_type_id
integer
path
REQUIRED

POS Payment Type ID.

REQUEST BODY
object
REQUIRED

A POS payment type.

PosPaymentType
puthttps://api.mysitoo.com/v2/accounts/1500/sites/1/pospaymenttypes/2.json
{
  "externalid": "EXT_CARD"
}
RESPONSE JSON
true
HTTP Status Code Summary
200Successful. Returns true.
400Invalid request. Data sent from client is invalid.
401Missing or bad authentication.
404The specified resource was not found.
429Too Many Requests.
500Internal Server Error.

Delete POS Payment Type

delete /sites/{site_id}/pospaymenttypes/{pos_payment_type_id}.json

Deletes the POS payment type for the provided ID.

PARAMETERS
site_id
integer
path
REQUIRED

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

pos_payment_type_id
integer
path
REQUIRED

POS Payment Type ID.

deletehttps://api.mysitoo.com/v2/accounts/1500/sites/1/pospaymenttypes/2.json
RESPONSE JSON
true
HTTP Status Code Summary
200Successful. Returns true.
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 (Deprecated. Use 510 for credit notes)
  • 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 (Deprecated - 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)
  • 2120 Card (Adyen Tap to Pay)
  • 2200 Card (Nets)
  • 2300 Card (Coiney)
  • 2400 Card (iZettle)
  • 3000 Foreign Currency Cash

PosPaymentType
object

Payment type to be used in the POS

PROPERTIES
paymenttypeid
integer
READ ONLY

ID for the payment type in Sitoo.

paymentmethodid
PosPaymentMethod
REQUIRED

Method for the payment type in Sitoo. It is not allowed to change the method of an existing payment type.

name
string
REQUIRED

Display name for the payment type in Sitoo. The name must be unique among payment types for a site.

Min Length: 1
externalid
string
nullable

External ID for the payment type in Sitoo.

sortorder
integer

Zero-based index for this payment type, used for sorting. Setting the value to the same value as an already existing payment type will push the existing one down in order together with all the ones after. Setting the value to 0 will place it first. Excluding the value in a POST will place it last. The property is not required in a PUT.

Copyright © 2024 Sitoo AB. All rights reserved.