Request a partner invoice refund
Last updated: 08-May-2017
Rate this article:
Overview
Use this method to initiate a refund for a paid partner invoice.
Requirements
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/SOAP/02Authentication
require('PATH_TO_setPartner'); // setPartner example: https://knowledgecenter.avangate.com/Integration/Channel_Manager_API/SOAP/06Reference/Partner/00Set_partner
$proformaNumber = 'YOUR_PROFORMA_NUMBER';
$comment = 'YOUR_REFUND_REASON';
try {
$ProformaRefund= $client->requestProformaRefund ($sessionID, $proformaNumber, $comment);
} catch (SoapFault $e) {
Echo "RefundProforma: " . $e->getMessage();
exit;
}
var_dump ("RefundProforma ", $ProformaRefund);
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.. |
Rate this article:
