Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Adding receipt to your payment request alllows your customers to view the full payment receipt on their mobile device immediately after the payment approved, and on their SensePass account.
Receipt full documentation: Receipts Model
URL: /transactions/init
Request Body:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"receipt": {
"mode": 1,
"accountingProvider": 4,
"receiptInfo": {
"customerId": "123456789",
"firstName": "John",
"lastName": "Doe",
"address": "Begin Dw 12",
"city": "Tel Aviv",
"zipCode": "90745",
"socialID": "123456789",
"phoneNumber": "5551112232",
"languageCode": "en",
"currencyCode": "USD",
"email": "[email protected]",
"discount": 0,
"vat": true
}
},
"receiptNotifications": {
"email": [
"[email protected]"
],
"sms": [
"9295522135"
]
}
}API for creating new payment requests, this API create Transaction Entity.
POST https://api.sensepass.com/api/transactions/init
This API creates new payment request based on the fields below.
Authentication Request Body fields
See Transactions entity schema:
Basic request example to create a new transaction.
See our full examples for creating transactions on the left menu.
Full Transaction Entity schema:
Adding receipt to your payment request alllows your customers to view the full payment receipt on their mobile device immediately after the payment approved, and on their SensePass account.
Receipt full documentation: Receipts Model
Request Body:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"receipt": {
"mode": 1,
"accountingProvider": 4,
"receiptInfo": {
"customerId": "123456789",
"firstName": "John",
"lastName": "Doe",
"address": "Begin Dw 12",
"city": "Tel Aviv",
"zipCode": "90745",
"socialID": "123456789",
"phoneNumber": "5551112232",
"languageCode": "en",
"currencyCode": "USD",
"email": "[email protected]",
"discount": 0,
"vat": true
}
},
"receiptNotifications": {
"email": [
"[email protected]"
],
"sms": [
"9295522135"
]
}
}timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
maxInstallments
number
Installments Limit for this transaction - Valid only for credit card payment
returnURL
string
URL to redirect consumer after Success or Error (For E-Commerce Transactions)
cancelURL
string
URL to redirect consumer on cancel event from consumer (For E-Commerce Transactions)
callbackURL
string
URL to Callback/webhooks API - SensePass will call this API with full Transaction Entity for every status change about this transaction
posData
object
Any data (object/array/string/number etc...) to be received in the callback url or transaction's responses
clientPhoneNumber
string
SMS message will be sent to this consumer number for SMS payment
For delivery status - See "SMS" field in
clientEmail
string
email message will be sent to this consumer email for remote payment
clientName
string
consumer name for the payment
reason
string
The reason for this payment - This field will be presented to the consumer
invoice
object
Used to present invoice for the consumer before the payment
See invoice object entity:
receipt
object
Used for present receipt for the consumer after the payment
See receipt object entity:
emailConfig.paymentRequest.language
string
[ en, he, ru ]
receiptNotifications
object
Receipt Notifications
entity:
products
object
Products information
See product object entity:
metadata
object
a unique array with a key-value pair for displaying information on SensePass Dashboard (backoffice)
billingAddress
object
Customer's billing address entity:
shippingAddress
object
Customer's shipping address entity:
paymentDetails
object
Payment details Input
entity:
hideAmount
boolean
Determines whether the transaction amount is displayed on the payment page or not
additionalData
object
Any additional data that may be sent to the processor
approvalMessage
string
Message to appear in the header of confirmation page
authorizationText
string
Message to appear on tokenized transactions . default value is:
orderId
string
Order ID you can send which will be shown on the payment request/invoice emails (according to Merchant/Location Settings).
invoiceId
string
Invoice ID you can send which will be shown on the payment request/invoice emails (according to Merchant/Location Settings).
level
object
Payment method Level 2 or 3 requirements:
methodType
string
Transaction Type: 0. 'payment' = Regular Payment 1. 'tokenize' = Tokenization 2. 'authorize' = Authorization 3. 'credit' = Credit transaction (Refund transaction without a reference to original payment transaction)
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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",
"consumerPage": {
"regular": "https://pay.sandbox.sensepass.com/orderSummary/027e4e48d59fdbe83f5a78cab62a53c676b7f111fa9d0ee0a36d1872",
"medium": "https://pay.sandbox.sensepass.com/orderSummary/027e4e48d59fdbe83f5a78cab62a53c676b7f111fa9d0ee0a36d1872?viewMode=medium"
}
},
"balance": 0
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm"
}
I authorize {{businessName}} to process future paymentsSimple request example to create new transaction and products information.
Adding products to request body allows the consumer to view before and after the payment the full product information including product names, quantity, pricing per products, sub products and tax.
In addition, the products information will be visible in the merchant back office.
URL: /transactions/init
Request body:
POST /transactions/init
This API creates new payment request based on the fields below.
See Transactions entity schema:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"products": [
{
"name": "Shirt",
"quantity": 1,
"amount": 190,
"discount": 0,
"vat": 0
},
{
"name": "Service Fee",
"quantity": 1,
"amount": 10,
"discount": 0,
"vat": 0
}
]
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint"
}deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
products
object
Products information
See product object entity:
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
returnURL
string
URL to redirect consumer after Success or Error
cancelURL
string
URL to redirect consumer on cancel event from consumer
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
Simple request example to create new transaction with callback URL data.
Adding callback URL to request body enables you to get POST request from SensePass on any transaction update events.
It is required to implement a POST endpoint on your server based on the same interface as
In event of communication error from SensePass to your server - SensePass will retry multiple times to call your server will the callback URL over a period of days.
URL: /transactions/init
Request Body:
POST /transactions/init
This API creates new payment request based on the fields below.
See Transactions entity schema:
HMAC (Hash-based Message Authentication Code) signature authentication for callbacks is a security mechanism used to ensure the integrity and authenticity of a message between two systems.
This authentication logic will enables you to verify that the callback API call was originated by SensePass.
HMAC Verification steps:
Extract "HMAC-Random-Key" header from the callback API request
Concat the header from #1 to the request body
Perform HMAC 256 calculation with the concatenated string and using your secret HMAC key
Compare the result from #3 against the value of the request header "HMAC-Authorization"
By default all the callbacks are sent with JSON body and POST method, it is possible to choose GET method callback without request body.
Callback with GET method will be sent with TransactionNumber as query param.
URL: /transactions/init
Request Body for GET callbacks:
This API call will be sent to this URL:
https://google.com/callback/api/callback?TransactionNumber=573942fsdqe90342k304242&callbackType=transaction_status
Adding invoice to your payment request alllows your customers to view the full payment information before processing the payment.
Supported invoice file formats: PDF, JPEG, PNG.
It is required to host the invoice on a publicy accessible server and send SensePass the full URL of the file, SensePass will not expose to the consumers the URL, instead our servers will download the invoice from your server and host it securely.
Please see the full invoice model here:
Request Body:
Simple request example to create new transaction with POS data.
POS data is key-value data that can be sent in the request body to store custom information about the transaction, for example - order id, consumer name.
This information will not be visible to the consumer and this data will be available to the POS on any transaction event - Socket.IO messages, callback, transaction status API.
URL: /transactions/init
Request Body:
Adding invoice to your payment request alllows your customers to view the full payment information before processing the payment.
Supported invoice file formats: PDF, JPEG, PNG.
It is required to host the invoice on a publicy accessible server and send SensePass the full URL of the file, SensePass will not expose to the consumers the URL, instead our servers will download the invoice from your server and host it securely.
Please see the full invoice model here:
URL: /transactions/init
Request Body:
{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm"
}deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
callbackURL
string
URL to your POST endpoint
Interface:
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
deviceId*
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
See Transactions entity schema:
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
See Transactions entity schema:
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
See Transactions entity schema:
Simple request example to create new transaction with callback URL data.
Adding callback URL to request body enables you to get POST request from SensePass on any transaction update events.
It is required to implement a POST endpoint on your server based on the same interface as
In event of communication error from SensePass to your server - SensePass will retry multiple times to call your server will the callback URL over a period of days.
Request Body:
POST /transactions/init
This API creates new payment request based on the fields below.
See Transactions entity schema:
HMAC (Hash-based Message Authentication Code) signature authentication for callbacks is a security mechanism used to ensure the integrity and authenticity of a message between two systems.
This authentication logic will enables you to verify that the callback API call was originated by SensePass.
HMAC Verification steps:
Extract "HMAC-Random-Key" header from the callback API request
Concat the header from #1 to the request body
Perform HMAC 256 calculation with the concatenated string and using your secret HMAC key
Compare the result from #3 against the value of the request header "HMAC-Authorization"
By default all the callbacks are sent with JSON body and POST method, it is possible to choose GET method callback without request body.
Callback with GET method will be sent with TransactionNumber as query param.
URL: /transactions/init
Request Body for GET callbacks:
This API call will be sent to this URL:
https://google.com/callback/api/callback?TransactionNumber=573942fsdqe90342k304242&callbackType=transaction_status
Adding receipt to your payment request alllows your customers to view the full payment receipt on their device immediately after the payment approved, and on their SensePass account.
Receipt full documentation: Receipts Model
Request Body:
Response body:
See "posReceiptsEndpoint" field in the response body, the value of the field represents the unique endpoint created for saving the receipt created by the e-commerce platform.
Save this value in your website platform for a case of "Approved" status event.
Register to Socket.IO channel or use callback URL to get notifications about transaction status changes.
Once the transaction status changes to status "Approved" (5) you will get "confirmations" object in the Transaction model:
Save all "confirmationNumber" objects, and create receipt in your website platform.
Once the receipt is ready in your platform, invoke API request to the url from "posReceiptsEndpoint" (see the previous section).
It is required to host the receipt on a publicy accessible server and send SensePass the full URL of the file, SensePass will not expose to the consumers the URL, instead our servers will download the receipt from your server and host it securely.
Request Body:
"associateToConfirmationNumbers" is an array of "confirmationNumber" for the previous sections, this is the relation between the receipt to the payments of the consumer.
Response body:
SMS Payment Request enables you to send payment request to a consumer remotely, without asking the consumer any confidential information like credit card number.
The SMS message will be sent from SensePass servers, all of the countries globally are supported.
For delivery status - See "SMS" field in
URL: /transactions/init
Request Body:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"callbackURL": "https://google.com/callback/api/callback"
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"callbackURL": "https://google.com/callback/api/callback",
"callbackMethod": "GET"
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"invoice": {
"type": "pdf",
"url": "http://someDomain.com/invoice1.pdf"
}
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"posData": {
"customerName": "John",
"hello": [
"world"
]
},
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"invoice": {
"type": "pdf",
"url": "http://someDomain.com/invoice1.pdf"
}
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"receipt": {
"mode": 2
},
"receiptNotifications": {
"email": [
"[email protected]"
],
"sms": [
"9295522135"
]
}
}{
"TransactionNumber": "5f3275249792ee75b41322e636617ee039e2e1a49cc80c11f2177233",
"date": "2022-08-14T10:09:05.810Z",
"amount": "2",
"currency": "USD",
"status": 0,
"statusName": "Initialize",
"timeoutDate": "2022-08-14T10:19:05.872Z",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction"
},
"businessId": "339978940107456",
"businessName": "Coffee Bar",
"pos": "POS 1",
"businessOwnerPhone": "3587292",
"businessCountry": "US",
"businessCity": "Virginia Beach",
"businessStreet": "123 Street",
"businessAddress": "123 Street, Virginia Beach",
"branchNumber": "1",
"branchId": "1",
"receiptPending": true,
"posReceiptsEndpoint": "https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4",
"transactionPage": {
"iOSLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"androidLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"qrURL": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233"
}
}deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
posData
object
Any data (object/array/string/number etc...) to be received in the callback url or transaction's responses
apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
invoice
object
Used to present invoice for the consumer before the payment
See invoice object entity: Invoice Model
cancelURL
string
URL to redirect consumer on cancel event from consumer
returnURL
string
URL to redirect consumer after Success or Error
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
invoice
object
Used to present invoice for the consumer before the payment
See invoice object entity: Invoice Model
{
"TransactionNumber": "5f3275249792ee75b41322e636617ee039e2e1a49cc80c11f2177233",
"date": "2022-08-14T10:09:05.810Z",
"amount": "2",
"currency": "USD",
"status": 0,
"statusName": "Initialize",
"timeoutDate": "2022-08-14T10:19:05.872Z",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction"
},
"businessId": "339978940107456",
"businessName": "Coffee Bar",
"pos": "POS 1",
"businessOwnerPhone": "3587292",
"businessCountry": "US",
"businessCity": "Virginia Beach",
"businessStreet": "123 Street",
"businessAddress": "123 Street, Virginia Beach",
"branchNumber": "1",
"branchId": "1",
"receiptPending": true,
"posReceiptsEndpoint": "https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4",
"transactionPage": {
"iOSLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"androidLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"qrURL": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233"
},
"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"
}
]
}{
"url": "http://someDomain.com/receipt1.pdf",
"type": "pdf",
"receiptIdentifier": "43242342324",
"associateToConfirmationNumbers": [
"012-34567891",
"012-34567892"
]
}{
"success": true,
"message": "Saved"
}apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
callbackURL
string
URL to your POST endpoint
Interface:
cancelURL
string
URL to redirect consumer on cancel event from consumer
returnURL
string
URL to redirect consumer after Success or Error
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
Full customization of the SMS message including variables can be done using "customSmsText" field in the "/transactions/init" API.
Request Body:
businessName: Merchant name
locationName: Location name
amount: Transaction amount including currency
link: Full URL to payment request page
reason: Reason field of the transaction
expiration: Transaction expiration date formatted
Add %% before and after the name of the variable.
Examples:
%%businessName%% asks you to pay
Hi, you got payment request from %%businessName%%, %%locationName%% of %%amount%% - %%reason%%. Please click here to pay: %%link%%
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
Basic request example to create a new transaction and present it on iFrame.
Response body:
See the URL of the iFrame in transactionPage.consumerPage.
You can choose to display the cosumer two different sizes:
1. Regular display (transactionPage.consumerPage.regular) for full size view, see example:
2. Medium display (transactionPage.consumerPage.medium) for medium view without the QR, see example:
3. Small display (transactionPage.consumerPage.small) for smaller view without the QR and without the header, see example:
There are multiple options to get notifications about the transaction status changes:
Callback
Web sockets (Socket.IO)
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=tr_<TransactionNumber-From-Response-Body>
Sandbox - https://api.sandbox.sensepass.com?id=tr_<TransactionNumber-From-Response-Body>
Listen to "message" event to get notifcations about the transaction.
Post messsge events are sent to client side using the browser API.
Code example:
All of the notifications are conforms to Transaction Entity interface.
See the full interface model here:
Notification Example:
SMS Payment Request enables you to send a payment request to a consumer remotely, without asking the consumer any confidential information like credit card number.
The SMS message will be sent from SensePass servers, all of the countries globally are supported.
For delivery status - See "SMS" field in Transaction Model
Request Body:
Full customization of the SMS message including variables can be done using "customSmsText" field in the "/transactions/init" API.
Request Body:
businessName: Merchant name
locationName: Location name
amount: Transaction amount including currency
link: Full URL to payment request page
Add %% before and after the name of the variable.
Examples:
%%businessName%% asks you to pay
Hi, you got payment request from %%businessName%%, %%locationName%% of %%amount%% - %%reason%%. Please click here to pay: %%link%%
POST /transactions/init
This API creates new payment request based on the fields below.
See Transactions entity schema:
Email Payment Request enables you to send payment request to a consumer remotely, without asking the consumer any confidential information like credit card number.
The Email will be sent from SensePass servers from this address: [email protected]
Multiple languages are available, see "emailConfig" field below.
URL: /transactions/init
Request Body:
POST /transactions/init
This API creates new payment request based on the fields below.
See Transactions entity schema:
Simple request example to create new transaction and products information.
Adding products to request body allows the consumer to view before and after the payment the full product information including product names, quantity, pricing per products, sub products and tax.
In addition, the products information will be visible in the .
Request body:
Email Payment Request enables you to send payment request to a consumer remotely, without asking the consumer any confidential information like credit card number.
The Email will be sent from SensePass servers from this address: [email protected]
Multiple languages are available, see "emailConfig" field below.
Request Body:
Simple request example to create new transaction with website custom data.
The data is key-value pairs that can be sent in the request body to store custom information about the transaction, for example - order id, consumer name.
This information will not be visible to the consumer and this data will be available to the e-commerce platform on any transaction event - Socket.IO messages, callback, transaction status API.
Request Body:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint"
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"callbackURL": "https://google.com/callback/api/callback",
"callbackMethod": "GET"
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 5500,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"clientPhoneNumber": "+155555551234"
}{
"timeOut": 600,
"amount": 5500,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"clientPhoneNumber": "+155555551234",
"customSmsText": "%%businessName%% asks you for %%amount%%"
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"products": [
{
"name": "Shirt",
"quantity": 1,
"amount": 190,
"discount": 0,
"vat": 0
},
{
"name": "Service Fee",
"quantity": 1,
"amount": 10,
"discount": 0,
"vat": 0
}
],
"posData": {
"customerName": "John",
"orderId": "6759082413",
}
}{
"TransactionNumber": "5f3275249792ee75b41322e636617ee039e2e1a49cc80c11f2177233",
"date": "2022-08-14T10:09:05.810Z",
"amount": "2",
"currency": "USD",
"status": 0,
"statusName": "Initialize",
"timeoutDate": "2022-08-14T10:19:05.872Z",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction"
},
"businessId": "339978940107456",
"businessName": "Coffee Bar",
"pos": "POS 1",
"businessOwnerPhone": "3587292",
"businessCountry": "US",
"businessCity": "Virginia Beach",
"businessStreet": "123 Street",
"businessAddress": "123 Street, Virginia Beach",
"branchNumber": "1",
"branchId": "1",
"transactionPage": {
"iOSLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"androidLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"qrURL": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"consumerPage": {
"regular": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"medium": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233?viewMode=medium",
"small": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233?viewMode=small"
}
},
"paymentDetails": {
"type": "Tokenize"
}
}{
"timeOut": 600,
"amount": 5500,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"clientPhoneNumber": "+155555551234"
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"clientEmail": "[email protected]",
"emailConfig": {
"paymentRequest": {
"language": "en"
}
}deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
clientPhoneNumber
string
SMS message will be sent to this consumer number for SMS payment
For delivery status - See "SMS" field in Transaction Model
deviceId
string
Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
clientEmail
string
email message will be sent to this consumer email for remote payment
emailConfig.paymentRequest.language
string
[ en, he, ru ]
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
const childWindow = document.getElementById('sensepass-iframe').contentWindow;
window.addEventListener('message', message => {
// Handle message
});{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": 1234.56,
"currency": "USD",
"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"
}
],
"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"
},
"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
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}expiration: Transaction expiration date formatted
apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
clientPhoneNumber
string
SMS message will be sent to this consumer number for SMS payment
For delivery status - See "SMS" field in
returnURL
string
URL to redirect consumer after Success or Error
cancelURL
string
URL to redirect consumer on cancel event from consumer
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
POST /transactions/initThis API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
POST /transactions/init
This API creates new payment request based on the fields below.
amount*
number
The required amount for this transaction (Cents).
If products are a part of the transaction - they are all summed up & calculated via the following formula:
(amount + vat - discount) * quantity e.g. (10 + 1.7 - 1) * 2.
isCent
boolean
Determines if Amount represents in cents or not
timeOut
number
Time until the transaction will be timed out (seconds)
currency*
string
[ USD, CAD, ILS, EUR, RUB ]
{
"timeOut": 600,
"amount": 5500,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"clientPhoneNumber": "+155555551234",
"customSmsText": "%%businessName%% asks you for %%amount%%"
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"products": [
{
"name": "Shirt",
"quantity": 1,
"amount": 190,
"discount": 0,
"vat": 0
},
{
"name": "Service Fee",
"quantity": 1,
"amount": 10,
"discount": 0,
"vat": 0
}
]
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"clientEmail": "[email protected]",
"emailConfig": {
"paymentRequest": {
"language": "en"
}
}{
"TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"date": "2019-12-19T09:47:59.105Z",
"amount": "1234.56",
"currency": "USD",
"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"
}
],
"productSumMismatch": true,
"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"
}
],
"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"
},
"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
}{
// Response
}{
// Response
}{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm",
"returnURL": "https://merchantDomain.com/thankYouPage",
"cancelURL": "https://merchantDomain.com/cart",
"callbackURL": "https://merchantDomain.com/sensepass/callbackEndPoint",
"posData": {
"customerName": "John",
"hello": [
"world"
]
},
}apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
products
object
Products information
See product object entity: Product Model
returnURL
string
URL to redirect consumer after Success or Error
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
cancelURL
string
URL to redirect consumer on cancel event from consumer
apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
clientEmail
string
email message will be sent to this consumer email for remote payment
emailConfig.paymentRequest.language
string
[ en, he, ru ]
cancelURL
string
URL to redirect consumer on cancel event from consumer
returnURL
string
URL to redirect consumer after Success or Error
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
apiKey*
string
Unique API provided by SensePass, unique for each location of your merchant
posData
object
Any data (object/array/string/number etc...) to be received in the callback url or transaction's responses
returnURL
string
URL to redirect consumer after Success or Error
cancelURL
string
URL to redirect consumer on cancel event from consumer
callbackURL
string
URL to Callback API - SensePass will call this API with full Transaction Entity for every status change about this transaction
See "posReceiptsEndpoint" field in the response body, the value of the field represents the unique endpoint created for saving the receipt created by the POS.
Save this value in the POS for a case of "Approved" status event.
Register to Socket.IO channel or use callback URL to get notifications about transaction status changes.
Once the transaction status changes to status "Approved" (5) you will get "confirmations" object in the Transaction model:
Save all "confirmationNumber" objects, and create receipt in your POS.
Once the receipt is ready in your POS, invoke API request to the endpoint from "posReceiptsEndpoint" (see the previous section).
Example URL (based on "posReceiptsEndpoint"): https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4
Request Body as form-data:
receipt-file
Your File Here - PDF or Image
jsonStr
"associateToConfirmationNumbers" is an array of "confirmationNumber" for the previous sections, this is the relation between the receipt to the payments of the consumer.
Response body:
It is required to host the receipt on a publicly accessible server and send SensePass the full URL of the file, SensePass will not expose to the consumers the URL, instead our servers will download the receipt from your server and host it securely.
Example URL (based on "posReceiptsEndpoint"): https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4
Request Body:
"associateToConfirmationNumbers" is an array of "confirmationNumber" for the previous sections, this is the relation between the receipt to the payments of the consumer.
Response body:
Example URL (based on "posReceiptsEndpoint"): https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4
Request Body:
"associateToConfirmationNumbers" is an array of "confirmationNumber" for the previous sections, this is the relation between the receipt to the payments of the consumer.
Response body:
{
"timeOut": 600,
"amount": 200,
"isCent": true,
"currency": "USD",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm",
"receipt": {
"mode": 2
},
"receiptNotifications": {
"email": [
"[email protected]"
],
"sms": [
"9295522135"
]
}
}{
"TransactionNumber": "5f3275249792ee75b41322e636617ee039e2e1a49cc80c11f2177233",
"date": "2022-08-14T10:09:05.810Z",
"amount": "2",
"currency": "USD",
"status": 0,
"statusName": "Initialize",
"timeoutDate": "2022-08-14T10:19:05.872Z",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction"
},
"businessId": "339978940107456",
"businessName": "Coffee Bar",
"pos": "POS 1",
"businessOwnerPhone": "3587292",
"businessCountry": "US",
"businessCity": "Virginia Beach",
"businessStreet": "123 Street",
"businessAddress": "123 Street, Virginia Beach",
"branchNumber": "1",
"branchId": "1",
"receiptPending": true,
"posReceiptsEndpoint": "https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4",
"transactionPage": {
"iOSLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"androidLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"qrURL": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233"
}
}{
"TransactionNumber": "5f3275249792ee75b41322e636617ee039e2e1a49cc80c11f2177233",
"date": "2022-08-14T10:09:05.810Z",
"amount": "2",
"currency": "USD",
"status": 0,
"statusName": "Initialize",
"timeoutDate": "2022-08-14T10:19:05.872Z",
"paymentCommit": {
"messsage": "Payment commit is enabled for this transaction"
},
"businessId": "339978940107456",
"businessName": "Coffee Bar",
"pos": "POS 1",
"businessOwnerPhone": "3587292",
"businessCountry": "US",
"businessCity": "Virginia Beach",
"businessStreet": "123 Street",
"businessAddress": "123 Street, Virginia Beach",
"branchNumber": "1",
"branchId": "1",
"receiptPending": true,
"posReceiptsEndpoint": "https://api.sandbox.sensepass.com/api/invoicesReceipts/receipt/save/0128c664-1a2a-422c-91d0-85a8af229ed4",
"transactionPage": {
"iOSLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"androidLink": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233",
"qrURL": "https://pay.sandbox.sensepass.com/orderSummary/5f3275249792ee75b41322e636617ee039e2e1a49cc80c27f2177233"
},
"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"
}
]
}{
"success": true,
"message": "Saved"
}{
"url": "http://someDomain.com/receipt1.pdf",
"type": "pdf",
"receiptIdentifier": "43242342324",
"associateToConfirmationNumbers": [
"012-34567891",
"012-34567892"
]
}{
"success": true,
"message": "Saved"
}{
"base64data": "PGh0bWw+",
"type": "html",
"receiptIdentifier": "43242342324",
"associateToConfirmationNumbers": [
"012-34567891",
"012-34567892"
]
}{
"success": true,
"message": "Saved"
}{
"type": "pdf",
"receiptIdentifier": "43242342324",
"associateToConfirmationNumbers": [
"012-34567891",
"012-34567892"
]
}