Credit by Credit Card

API to credit (transfer money from merchant to customer) by credit card token.

Token can be created using the Tokenization flow.

API Interface

Credit API

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

Request Body

Name	Type	Description
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
token*	string	Credit card token - Required
refundAmount	number	The credit amount - Required

200: OK OK

errorCode = 0 indicating successful credit operation.

On error see "errorMessage" field which describes the error cause.

{
  "errorMessage": null,
  "errorCode": 0,
  "refundConfirmation": "063-LlgKAzfRL",
  "approvedBy": "PayPal",
  "refundBy": "PayPal",
  "dateApproval": "2019-12-19T09:47:59.105Z",
  "result": "Approved",
  "providerId": "z+n1opZ+RFn50fstklvWoOsovKIY5AUfsrVdGsO653c=",
  "transaction": {
    "TransactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
    "date": "2019-12-19T09:47:59.105Z",
    "amount": 1234.56,
    "currency": "ILS",
    "status": 0,
    "businessId": 144
  }
}

400: Bad Request Invalid Input

{
    // Response
}

500: Internal Server Error Internal Error

{
    // Response
}

Example

Basic request example to credit using Device ID:

{
  "token": "YOUR-TOKEN",
  "refundAmount": 1.23,
  "deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm"
}

Basic request example to credit using Location API Key or Merchant API key:

{
  "token": "YOUR-TOKEN",
  "refundAmount": 1.23,
  "apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm"
}

Flow Chart

See our payment flow chart here

Transaction Status Flow

See our transaction status flow here