Store API v1.0.0

API for managing Merchant stores integrated with Koshelek Pay.

General information

This guide is intended for retail and outlet companies (Merchants) that implement in-store payments powered by Koshelek Pay.

Store API helps Merchants manage store information for stores that accept payments via Koshelek Pay, such as: adding (submitting) store information, getting and updating store information.

Connecting to API

Store API is provided by a dedicated Koshelek host. API consumers are merchants’ servers. To integrate with Store API, use the following parameters:

Authorization

API communication relies on HTTPS with HTTP Basic Authentication (RFC 7617). Request authorization credentials are passed in the Authorization HTTP header as Basic <BASE64STRING>, where <BASE64STRING> — is base64 encoded login:password string.

Encoding

Both API requests and responses use UTF-8 encoding.

Message format and structure

API requests expect content type in header: Content-Type: application/json and return response body in application/json.

HTTP codes

Successful API response will return data as described in API specification, along with HTTP response code: 200.