Receipts Model
Last updated
Last updated
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:
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
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
No receipt handling is required
Multiple options can be selected in the same location and merchant, these options are in the transaction level.
This model is referenced in "receipt" field of request body
field | type | description |
---|---|---|
mode | number |
|
accountingProvider | number | accounting service provider for the receipts to be processed, required if mode is "1" (GenerateReceipt), "2" (POSProvidesReceipt) or a null value.
|
receiptInfo | object |
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 ] |
string | example: john@doe.com | |
discount | number | example: 0 |
vat | boolean | example: true |
This model represents the recipients that will receive receipt by email and SMS.
field | type | description |
---|---|---|
array | example: | |
sms | array | example: |
See receipt info object entity:
Receipt notifications model is referenced in "receiptNotifications" field of request body