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<?=PROTOCOL?>://<?=SITE_DOMAIN?>/api/v1/index.php/{ptxid}/refund

Path parameters

ptxid*string

Parent txid of the transaction

Query parameters

Response

200default

Lookup result

Body

application/json

tidstring

tid sent through with the transaction

txidinteger (int64)

Transaction id

parent_txidinteger (int64)

Each Transaction has a unique id. The parent transaction is the transaction that groups all transaction together.

statusstring

Has the value "OK" for a successful transaction, "EXC" for a failed transaction, "PEND" for a transaction in progress.

tx_actionstring

The state change txaction, e.g. "PAYMENT", "REFUND"

amountnumber

The amount of the transaction

currencystring

The currency of the transaction

referencestring

Merchant reference

ref1string

your reference 1

ref2string

your reference 2

ref3string

your reference 3

ref4string

your reference 4

vrfystring

This is a sha256 hash so the data can be verified. Generate sha256 hash of the string of sid;rcode;txid;status;amount;currency;txaction

Request

JavaScriptCurlPythonHTTP

const response = await fetch('<?=PROTOCOL?>://<?=SITE_DOMAIN?>/api/v1/index.php/{ptxid}/refund?sid=0&hash=text&timestamp=text&amount=text&currency=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200default

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