A refund or authorization reversal can be submitted via the API using the /txns endpoint. You can look up additional information about the /txns endpoint in the API Reference.

How to submit a refund or void a payment via the API?

The process of submitting a card payment (sale) refund, an eCheck refund, and voiding an approved transaction is virtually the same. The only difference between these three options is the type value included in the request.

A partial or full refund/void is submitted in the API by sending a POST request to the /txns endpoint and including the Transaction ID of the payment that is being refunded/voided. By default, if no amount is set when submitting a refund/void via the API it will be a full refund for the entire amount of the original transaction.

{
	"fortxn": "t1_txn_5f6276c12269b0cc77adb44",
	"type": "5"
}

You can enter a partial amount to be refunded (amount values are in cents USD - in the code snippet shown below a $1.00 refund is shown).

{
	"fortxn": "t1_txn_5f6276c12269b0cc77adb44",
	"type": "5",
    "amount": "100"
}

At a minimum, the only fields required to submit a refund are:

fortxn - enter the Payrix Transaction ID (TXN ID) of the original payment you wish to refund.

type - In the case of a card payment refund this field should be set with the value “5”.

For eCheck refunds, the type field should be set to “8”.

To void an approved (but not captured/settled), the type should be set to “4”.

{
	"fortxn": "t1_txn_5f1841b4b1200ea4d1af843",
	"type": "4"
}

Other optional fields (e.g. fee, first (name), last (name) etc.) can be included in the API request, but they are not required for the refund to process successfully.

How to cancel an approved payment via the API?

As previously covered, the fundamental difference between voiding and canceling a payment is that canceling a transaction simply removes the approved payment from the Merchant’s daily batch, but does not actually reverse the authorization (as voiding does).

Therefore, in API terms voiding a payment more closely resembles a standard refund, but canceling a transaction fundamentally differs. To cancel an approved payment in the API, send a PUT request to the /txns endpoint and include the relevant Payrix Transaction ID (TXN ID) in the request string (i.e. PUT/txns/txn_ID). In the code body, simply send a request to nullify the batch associated with the approved payment.

{
	"batch": null
}