API v1.0.0 Objects

Koshelek Pay API

Documentation has moved

The information on this page is no longer updated and may be obsolete. The most current Koshelek documentation is now available at the new address:

https://developers.koshelek.app/en/

1. CheckoutInvoice

Object contains checkout invoice data.

Field	Type	Mandatory	Description
orderId	String	Yes	Invoice ID in merchant's system (up to 36 characters).
totalAmount	Number	Yes	Total amount in kopecks (10 characters — only digits, non-negative number). Spaces are not allowed.
discountAmount	Number	No	Discount amount in kopecks (10 characters — only digits, non-negative number). Spaces are not allowed.
subTotalAmount	Number	No	Total amount excluding discount in kopecks. (10 characters — only digits, non-negative number). Spaces are not allowed.
items	Array of Item	Yes	Array of Item objects describing commodity items.

2. Item

Object defines particular commodity item to be paid with Koshelek Pay.

Field	Type	Mandatory	Description
name	String	Yes	Item name.
article	String	Yes	Item article.
price	Number	Yes	Price for one item in kopecks.
quantity	Number	Yes	Number.
totalAmount	Number	Yes	Total amount in kopecks. Spaces are not allowed.
discountAmount	Number	No	Discount amount in kopecks. Spaces are not allowed.
subTotalAmount	Number	No	Total amount excluding discount in kopecks. Spaces are not allowed.
tax	Enum	Yes	Tax rate: none — no VAT. vat0 — VAT at 0% rate. vat10 — VAT at 10% rate. vat20 — VAT at 20% rate. vat110 — VAT at estimated tax rate of 10/110. vat120 — VAT at estimated tax rate of 20/120.

3. User

Object describes a loyalty program user (customer).

Field	Type	Mandatory	Description
loyaltyId	String	Yes	Customer loyalty ID (e.g., presented loyalty card number) (up to 36 characters).

4. PaymentTypeAvailabilityInfo

Object containing available payment method info.

Field	Type	Mandatory	Description
paymentType	String	Yes	Payment method name (up to 36 characters).
available	Boolean	Yes	Indicates payment method availability: true — available; false — unavailable.
message	String	No	Additional information on payment method.

5. Slip

Object contains information about completed transaction.

Field	Type	Mandatory	Description
id	String	Yes	Slip object ID in Koshelek Pay.
paymentType	Enum	Yes	Payment mechanism: SBP — Faster Payments System (FPS). DOLYAME — Dolyame.
storeId	String	Yes	Store ID (see API Connection).
terminalId	String	Yes	Terminal ID.
orderId	String	Yes	Invoice ID in merchant's system.
paymentTransactionId	String	Yes	Payment transaction ID in Koshelek Pay.
refundTransactionId	String	No	Refund transaction ID.
merchantId	String	Yes (for paymentType = SBP)	Merchant ID presented by recipient bank. Mandatory for SBP transactions.
kzo	String	No	Control operation value that may be returned for successful SBP transaction.
operationDateTime	Date	Yes	Date in format: yyyy-MM-dd'T'HH:mm:ss.SSSZ Time zone always equals Z (+0).
operationId	String	No	Transaction ID assigned by bank.
qrcId	String	Yes (for paymentType = SBP)	Transaction ID assigned by Faster Payments System. Mandatory for SBP transactions.
totalAmount	Number	Yes	Paid amount in kopecks. Spaces are not allowed.

6. PaymentMethod

Object defines payment method used in transaction.

Field	Type	Mandatory	Description
type	Enum	Yes	Payment mechanism: SBP — Faster Payments System (FPS). DOLYAME — Dolyame.
meta	Object	No	Object for extra fields (e.g. discounts, bonuses etc.) in a "key-value" format.
paymentPurpose	String	No	"Payment purpose" value applicable to SBP transactions. When returned, this value will override any other paymentPurpose value agreed by default between merchant and Cardsmobile.

7. Invoice

Object describes an invoice (receipt).

Field	Type	Mandatory	Description
orderId	String	Yes	Invoice number (up to 36 characters).
receiptId	String	Yes	Receipt number (up to 36 characters).
merchantName	String	Yes	Merchant full name (up to 999 characters).
merchantAddress	String	Yes	Merchant address (up to 999 characters).
inn	String	Yes	Merchant TIN (12 digits, opening with 2 zeroes for legal entities.
dateTime	Datetime	Yes	Date in format: YYYY-MM-DDTHH24:MI:SS+GMT
shift	String	Yes	Work shift (up to 32 characters).
cashier	String	Yes	Checkout operator number or name (up to 256 characters).
taxation	Enum	No	Taxation system (TS): osn — general TS. usn_income — simplified TS (income). usn_income_outcome — simplified TS (net income). envd — unified tax on imputed income. esn — unified agricultural tax. patent — patent TS.
kktRegNumber	String	No	Cash register number (up to 64 characters).
fnNumber	String	No	Fiscal memory device number (up to 64 characters).
fpd	String	No	Fiscal attribute of document (up to 64 characters).
fdNumber	String	No	Fiscal document number (up to 64 characters).
website	String	No	Web site for receipt verification (e.g. nalog.ru) (up to 64 characters).
receiptType	Enum	Yes	Receipt type: debit credit refund
totalAmount	Number	Yes	Total amount in kopecks (up to 10 digits, non-negative integer). Spaces are not allowed.
discountAmount	Number	No	Discount amount in kopecks (up to 10 digits, non-negative integer). Spaces are not allowed.
subTotalAmount	Number	No	Total amount excluding discount in kopecks (10 digits, non-negative integer). Spaces are not allowed.
taxAmount	Number	Yes	Tax amount in kopecks (up to 10 characters — only digits, non-negative integer). Spaces are not allowed.
qr	String	No	QR for receipt in digital (up to 999 characters).
items	Array of Item	Yes	Array of Item objects describing purchased items.