Purpose
This method is used by the Merchant to initiate a reversal 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. |
|
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”. |
Partner Identification
If you are part of our Partners Program, you will need to submit these two additional parameters with each of your requests to the API. This will provide you with analytics about the usage in your myPOS Partners Portal account and help our support teams assist you better.
*Note - This requires you to set the API version of your requests to 1.4.1. No other changes in the code/requests are necessary.
|
Property |
Typical value |
Type |
Description |
|---|---|---|---|
|
PartnerID |
mps-p-XXXXXXXX |
String |
Identical number for the partner |
|
ApplicationID |
mps-app-XXXXXXXX |
String |
Identical number for the application |
Response Properties
|
Property |
Typical value |
Type |
Required |
Description |
|---|---|---|---|---|
|
IPC_Trnref |
12345678923 |
String |
YES |
Used to uniquely identify a transaction in IPC. |
Example Of The XML Response
<IPC_response>
<IPCmethod>IPCReversal</IPCmethod>
<IPC_Trnref>12345678923</IPC_Trnref>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>
