Quick Start Guide

Refund Transaction 2018-01-15T18:05:32+00:00

Refund Transaction

If you have a transaction that needs to be reversed but can no longer be voided because it has been settled you would use the refund call. Below is an example of a basic refund request.

Building Your Refund Request

Parameter Description Values Example Value
API Operation
requestType Specifies the type of operation to be performed. In this example we are focusing on sale transaction operations. Values refund
https://sandbox-secure.ziftpay.com/gates/xurl?requestType=refund&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&referenceNumber=9198951
Authentication
username Username for your API user account. NOTE: This is not the same as your merchant portal account. String api-user-1234
password Password for your API user account. String mypass1234
https://sandbox-secure.ziftpay.com/gates/xurl?requestType=refund&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&referenceNumber=9198951
Merchant Context
merchantAccountCode Specifies which merchant account to use for this transaction. Your API user may be associated with more than one merchantAccountCode. String 21234
https://sandbox-secure.ziftpay.com/gates/xurl?requestType=refund&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&referenceNumber=9198951
Transaction Details
referenceNumber This values comes back as part of the original sale transaction API request or in the HPP callback request String 9198951
https://sandbox-secure.ziftpay.com/gates/xurl?requestType=refund&userName=api-user-1234&password=mypass1234
&merchantAccountCode=21234&referenceNumber=9198951