API docs by Redocly

Switcloud API 🚀 (2.28.0)

Download OpenAPI specification:

Prerequisites

To use this API, you must have an active organization, an active admin user, and either a basic user or a machine user. If you don't have an account yet, please contact us at contact@switstack.io.

Roles

  • Admin user: Can manage users, merchants, stores, and POI configurations but cannot create payments.
  • Basic user: Can only manage payments.

Authentication

To make authenticated requests, call /auth/token with your credentials and the appropriate grant type. An access token will be returned, which must be included in the request's Authorization header using the Bearer prefix (Authorization: Bearer <access_token>).

Before Creating a Payment

  1. Log in as an admin user.
  2. Using the BOM sub-API, create a merchant, store, and POI, if applicable.
  3. Using the config sub-API, create a POI configuration, if applicable.

The minimum required POI configuration includes:

  • An EMV.
  • An EMV list containing the previously created EMV.
  • An EMV config using the EMV list as the nominal list.
  • A POI config containing the EMV config.

Creating a Payment

  1. Log in as a basic or machine user.
  2. Create a payment with at least a POI ID and a POI config ID.

Auth

Token

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string (Oauth2GrantType)
Enum: "password" "client_credentials"
Username (string) or Username (null) (Username)
Password (string) or Password (null) (Password)
Client Id (string) or Client Id (null) (Client Id)
Client Secret (string) or Client Secret (null) (Client Secret)

Responses

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwiZXhwIjowfQ.CzKsmenoSSYvhTq_SGoFvnTB-zO3hwjTu98Qo50kqQg",
  • "expires_in": 300,
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwiZXhwIjowfQ.CzKsmenoSSYvhTq_SGoFvnTB-zO3hwjTu98Qo50kqQg",
  • "refresh_expires_in": 1800
}

Refresh Token

Request Body schema: application/x-www-form-urlencoded
required
refresh_token
required
string (Refresh Token) non-empty

Responses

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwiZXhwIjowfQ.CzKsmenoSSYvhTq_SGoFvnTB-zO3hwjTu98Qo50kqQg",
  • "expires_in": 300,
  • "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c2VyQGV4YW1wbGUuY29tIiwiZXhwIjowfQ.CzKsmenoSSYvhTq_SGoFvnTB-zO3hwjTu98Qo50kqQg",
  • "refresh_expires_in": 1800
}

Revoke Token

Request Body schema: application/x-www-form-urlencoded
required
refresh_token
required
string (Refresh Token) non-empty

Responses

Response samples

Content type
application/json
null

BOM

List Merchants

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Merchant

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
required
Name (string) or Name (null) (Name)
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "Merchant name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "Merchant name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Merchant

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "Merchant name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Merchant

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "Merchant name"
}

Response samples

Content type
application/json
{
  • "name": "Merchant name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Merchant

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "Merchant name"
}

Response samples

Content type
application/json
{
  • "name": "Merchant name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Merchant

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Stores

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Store

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
required
Name (string) or Name (null) (Name)
merchant_id
required
string <uuid> (Merchant Id)
Organization Id (string) or Organization Id (null) (Organization Id)
Address (string) or Address (null) (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Response samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Get Store

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Update Store

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
required
Name (string) or Name (null) (Name)
merchant_id
required
string <uuid> (Merchant Id)
Address (string) or Address (null) (Address)

Responses

Request samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Response samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Partial Update Store

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Address (string) or Address (null) (Address)
Name (string) or Name (null) (Name)
Merchant Id (string) or Merchant Id (null) (Merchant Id)

Responses

Request samples

Content type
application/json
{
  • "address": "2 Bd Léon Bureau, 44200 Nantes",
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea"
}

Response samples

Content type
application/json
{
  • "name": "Store name",
  • "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "address": "2 Bd Léon Bureau, 44200 Nantes"
}

Delete Store

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Pois

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
Store Id (string) or Store Id (null) (Store Id)
POIBrandType (string) or Brand (null) (Brand)
POIStateType (string) or State (null) (State)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Poi

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Description (string) or Description (null) (Description)
identifier
required
string (Identifier) [ 1 .. 16 ] characters
serial_number
required
string (Serial Number) [ 1 .. 25 ] characters
brand
string (POIBrandType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "SUNMI" "CASTLES" "PAX" "SAMSUNG" "GOOGLE"
state
string (POIStateType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "PROVISIONED" "OPERATED" "SUSPENDED" "PHASED_OUT"
store_id
required
string <uuid> (Store Id)
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Poi

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Poi

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Description (string) or Description (null) (Description)
identifier
required
string (Identifier) [ 1 .. 16 ] characters
serial_number
required
string (Serial Number) [ 1 .. 25 ] characters
brand
string (POIBrandType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "SUNMI" "CASTLES" "PAX" "SAMSUNG" "GOOGLE"
state
string (POIStateType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "PROVISIONED" "OPERATED" "SUSPENDED" "PHASED_OUT"
store_id
required
string <uuid> (Store Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0"
}

Response samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Poi

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Description (string) or Description (null) (Description)
Identifier (string) or Identifier (null) (Identifier)
Serial Number (string) or Serial Number (null) (Serial Number)
POIBrandType (string) or null
POIStateType (string) or null
Store Id (string) or Store Id (null) (Store Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0"
}

Response samples

Content type
application/json
{
  • "name": "POI name",
  • "description": "POI description",
  • "identifier": "00000003",
  • "serial_number": "SN-DF2948A38DC",
  • "brand": "UNDEFINED",
  • "state": "UNDEFINED",
  • "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Poi

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Config

List Bins

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Bin

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
min_range
required
integer (Min Range)
max_range
required
integer (Max Range)
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999,
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Bin

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Bin

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
min_range
required
integer (Min Range)
max_range
required
integer (Max Range)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999
}

Response samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Bin

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Min Range (integer) or Min Range (null) (Min Range)
Max Range (integer) or Max Range (null) (Max Range)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999
}

Response samples

Content type
application/json
{
  • "name": "BIN name",
  • "min_range": 0,
  • "max_range": 99999999,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Bin

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Bin Lists

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Bin List

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN list name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "BIN list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bins": [
    ]
}

Get Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "BIN list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bins": [
    ]
}

Update Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "BIN list name"
}

Response samples

Content type
application/json
{
  • "name": "BIN list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bins": [
    ]
}

Partial Update Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN list name"
}

Response samples

Content type
application/json
{
  • "name": "BIN list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bins": [
    ]
}

Delete Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add Bin To Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
bin_id
required
string <uuid> (Bin Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Bin From Bin List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
bin_id
required
string <uuid> (Bin Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Bin Configs

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Bin Config

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN config name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "BIN config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_lists": [
    ]
}

Get Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "BIN config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_lists": [
    ]
}

Update Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "BIN config name"
}

Response samples

Content type
application/json
{
  • "name": "BIN config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_lists": [
    ]
}

Partial Update Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "BIN config name"
}

Response samples

Content type
application/json
{
  • "name": "BIN config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_lists": [
    ]
}

Delete Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add Bin List To Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
bin_list_id
required
string <uuid> (Bin List Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Bin List From Bin Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
bin_list_id
required
string <uuid> (Bin List Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Capks

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
CAPKHashType (string) or Hash Type (null) (Hash Type)
CAPKAlgorithmType (string) or Algorithm Type (null) (Algorithm Type)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Capk

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
rid
required
string (Rid) = 10 characters
index
required
string (Index) = 2 characters
hash_type
string (CAPKHashType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "SHA1" "SHA256"
algorithm_type
string (CAPKAlgorithmType)
Default: "RSA"
Value: "RSA"
modulus
required
string (Modulus) [ 1 .. 1024 ] characters
exponent
required
string (Exponent) [ 2 .. 6 ] characters
hash
required
string (Hash) non-empty
Expires At (string) or Expires At (null) (Expires At)
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Capk

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Capk

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
rid
required
string (Rid) = 10 characters
index
required
string (Index) = 2 characters
hash_type
string (CAPKHashType)
Default: "UNDEFINED"
Enum: "UNDEFINED" "SHA1" "SHA256"
algorithm_type
string (CAPKAlgorithmType)
Default: "RSA"
Value: "RSA"
modulus
required
string (Modulus) [ 1 .. 1024 ] characters
exponent
required
string (Exponent) [ 2 .. 6 ] characters
hash
required
string (Hash) non-empty
Expires At (string) or Expires At (null) (Expires At)

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Capk

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Rid (string) or Rid (null) (Rid)
Index (string) or Index (null) (Index)
CAPKHashType (string) or null
CAPKAlgorithmType (string) or null
Modulus (string) or Modulus (null) (Modulus)
Exponent (string) or Exponent (null) (Exponent)
Hash (string) or Hash (null) (Hash)
Expires At (string) or Expires At (null) (Expires At)

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "name": "CAPK name",
  • "rid": "A000000004",
  • "index": "EF",
  • "hash_type": "UNDEFINED",
  • "algorithm_type": "RSA",
  • "modulus": "A191CB87473F29349B5D60A88B3EAEE0973AA6F1A082F358D849FDDFF9C091F899EDA9792CAF09EF28F5D22404B88A2293EEBBC1949C43BEA4D60CFD879A1539544E09E0F09F60F065B2BF2A13ECC705F3D468B9D33AE77AD9D3F19CA40F23DCF5EB7C04DC8F69EBA565B1EBCB4686CD274785530FF6F6E9EE43AA43FDB02CE00DAEC15C7B8FD6A9B394BABA419D3F6DC85E16569BE8E76989688EFEA2DF22FF7D35C043338DEAA982A02B866DE5328519EBBCD6F03CDD686673847F84DB651AB86C28CF1462562C577B853564A290C8556D818531268D25CC98A4CC6A0BDFFFDA2DCCA3A94C998559E307FDDF915006D9A987B07DDAEB3B",
  • "exponent": "03",
  • "hash": "string",
  • "expires_at": "2019-08-24",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Capk

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Capk Lists

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Capk List

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK list name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "CAPK list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "capks": [
    ]
}

Get Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "CAPK list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "capks": [
    ]
}

Update Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK list name"
}

Response samples

Content type
application/json
{
  • "name": "CAPK list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "capks": [
    ]
}

Partial Update Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "CAPK list name"
}

Response samples

Content type
application/json
{
  • "name": "CAPK list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "capks": [
    ]
}

Delete Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add Capk To Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
capk_id
required
string <uuid> (Capk Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Capk From Capk List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
capk_id
required
string <uuid> (Capk Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Crs

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Cr

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
rid
required
string (Rid) = 10 characters
index
required
string (Index) = 2 characters
serial_number
required
string (Serial Number) = 6 characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Cr

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Cr

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
rid
required
string (Rid) = 10 characters
index
required
string (Index) = 2 characters
serial_number
required
string (Serial Number) = 6 characters

Responses

Request samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8"
}

Response samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Cr

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Rid (string) or Rid (null) (Rid)
Index (string) or Index (null) (Index)
Serial Number (string) or Serial Number (null) (Serial Number)

Responses

Request samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8"
}

Response samples

Content type
application/json
{
  • "name": "CR name",
  • "rid": "A000000004",
  • "index": "00",
  • "serial_number": "3F70D8",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Cr

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Cr Lists

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Cr List

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "CR list name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "CR list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "crs": [
    ]
}

Get Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "CR list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "crs": [
    ]
}

Update Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "CR list name"
}

Response samples

Content type
application/json
{
  • "name": "CR list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "crs": [
    ]
}

Partial Update Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "CR list name"
}

Response samples

Content type
application/json
{
  • "name": "CR list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "crs": [
    ]
}

Delete Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add Cr To Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
cr_id
required
string <uuid> (Cr Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Cr From Cr List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
cr_id
required
string <uuid> (Cr Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Emvs

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
EMVTechnologyType (string) or Technology Type (null) (Technology Type)
EMVTransactionType (string) or Transaction Type (null) (Transaction Type)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Emv

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
technology_type
string (EMVTechnologyType)
Default: "CONTACTLESS"
Enum: "CONTACT" "CONTACTLESS"
kernel
required
string (Kernel) [ 1 .. 2 ] characters
aid
required
string (Aid) [ 1 .. 32 ] characters
transaction_type
string (EMVTransactionType)
Default: "00"
Enum: "00" "01" "02" "09" "17" "20" "21" "93"
asf
boolean (Asf)
Default: true
tlv
required
string (Tlv) non-empty
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Get Emv

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Emv

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
technology_type
string (EMVTechnologyType)
Default: "CONTACTLESS"
Enum: "CONTACT" "CONTACTLESS"
kernel
required
string (Kernel) [ 1 .. 2 ] characters
aid
required
string (Aid) [ 1 .. 32 ] characters
transaction_type
string (EMVTransactionType)
Default: "00"
Enum: "00" "01" "02" "09" "17" "20" "21" "93"
asf
boolean (Asf)
Default: true
tlv
required
string (Tlv) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468"
}

Response samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Emv

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
EMVTechnologyType (string) or null
Kernel (string) or Kernel (null) (Kernel)
Aid (string) or Aid (null) (Aid)
EMVTransactionType (string) or null
Asf (boolean) or Asf (null) (Asf)
Tlv (string) or Tlv (null) (Tlv)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "string"
}

Response samples

Content type
application/json
{
  • "name": "EMV name",
  • "technology_type": "CONTACT",
  • "kernel": "0F",
  • "aid": "A0000000041010",
  • "transaction_type": "00",
  • "asf": true,
  • "tlv": "5F20 0F 4D696B65204A6F686E20536D697468",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Delete Emv

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Emv Lists

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Emv List

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV list name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "EMV list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emvs": [
    ]
}

Get Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "EMV list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emvs": [
    ]
}

Update Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "EMV list name"
}

Response samples

Content type
application/json
{
  • "name": "EMV list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emvs": [
    ]
}

Partial Update Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV list name"
}

Response samples

Content type
application/json
{
  • "name": "EMV list name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emvs": [
    ]
}

Delete Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Add Emv To Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
emv_id
required
string <uuid> (Emv Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Remove Emv From Emv List

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
emv_id
required
string <uuid> (Emv Id)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Emv Configs

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Emv Config

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
Organization Id (string) or Organization Id (null) (Organization Id)
emv_nominal_list_id
required
string <uuid> (Emv Nominal List Id)
Emv Failsafe List Id (string) or Emv Failsafe List Id (null) (Emv Failsafe List Id)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV config name",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e"
}

Response samples

Content type
application/json
{
  • "name": "EMV config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_nominal_list": {
    },
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e",
  • "emv_failsafe_list": {
    }
}

Get Emv Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "EMV config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_nominal_list": {
    },
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e",
  • "emv_failsafe_list": {
    }
}

Update Emv Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
emv_nominal_list_id
required
string <uuid> (Emv Nominal List Id)
Emv Failsafe List Id (string) or Emv Failsafe List Id (null) (Emv Failsafe List Id)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV config name",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e"
}

Response samples

Content type
application/json
{
  • "name": "EMV config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_nominal_list": {
    },
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e",
  • "emv_failsafe_list": {
    }
}

Partial Update Emv Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Emv Nominal List Id (string) or Emv Nominal List Id (null) (Emv Nominal List Id)
Emv Failsafe List Id (string) or Emv Failsafe List Id (null) (Emv Failsafe List Id)

Responses

Request samples

Content type
application/json
{
  • "name": "EMV config name",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e"
}

Response samples

Content type
application/json
{
  • "name": "EMV config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "emv_nominal_list_id": "ebc3b103-2d3a-4696-9575-a1a952112081",
  • "emv_nominal_list": {
    },
  • "emv_failsafe_list_id": "21f8fc06-a7c5-4920-ba95-2307819bcc4e",
  • "emv_failsafe_list": {
    }
}

Delete Emv Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

List Poi Configs

Authorizations:
OAuth2PasswordBearer
query Parameters
with_related
boolean (With Related)
Default: false
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Search (string) or Search (null) (Search)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Poi Config

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
emv_config_id
required
string <uuid> (Emv Config Id)
Capk List Id (string) or Capk List Id (null) (Capk List Id)
Cr List Id (string) or Cr List Id (null) (Cr List Id)
Bin Config Id (string) or Bin Config Id (null) (Bin Config Id)
Organization Id (string) or Organization Id (null) (Organization Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI config name",
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Response samples

Content type
application/json
{
  • "name": "POI config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38",
  • "bin_config": {
    },
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "capk_list": {
    },
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "cr_list": {
    },
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "emv_config": {
    }
}

Get Poi Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
with_related
boolean (With Related)
Default: false

Responses

Response samples

Content type
application/json
{
  • "name": "POI config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38",
  • "bin_config": {
    },
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "capk_list": {
    },
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "cr_list": {
    },
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "emv_config": {
    }
}

Update Poi Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
emv_config_id
required
string <uuid> (Emv Config Id)
Capk List Id (string) or Capk List Id (null) (Capk List Id)
Cr List Id (string) or Cr List Id (null) (Cr List Id)
Bin Config Id (string) or Bin Config Id (null) (Bin Config Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI config name",
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38"
}

Response samples

Content type
application/json
{
  • "name": "POI config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38",
  • "bin_config": {
    },
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "capk_list": {
    },
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "cr_list": {
    },
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "emv_config": {
    }
}

Partial Update Poi Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Emv Config Id (string) or Emv Config Id (null) (Emv Config Id)
Capk List Id (string) or Capk List Id (null) (Capk List Id)
Cr List Id (string) or Cr List Id (null) (Cr List Id)
Bin Config Id (string) or Bin Config Id (null) (Bin Config Id)

Responses

Request samples

Content type
application/json
{
  • "name": "POI config name",
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38"
}

Response samples

Content type
application/json
{
  • "name": "POI config name",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "bin_config_id": "99a7488d-be84-46bd-b0be-3ac737df2b38",
  • "bin_config": {
    },
  • "capk_list_id": "6d30cbf6-e66b-41f6-bd05-29f467eba0fb",
  • "capk_list": {
    },
  • "cr_list_id": "7377430e-d2be-45a0-9a6d-8ae04e40e5a8",
  • "cr_list": {
    },
  • "emv_config_id": "e747aa0c-771c-4420-857b-37052f7dc7ce",
  • "emv_config": {
    }
}

Delete Poi Config

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
query Parameters
cascade_delete
boolean (Cascade Delete)
Default: false

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Payment

List Payments

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
Poi Id (string) or Poi Id (null) (Poi Id)
State (string) or State (null) (State)
OutcomeStatus (string) or Outcome Status (null) (Outcome Status)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Create Payment

Authorizations:
OAuth2PasswordBearer
Request Body schema: application/json
required
state
string (State)
Default: "UNDEFINED"
Enum: "UNDEFINED" "CREATED" "READY" "INITIATED" "REQUESTED" "COMPLETED"
outcome_status
string (OutcomeStatus)
Default: "UNDEFINED"
Enum: "UNDEFINED" "APPROVED" "DECLINED" "ONLINE_REQUEST" "END_APPLICATION" "SELECT_NEXT" "TRY_ANOTHER_INTERFACE" "TRY_AGAIN" "NA"
Trd (string) or Trd (null) (Trd)
Authorization (string) or Authorization (null) (Authorization)
Completion (string) or Completion (null) (Completion)
Pin Block (string) or Pin Block (null) (Pin Block)
Organization Id (string) or Organization Id (null) (Organization Id)
poi_id
required
string <uuid> (Poi Id)
poi_config_id
required
string <uuid> (Poi Config Id)

Responses

Request samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "poi_id": "cb6aca35-5292-4775-913b-4f5b5cbfe5e2",
  • "poi_config_id": "109dc1f4-8af1-4faa-8946-d2f071c74ebd"
}

Response samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "poi_id": "cb6aca35-5292-4775-913b-4f5b5cbfe5e2",
  • "poi_config_id": "109dc1f4-8af1-4faa-8946-d2f071c74ebd",
  • "log_data_set_id": "7fc8f7f7-ebae-4093-8cc6-5a59c5a81e60"
}

Get Payment

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "poi_id": "cb6aca35-5292-4775-913b-4f5b5cbfe5e2",
  • "poi_config_id": "109dc1f4-8af1-4faa-8946-d2f071c74ebd",
  • "log_data_set_id": "7fc8f7f7-ebae-4093-8cc6-5a59c5a81e60"
}

Update Payment

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
state
string (State)
Default: "UNDEFINED"
Enum: "UNDEFINED" "CREATED" "READY" "INITIATED" "REQUESTED" "COMPLETED"
outcome_status
string (OutcomeStatus)
Default: "UNDEFINED"
Enum: "UNDEFINED" "APPROVED" "DECLINED" "ONLINE_REQUEST" "END_APPLICATION" "SELECT_NEXT" "TRY_ANOTHER_INTERFACE" "TRY_AGAIN" "NA"
Trd (string) or Trd (null) (Trd)
Authorization (string) or Authorization (null) (Authorization)
Completion (string) or Completion (null) (Completion)
Pin Block (string) or Pin Block (null) (Pin Block)

Responses

Request samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string"
}

Response samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "poi_id": "cb6aca35-5292-4775-913b-4f5b5cbfe5e2",
  • "poi_config_id": "109dc1f4-8af1-4faa-8946-d2f071c74ebd",
  • "log_data_set_id": "7fc8f7f7-ebae-4093-8cc6-5a59c5a81e60"
}

Partial Update Payment

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
State (string) or null
OutcomeStatus (string) or null
Trd (string) or Trd (null) (Trd)
Authorization (string) or Authorization (null) (Authorization)
Completion (string) or Completion (null) (Completion)
Pin Block (string) or Pin Block (null) (Pin Block)

Responses

Request samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string"
}

Response samples

Content type
application/json
{
  • "state": "UNDEFINED",
  • "outcome_status": "UNDEFINED",
  • "trd": "9F02060000000015009F7C1411223344556677889900112233445566778899009F5301465F2A0209785F3601029A032505069C01009F2103105929",
  • "authorization": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "completion": "DF81290840F0F00098F0FF00FF81060ADF81150600030000001CDF81160D1C00000013656E646566720000E721DFA0090A00000000000000000000DFA028050402000000DFA02006000000030000",
  • "pin_block": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  • "poi_id": "cb6aca35-5292-4775-913b-4f5b5cbfe5e2",
  • "poi_config_id": "109dc1f4-8af1-4faa-8946-d2f071c74ebd",
  • "log_data_set_id": "7fc8f7f7-ebae-4093-8cc6-5a59c5a81e60"
}

List Log Data Sets

Authorizations:
OAuth2PasswordBearer
query Parameters
Organization Id (string) or Organization Id (null) (Organization Id)
Order By (string) or Order By (null) (Order By)
page
integer (Page) >= 1
Default: 1

Page number

size
integer (Size) [ 1 .. 200 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "page": 1,
  • "size": 1,
  • "pages": 0
}

Get Log Data Set

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)

Responses

Response samples

Content type
application/json
{
  • "meta_data": "string",
  • "telemetry": "string",
  • "config": "string",
  • "trd": "string",
  • "all_tags": "string",
  • "apdus": "string",
  • "trace": "string",
  • "signals": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Update Log Data Set

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Meta Data (string) or Meta Data (null) (Meta Data)
Telemetry (string) or Telemetry (null) (Telemetry)
Config (string) or Config (null) (Config)
Trd (string) or Trd (null) (Trd)
All Tags (string) or All Tags (null) (All Tags)
Apdus (string) or Apdus (null) (Apdus)
Trace (string) or Trace (null) (Trace)
Signals (string) or Signals (null) (Signals)

Responses

Request samples

Content type
application/json
{
  • "meta_data": "string",
  • "telemetry": "string",
  • "config": "string",
  • "trd": "string",
  • "all_tags": "string",
  • "apdus": "string",
  • "trace": "string",
  • "signals": "string"
}

Response samples

Content type
application/json
{
  • "meta_data": "string",
  • "telemetry": "string",
  • "config": "string",
  • "trd": "string",
  • "all_tags": "string",
  • "apdus": "string",
  • "trace": "string",
  • "signals": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}

Partial Update Log Data Set

Authorizations:
OAuth2PasswordBearer
path Parameters
id
required
string <uuid> (Id)
Request Body schema: application/json
required
Meta Data (string) or Meta Data (null) (Meta Data)
Telemetry (string) or Telemetry (null) (Telemetry)
Config (string) or Config (null) (Config)
Trd (string) or Trd (null) (Trd)
All Tags (string) or All Tags (null) (All Tags)
Apdus (string) or Apdus (null) (Apdus)
Trace (string) or Trace (null) (Trace)
Signals (string) or Signals (null) (Signals)

Responses

Request samples

Content type
application/json
{
  • "meta_data": "string",
  • "telemetry": "string",
  • "config": "string",
  • "trd": "string",
  • "all_tags": "string",
  • "apdus": "string",
  • "trace": "string",
  • "signals": "string"
}

Response samples

Content type
application/json
{
  • "meta_data": "string",
  • "telemetry": "string",
  • "config": "string",
  • "trd": "string",
  • "all_tags": "string",
  • "apdus": "string",
  • "trace": "string",
  • "signals": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6"
}