Payment Refund

Initiates a refund for a specific transaction identified by the ptxid parameter. This endpoint allows partial or full refunds based on the provided input. Ensure the transaction ID (ptxid) corresponds to a valid transaction and has not been fully refunded previously.

post

/{ptxid}/refund

Path parameters

ptxidstringrequired

Parent txid of the transaction

Query parameters

sidintegerrequired

sid of site

hashstringrequired

md5 hash of sid+timestamp+amount+currency+rcode e.g. md5('22'.'1234568995265421'.'17.00'.'USD'.'222b6c')

timestampstringrequired

timestamp value used in the hash e.g. 1234568995265421

amountstringrequired

Specifies the amount to refund for the transaction. This parameter is required and must be a string representing a numeric value (e.g., "50.00"). Use this to process a partial refund by providing a specific amount or the full transaction amount for a complete refund.

currencystringrequired

Transaction currency, ISO 3 letter code (e.g., "USD")

reasonstring

Provides a reason for the refund. This parameter is optional and can include a brief message explaining the refund request (e.g., "Client Requested" or "Merchant Request").

postbackurlstring

url to which a postback should be sent

sendNotificationboolean

Specifies whether to send a notification email related to the transaction. Set to true to enable email notifications or false to disable them.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '<?=PROTOCOL?>://<?=SITE_DOMAIN?>/api/v1/index.php/{ptxid}/refund?sid=1&hash=text&timestamp=text&amount=text&currency=text'

200

default

200

{
  "tid": "text",
  "txid": 1,
  "parent_txid": 1,
  "status": "text",
  "tx_action": "text",
  "amount": 1,
  "currency": "text",
  "reference": "text",
  "ref1": "text",
  "ref2": "text",
  "ref3": "text",
  "ref4": "text",
  "vrfy": "text"
}

Lookup result