Ask or search…
K

Refund a transaction

API for refund approved transaction or partial refund transaction with available balance to refund.
This endpoint automaticlly detects if void or refund operation is required.

API Interface

post
https://api.sensepass.com/api
/transactions/refund
Refund approved transaction object
Parameters
Body
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
transactionNumber*
string
The Transaction Number To Be Refunded
isPartial
boolean
true for partial refund transaction, requires "refundAmount" field for partial amount
refundAmount
number
The refund amount - for partial refund only, see "isPartial" flag
Responses
200: OK
OK
400: Bad Request
Invalid Input
500: Internal Server Error
Internal Error

Example

Basic request example to refund a new transaction using Device ID:
{
"transactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"deviceId": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o03to9bxfkr7t815i5epu8o58jv1rznif3o1tr6xsb1rm"
}
Basic request example to refund a new transaction using Location API Key or Merchant API key:
{
"transactionNumber": "14a4334a32c852aeb0cfae52cbff1314649da7f175a8e140b35c147c",
"apiKey": "2ooeww5ufzg3nkuf8a10gu5n695yolixlbgb042o038o58jv1rznif3o1tr6xsb1rm"
}

Flow Chart

Transaction Status Flow

Last modified 6mo ago