LogoLogo
  • Transaction API
    • Overview
    • Authentication
    • Payment Methods
    • Integrations
      • POS (In-Store)
      • E-commerce
    • Payment Flows
      • Create a transaction
        • Examples for POS (In-Store)
          • Basic Payment Request
          • Payment request with products
          • Payment request with callback
          • Payment request with POS Data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the POS
        • Examples for e-commerce
          • Basic Payment Request
          • iFrame Example
          • Payment request with products
          • Payment request with callback
          • Payment request with website custom data
          • SMS Payment Request
          • Email Payment Request
          • Payment request with invoice
          • Payment request with receipt generated by SensePass
          • Payment request with receipt generated by the e-commerce platform
      • Transaction status
      • Authorization
      • Tokenization
      • Subscription
        • Fetch a subscription
        • Update a subscription
        • Subscription callbacks
      • Cancel a pending transaction
      • Refund a transaction
      • Pay by Credit Card
      • Credit by Credit Card
      • Payment Commit
      • Update a Transaction
    • Other Flows
      • Tags Pairing
      • Receipts
      • Customer Input
      • Token Migration
      • Create Dynamic QR
    • Terminal Agent
      • Installation
      • Pairing
      • Usage
        • Synchronous Payment
        • Real-time product information update
        • Get Last Transaction Status
        • Get Device ID
    • Settlement
    • API Notifications
      • Socket.IO Websockets
      • Callback/Webhook
      • Post Message
    • Flow Charts
      • Payment Flow
      • Transaction Status Flow
    • SDK & iFrames
      • JavaScript UI SDK
        • API
        • Commit Transaction
        • Custom SDK Style
        • Simulator
        • Manual Capture (deprecated)
      • E-commerce iFrame
      • POS iFrame
      • Credit Card iFrame
    • Models
      • Receipts Model
      • Metadata Model
      • SDK Theme Config Model
      • SDK Credit Card Field Model
      • Invoice Model
      • Product Model
      • Payment Details Model
      • Receipt Notifications Model
      • Payment Commit Model
      • Confirmation Model
      • Settlement Model
      • Subscription Model
      • Transaction Page Model
      • Transaction Model
      • Customer Input Model
      • Settlement Report Model
      • Customer Shipping/Billing Details Model
      • Additional Data Model
    • SOAP and XML
      • SOAP
      • XML
    • Testing
    • Postman
  • Partner API
    • Models
      • Onboarding Model
      • Onboarding Configuration Pages
      • Onboarding Status Model
    • SDK & iFrames
      • Onboarding iFrame
    • Flows
      • Create onboarding
      • Get Onboarding Configuration Page
      • Onboarding status
Powered by GitBook
On this page
  • Receipt Model
  • Receipt Info Model
  • Receipt Notifications Model

Was this helpful?

Export as PDF
  1. Transaction API
  2. Models

Receipts Model

Last updated 1 year ago

Was this helpful?

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 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) 3 (QuickBook) 4 (SensePass) 5 (Priority)

receiptInfo

object

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: john@doe.com

discount

number

example: 0

vat

boolean

example: true

Receipt Notifications Model

This model represents the recipients that will receive receipt by email and SMS.

field
type
description

email

array

example:

sms

array

example:

See receipt info object entity:

Receipt notifications model is referenced in "receiptNotifications" field of request body

["a@example.com"]
["9295522135"]
#receipt-info-entity
#creating-new-transaction
Creating a new transaction object (Payment Request)