Refund (Void)

The Refund Transaction operation cancels an authorized transaction or refunds a captured transaction based on the status of the transaction.

You can provide a partial or complete refund. The amount field can take values equal to or less that the captured or authorized amount. If you do not specify an amount, a customer receives the complete refund.

The table below specifies the endpoint and request requirements for the operation:

Path NamePath Details
Endpoint[Velocity URL]/mpoint/refund
Request MethodPOST
Format/Content Typetext/xml
AuthenticationHTTP basic access authentication

Request

The following is an example of a Refund Transaction request:

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<refund client-id="[integer]">
		<transaction order-no="XCDFGG" id="1859798">
			<amount country-id="200">14000</amount>
			<external_claim_reference>ABCD1234</external_claim_reference>
		</transaction>
		<source>API</source>
	</refund>
</root>

The parameters are listed and defined in the table below:

ParameterTypeDescription
external_claim_referenceStringThe External Claim Reference number for refund request. Optional. Maximum length – 20 characters.
sourceStringThe source of refund request. Optional. Maximum length – 20 characters.

Response

The following is an example of a Refund Transaction response:

<?xml version="1.0" encoding="UTF-8"?>
<root>
	<status code="1000" />
</root>
<?xml version="1.0" encoding="UTF-8"?>
<root>
	<status code="1000" />
		<exception type="http">
			<code>400</code>
		</exception>
	</status>
</root>

📘

Note: If the status code is 1000, the refund is successful. Other rest response codes indicate a failure. Refer to Refund Payment Codes in 'Reference' for details.