Basic Payment Request
Basic request example to create a new transaction.
{
"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"
}
Creating a new transaction object (Payment Request)
POST
/transactions/init
This API creates new payment request based on the fields below.
Request Body
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
See Transactions entity schema: Transaction Model
{
"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
}
Last updated
Was this helpful?