API to refund payments of approved transaction or partial refund transaction with available balance to refund.
This endpoint automaticlly detects if void or refund operation is required.
POST
https://api.sensepass.com/api/transactions/refund
Name | Type | Description |
---|---|---|
errorCode = 0 indicating successful refund operation.
On error see "errorMessage" field which describes the error cause.
Basic request example to refund a new transaction using Device ID:
Basic request example to refund a new transaction using Location API Key or Merchant API key:
See our payment flow chart here
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 - Required
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