Receipts Model

This model represents all the required data for receipt handlind once the transaction is approved.
There are 3 possible options available for the POS/E-Commerce platform:
1.Sensepass generate the receipt using the receipt-info-entity model, the receipt will be presented to the consumer and to saved in SensePass Merchant dashboard
2.POS generates the receipt and will send it to SensePass on transaction approved, the receipt will be presented to the consumer and to saved in SensePass Merchant dashboard
3.No receipt handling is required
Multiple options can be selected in the same location and merchant, these options are in the transaction level.
Receipt Model
This model is referenced in "receipt" field of creating-new-transaction request body
field
type
description
mode
number
1 (GenerateReceipt) = generates a receipt using the given configuration.
2 (POSProvidesReceipt) = pos is responsible to send the receipts to the provided endpoint after the transation/'s creation.
3 (NoReceipt) = does not generate any receipt.
null/undefined = a null/undefined value will default the receipt configuration from its branch definition.
accountingProvider
number
accounting service provider for the receipts to be processed, required if mode is "1" (GenerateReceipt), "2" (POSProvidesReceipt) or a null value.
1 (Rivhit)
2 (ICount)
receiptInfo
object
See receipt info object entity: receipt-info-entity​
​
Receipt Info Model
Receipt info model is referenced in "receiptInfo" field of receipt-entity​
field
type
description
customerId
string
example: 123456789
firstName
string
example: John
lastName
string
example: Doe
address
string
example: 144 Begin Dw
city
string
example: Tel Aviv
zipCode
string
example: 90745
socialID
string
example: 123456789
phoneNumber
string
example: 2124567890
languageCode
string
[ he, en, ru ]
currencyCode
string
[ ILS, USD, EUR, RUB ]
email
string
example: [email protected]
discount
number
example: 0
vat
boolean
example: true
​
Receipt Notifications Model
This model represents the recipients that will receive receipt by email and SMS.
Receipt notifications model is referenced in "receiptNotifications" field of Creating a new transaction object (Payment Request) request body
field
type
description
email
array
example: 
["[email protected]"]
sms
array
example: 
["9295522135"]
​

field	type	description
mode	number	`1 (GenerateReceipt)` = generates a receipt using the given configuration. `2 (POSProvidesReceipt)` = pos is responsible to send the receipts to the provided endpoint after the transation/'s creation. `3 (NoReceipt)` = does not generate any receipt. `null/undefined` = a null/undefined value will default the receipt configuration from its branch definition.
accountingProvider	number	accounting service provider for the receipts to be processed, required if mode is "1" (GenerateReceipt), "2" (POSProvidesReceipt) or a null value. `1 (Rivhit)` `2 (ICount)`
receiptInfo	object	See receipt info object entity: receipt-info-entity

field	type	description
customerId	string	example: 123456789
firstName	string	example: John
lastName	string	example: Doe
address	string	example: 144 Begin Dw
city	string	example: Tel Aviv
zipCode	string	example: 90745
socialID	string	example: 123456789
phoneNumber	string	example: 2124567890
languageCode	string	[ he, en, ru ]
currencyCode	string	[ ILS, USD, EUR, RUB ]
email	string	example: [email protected]
discount	number	example: 0
vat	boolean	example: true

field	type	description
email	array	example: ["[email protected]"]
sms	array	example: ["9295522135"]

Models

Metadata Model

Last modified 4mo ago