Transaction Model

This model is referenced in the response of #creating-new-transaction

field type description

field	type	description
TransactionNumber	string	example: 14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c The transaction number of the new transaction created
date	date	example: 2019-12-19T09:47:59.105Z Creation date of this transaction entity
amount	string	example: "1234.56" Amount of this this transaction entity
currency	string	[ USD, CAD, ILS, EUR, RUB ]
status	number	Current transaction Status of this transaction: * `Initialize (0)` - New Transaction * `TapDetected (1)` - At least one user tapped his mobile device * `UserApproved (2)` - A user approved the payment details for this transaction, the transaction not approved yet * `UserDeclined (3)` - A user declined the payment details for this transaction, it's not a final status, waiting for other users to approve * `ProccessingPayment (4)` - SensePass GW proccessing the payment using the providers and waiting for approval * `TransactionApproved (5)` - SensePass GW approved this transaction, confirmation Data will be sent using Web Socket messaging service * `TransactionDeclined (6)` - SensePass GW decline this transaction according to provider decision * `TransactionFailed (7)` - Transaction Failed * `TransactionTimeout (8)` - Transaction Timeout * `TransactionCancel (9)` - Transaction Cancel * `WaitingForTap (10)` - Waiting For Tap * `TransactionRefund (11)` - Transaction Refund * `TransactionProcessingRefund (12)` - Transaction Processing Refund * `TransactionPartiallyRefunded (13)` - Transaction Partially Refunded
statusName	string	example: Transaction Approved Friendly Status Description
pos	string	example: POS 3, Branch Tel Aviv The terminal name associated for this transaction
posReceiptsEndpoint	string	example: http://pay.sensepass-api.com/api/invoicesReceipts/receipt/save/hofai3478o8o78o4s849j3920ckj The endpoint for the pos's receipts to be handled by the selected mode in the transaction's creation
posData	objects	Any data (object/array/string/number etc...) received in "posData" field in #creating-new-transaction
businessName	string	example: Coffee Bar The business name associated for this terminal
businessId	number	example: 144 The business ID associated to this terminal
timeoutDate	date	example: 2019-12-19T09:47:59.105Z Timeout date for this transaction
SMS	string	SMS delivery status, see "clientPhoneNumber" field in #creating-new-transaction
paymentCommit	object	See payment commit object entity:
products	object	See product object entity:
productSumMismatch	boolean	Informs if the sum of all products are not equal to the transaction's amount
confirmations	object	See confirmation object entity:
transactionPage	object	See transaction page entity:
confirmation	Deprecated	Deprecated field
paymentMethodData	Deprecated	Deprecated field
subscription	object	see subscription object entity: Subscription Model
parentTransaction	object	parent transaction with method type: Subscription/Authorization/Tokenization. Transaction Model

TransactionNumber

string

example: 14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c

The transaction number of the new transaction created

date

example: 2019-12-19T09:47:59.105Z

Creation date of this transaction entity

amount

string

example: "1234.56"

Amount of this this transaction entity

currency

string

[ USD, CAD, ILS, EUR, RUB ]

status

number

Current transaction Status of this transaction: * Initialize (0) - New Transaction * TapDetected (1) - At least one user tapped his mobile device * UserApproved (2) - A user approved the payment details for this transaction, the transaction not approved yet * UserDeclined (3) - A user declined the payment details for this transaction, it's not a final status, waiting for other users to approve * ProccessingPayment (4) - SensePass GW proccessing the payment using the providers and waiting for approval * TransactionApproved (5) - SensePass GW approved this transaction, confirmation Data will be sent using Web Socket messaging service * TransactionDeclined (6) - SensePass GW decline this transaction according to provider decision * TransactionFailed (7) - Transaction Failed * TransactionTimeout (8) - Transaction Timeout * TransactionCancel (9) - Transaction Cancel * WaitingForTap (10) - Waiting For Tap * TransactionRefund (11) - Transaction Refund * TransactionProcessingRefund (12) - Transaction Processing Refund * TransactionPartiallyRefunded (13) - Transaction Partially Refunded

statusName

string

example: Transaction Approved

Friendly Status Description

pos

string

example: POS 3, Branch Tel Aviv

The terminal name associated for this transaction

posReceiptsEndpoint

string

example: http://pay.sensepass-api.com/api/invoicesReceipts/receipt/save/hofai3478o8o78o4s849j3920ckj

The endpoint for the pos's receipts to be handled by the selected mode in the transaction's creation

posData

objects

Any data (object/array/string/number etc...) received in "posData" field in #creating-new-transaction

businessName

string

example: Coffee Bar

The business name associated for this terminal

businessId

number

example: 144

The business ID associated to this terminal

timeoutDate

date

example: 2019-12-19T09:47:59.105Z Timeout date for this transaction

SMS

string

SMS delivery status, see "clientPhoneNumber" field in #creating-new-transaction

paymentCommit

object

See payment commit object entity:

products

object

See product object entity:

productSumMismatch

boolean

Informs if the sum of all products are not equal to the transaction's amount

confirmations

object

See confirmation object entity:

transactionPage

object

See transaction page entity:

confirmation

Deprecated

Deprecated field

paymentMethodData

Deprecated

Deprecated field

subscription

object

see subscription object entity: Subscription Model

parentTransaction

object

parent transaction with method type: Subscription/Authorization/Tokenization. Transaction Model

Last updated 4 months ago