Request a partner invoice refund

Overview

Use this method to initiate a refund for a paid partner invoice.

Requirements

This method requires you to set a specific partner using setPartner.

Parameters

Parameter	Type/Description
sessionID	Required (String)
	Session identifier, output of the Login method. An exception is thrown if the values are incorrect.
proformaNumber	Required (String)
	The unique identifier of a partner invoice from the Avangate system.
comment	Optional (String)
	Refund reason/additional comments. Can be NULL.

Response

Parameter	Type/Description
result	Boolean
	True or false

Request

<?php

require ('PATH_TO_AUTH');  // Authentication example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/02Authentication
require ('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/JSON-RPC/06Reference/Partner/00Set_partner

$proformaNumber = 'YOUR_PROFORMA_NUMBER';
$comment = 'YOUR_REFUND_REASON';

$jsonRpcRequest = array (
'jsonrpc' => '2.0',
'id' => $i++,
'method' => 'requestProformaRefund',
'params' => array($sessionID, $proformaNumber, $comment)
);
var_dump (callRPC((Object)$jsonRpcRequest,$host));

Errors

Error	Description
INVALID_PARTNER	No partner is set.
INVALID_PROFORMA_NUMBER	Your partner invoice number is not valid.
DUPLICATE_REFUND_REQUEST	A refund request was already placed for this partner invoice.
INVALID_PROFORMA	The partner invoice needs to be paid in order to send a refund request..