Purpose
This method is used by the Merchant to initiate a refund of a previously executed payment. The myPOS Checkout API will return an XML with the result. This method is intended to be utilized by the Merchant in his website back-end. The Merchant could decide whether or not to use this method.
Method Properties
|
Property |
Typical value |
Type |
Required |
Description |
|---|---|---|---|---|
|
IPC_Trnref |
12345678923 |
String |
YES |
Used to uniquely identify a transaction in IPC. Used as a parameter for subsequent refund or reversal if needed. |
|
OrderID |
201203319999999 |
String |
NO |
Placeholder for the merchant. Used to put some data that will help the merchant to recognize for which order is the payment. Up to 255 characters. |
|
Amount |
23.45 |
Double |
YES |
The amount of the payment requested. |
|
Currency |
EUR |
A(3) |
YES |
ISO 3-character currency code. The currency for the payment should be registered and approved. |
|
OutputFormat |
XML |
String |
NO |
The output format of data. The property can be “XML” or “JSON”. If it is not specified in the request, the default value is “XML”. |
Response Properties
|
Property |
Typical value |
Type |
Required |
Description |
|---|---|---|---|---|
|
IPC_Trnref |
12345678923 |
String |
YES |
Used to uniquely identify a transaction in IPC. Used as a parameter for subsequent refund or reversal if needed. |
|
Amount |
23.45 |
Double |
YES |
The amount of the payment requested. |
|
Currency |
EUR |
A(3) |
YES |
ISO 3-character currency code. The currency for the payment should be registered and approved. |
Example Of The XML Response
<IPC_response>
<IPCmethod>IPCRefund</IPCmethod>
<IPC_Trnref>12345678923</IPC_Trnref>
<Amount>23.45</Amount>
<Currency>EUR</Currency>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>
