Pay by Credit Card

API for direct payment by credit card number without using payment page.

Sending credit card information using API requires your server to be PCI compliant, if you don't have PCI certification - please see our documentation of Credit Card iFrame

API Interface

Pay by credit card

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

Request Body

Name	Type	Description
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.
creditCardDetails.cardNumber*	string	Credit card number
branchNumber	string	Location ID provided by SensePass
currency*	string	[ USD, CAD, ILS, EUR, RUB ]
creditCardDetails.securityCode*	string	Credit card CVV
deviceId	string	Terminal unique device ID provided by SensePass (For Device based Transactions) - Required if apiKey is empty
merchantApiKey	string	Merchant ID provided by SensePass (For Web based Transactions) - Required if deviceId is empty
reason	string	The reason for this payment - This field will be presented to the consumer
creditCardDetails.socialID	String	Israel Only - Social ID of the credit card owner
creditCardDetails.cardExpiration*	string	Credit card expiration MM/YY
installments	number	Israel Only - Installments
metadata	array	Metadata Model

200: OK OK

See Transactions entity schema: #transaction-entity

{
  "success": true,
  "message": null,
  "code": null,
  "error": null,
  "approvalID": null,
  "requestID": null,
  "transactionNumber": "cf04ea0faf73988c1f545add1ec2bd9fcd87c7a292566536e8395b1b",
  "transactionPaymentID": null,
  "transactionStatus": "TransactionApproved",
  "confirmation": [
    {
      "paymentType": "Regular",
      "confirmationNumber": "063-d9j09YsY1",
      "fullConfirmationCode": "063-d9j09YsY1",
      "dateApproval": "2019-12-19T09:47:59.105Z",
      "installments": 1,
      "paymentMethodName": "Credit Card",
      "approvedBy": "Cardknox",
      "providerId": "uGfNuwEGiP18SUnTUEo1/atTdesDnhDhZ/8i7G9NAEg=",
      "requestID": "a4dbf66e-d3f1-4a29-baf7-2591424a9a0c",
      "authNumber": "123213dsf13111",
      "referenceNumber": "1778298289",
      "acquirer": "Visa",
      "voucher": "yyyAbnlmlfm1323",
      "lastFourDigits": "8858",
      "cardExpiration": "0127",
      "sensePassReferenceId": "34e209ea8b24cc831cf"
    }
  ]
}

400: Bad Request Invalid Input

{
    // Response
}

500: Internal Server Error Internal Error

{
    // Response
}

Examples

Basic request example to pay using credit card

{
  "deviceId": "93sa20e3b9c05d0670f00924a5384185aa4e5fe913b71014",
  "amount": 500,
  "currency": "USD",
  "reason": "Invoice of December 2023",
  "creditCardDetails": {
    "cardNumber": "375510190366075",
    "cardExpiration": "12/34",
    "securityCode": "0123"
  }
}

Response

{
  "success": true,
  "message": null,
  "code": null,
  "error": null,
  "approvalID": null,
  "requestID": null,
  "transactionNumber": "cf04ea0faf73988c1f545add1ec2bd9fcd87c7a292566536e8395b1b",
  "transactionPaymentID": null,
  "transactionStatus": "TransactionApproved",
  "confirmation": [
    {
      "paymentType": "Regular",
      "confirmationNumber": "063-d9j09YsY1",
      "fullConfirmationCode": "063-d9j09YsY1",
      "dateApproval": "2019-12-19T09:47:59.105Z",
      "installments": 1,
      "paymentMethodName": "Credit Card",
      "approvedBy": "Cardknox",
      "providerId": "uGfNuwEGiP18SUnTUEo1/atTdesDnhDhZ/8i7G9NAEg=",
      "requestID": "a4dbf66e-d3f1-4a29-baf7-2591424a9a0c",
      "authNumber": "123213dsf13111",
      "referenceNumber": "1778298289",
      "acquirer": "Visa",
      "voucher": "yyyAbnlmlfm1323",
      "lastFourDigits": "8858",
      "cardExpiration": "0127",
      "sensePassReferenceId": "34e209ea8b24cc831cf"
    }
  ]
}

Transaction Status Flow

See our transaction status flow here