Create a transaction

API for creating new payment requests, this API create Transaction Entity.

API Interface

Creating a new transaction object (Payment Request)

POST https://api.sensepass.com/api/transactions/init

This API creates new payment request based on the fields below.

Request Body

Name	Type	Description
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
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
deviceId	string	Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
apiKey	string	Merchant ID provided by SensePass (For Web based Transactions) - Required if deviceId is empty
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 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.email	array	Invoice & Receipt Recipients Email example: ["a@example.com"]
receiptNotifications.sms	array	Invoice & Receipt Recipients SMS example: ["9295522135"]
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) Metadata Model
billingAddress	object	Customer's billing address entity: Customer Billing Details Model
shippingAddress	object	Customer's shipping address entity: Customer Shipping Details Model

Name

Type

Description

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

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

deviceId

string

Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty

apiKey

string

Merchant ID provided by SensePass (For Web based Transactions) - Required if deviceId is empty

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 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.email

array

Invoice & Receipt Recipients Email

example: ["a@example.com"]

receiptNotifications.sms

array

Invoice & Receipt Recipients SMS

example: ["9295522135"]

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) Metadata Model

billingAddress

object

Customer's billing address entity: Customer Billing Details Model

shippingAddress

object

Customer's shipping address entity: Customer Shipping Details Model

See Transactions entity schema: #transaction-entity

{
  "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
}

Examples

Basic request example to create a new transaction.

{
  "timeOut": 600,
  "amount": 200,
  "isCent": true,
  "currency": "USD",
  "deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm"
}

See our full examples for creating transactions on the left menu.

Schema

Full Transaction Entity schema: #transaction-entity

Flow Chart

See our payment flow chart here

Transaction Status Flow

See our transaction status flow here

Last updated 1 month ago