Transaction Events
There are multiple options to get notifications about the transaction status changes:
- 1.Callback
- 2.Web sockets (Socket.IO)
- 3.Post message event on the client side
Adding callback URL using "callbackURL" field to request body enables you to get POST request from SensePass on any transaction update events.
See full information about callbacks logic here:
Implement Socket.IO client on your platform and listen to this URL:
Production - https://api.sensepass.com?id=id_<Device_Id>
Sandbox - https://api.sandbox.sensepass.com?id=id_<Device_Id>
Listen to "message" event to get notifcations about the transaction for a specific device.
Post messsge events are sent to client side using the browser API.
Code example:
const childWindow = document.getElementById('sensepass-iframe').contentWindow;
window.addEventListener('message', message => {
// Handle message
});
All of the notifications are conforms to Transaction Entity interface.
See the full interface model here:
Notification Example:
{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": 1234.56,
"currency": "ILS",
"status": 0,
"statusName": "Transaction Approved",
"pos": "POS 3, Branch Tel Aviv",
"posReceiptsEndpoint": "http://pay.sensepass-api.com/api/invoicesReceipts/receipt/save/hofai3478o8o78o4s849j3920ckj",
"posData": {
"foo": "bar",
"hello": [
"world"
]
},
"businessName": "Coffee Bar",
"businessId": 144,
"timeoutDate": "2019-12-19T09:47:59.105Z",
"paymentMethodData": {
"PaymentType": "Bit",
"directAppLinks": {
"iOSLink": "paymentsBIT://www.bitpay.co.il/app/bitcom-info",
"androidLink": "intent://www.bitpay.co.il/app/bitcom-info;scheme=bit;package=com.bnhp.payments.paymentsapp;end",
"qrURL": "https://www.bitpay.co.il/app/bitcom-info"
}
},
"SMS": "Sent",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction",
"isPaymentCommitted": false,
"secondsToCommit": 60,
"commitLink": "https://pay.sensepass-api.com/api/transactions/commitPayment/ec2dc489d161aa27a803f48bcf5ffcf"
},
"products": [
{
"name": "Coffee",
"quantity": 2,
"amount": 100,
"discount": 0,
"posIdentifier": "1234A"
},
{
"name": "Beer",
"quantity": 1,
"amount": 600,
"discount": 0,
"posIdentifier": "1234B"
}
],
"confirmations": [
{
"paymentType": "Regular",
"confirmationNumber": "063-d9j09YsY1",
"fullConfirmationCode": "063-d9j09YsY1",
"dateApproval": "2019-12-19T09:47:59.105Z",
"installments": 1,
"paymentMethodName": "PayPal",
"approvedBy": "PayPal",
"providerId": "uGfNuwEGiP18SUnTUEo1/atTdesDnhDhZ/8i7G9NAEg=",
"requestID": "a4dbf66e-d3f1-4a29-baf7-2591424a9a0c",
"authNumber": "123213dsf13111",
"referenceNumber": "1778298289",
"acquirer": "Visa",
"voucher": "yyyAbnlmlfm1323",
"lastFourDigits": "8858",
"sensePassReferenceId": "34e209ea8b24cc831cf",
"settlement": {
"status": 2, // 0=processing, 1=pending, 2=done
"created": "2019-12-19T09:47:59.105Z", // will be updated upon status change
"confirmation": "091239831" // only exists once status = 2 (done)
}
}
],
"confirmation": {
"paymentType": "Regular",
"confirmationNumber": "063-d9j09YsY1",
"fullConfirmationCode": "063-d9j09YsY1",
"dateApproval": "2019-12-19T09:47:59.105Z",
"installments": 1,
"paymentMethodName": "PayPal",
"approvedBy": "PayPal",
"providerId": "uGfNuwEGiP18SUnTUEo1/atTdesDnhDhZ/8i7G9NAEg=",
"requestID": "a4dbf66e-d3f1-4a29-baf7-2591424a9a0c",
"authNumber": "123213dsf13111",
"referenceNumber": "1778298289",
"acquirer": "Visa",
"voucher": "yyyAbnlmlfm1323",
"lastFourDigits": "8858",
"sensePassReferenceId": "34e209ea8b24cc831cf",
"settlement": {
"status": 2, // 0=processing, 1=pending, 2=done
"created": "2019-12-19T09:47:59.105Z", // will be updated upon status change
"confirmation": "091239831" // only exists once status = 2 (done)
}
},
"transactionPage": {
"iOSLink": "https://mbeta.sensepass-api.com/orderSummary/027e4e48d59fdbe83f5a78cab62a53c676b7f111fa9d0ee0a36d1872",
"androidLink": "https://mbeta.sensepass-api.com/orderSummary/027e4e48d59fdbe83f5a78cab62a53c676b7f111fa9d0ee0a36d1872",
"qrURL": "https://mbeta.sensepass-api.com/orderSummary/027e4e48d59fdbe83f5a78cab62a53c676b7f111fa9d0ee0a36d1872"
},
"balance": 0
}
Last modified 5mo ago