API docs by Redocly

CustomerApi (1.0.0)

Download OpenAPI specification:

E-mail: api@oktopos.com

The OktoPOS Manager CustomerAPI provides a way to manage customer data and associated debit accounts. -- Authentication All functions in this API require a valid authentication token. You can find this token in your instance of OktoPOS Manager in OktoPOS -> System.

customers

Add a new customer.

Authorizations:
api_key
Request Body schema: */*
required
id
integer

null on creation

required
object (Person)
required
Array of objects (CustomerGroup) non-empty
externalIdentifier
string
Array of objects (CustomerCard)
Array of objects (CustomerComment)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for a customer by the identifier used in the source system.

Authorizations:
api_key
path Parameters
externalIdentifier
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Search for a customer by the phone number.

Authorizations:
api_key
query Parameters
number
required
string
type
string
Default: "home"
Enum: "home" "mobile"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates an account pair (customer + debit account) and deposits money. on it

Authorizations:
api_key
Request Body schema: */*
required
order_id
required
string
currency_token
required
string
amount
required
string
voucher_code
required
string

Responses

Response samples

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

Get the balance of a customer account

Authorizations:
api_key
path Parameters
cardNumber
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Recharge the balance of a customer account

Authorizations:
api_key
Request Body schema: */*
required
cardNumber
string
balance
string
currencyToken
string
paymentMethod
string
Enum: "PAYPAL" "CREDIT_CARD" "ONLINE_BANK_TRANSFER"

Responses

Response samples

Content type
application/json
[
  • {
    }
]