AuthorizationReverse
Programmatically Reverse a Pending Authorization
Purpose
This method cancels an authorization and releases the amount from the client's card.
myPOS Checkout API will check for:
- Valid myPOS Account number (also referred to as Client number)
- Valid Checkout Store ID (SID) corresponding with this myPOS Account number
- Valid status of the Checkout (enabled)
- Valid KeyIndex & corresponding Signature
- Valid OrderID
Method Properties
Please note all properties must be in PascalCase!
| Property | Typical value | Type | Required | Description |
|---|---|---|---|---|
| OrderID | 20120331999999 | String | YES | Placeholder for the merchant. Used to put some data that will help the merchant to recognize for which order is the payment. Up to 80 characters. |
| SID | 000000000000010 | String | YES | Store ID (SID) - Reference number for the Merchant Checkout in the myPOS system |
| WalletNumber | 61938166610 | String | YES | myPOS Client Number |
| KeyIndex | 1 | Int | YES | Indicates which key pair is being used. |
| OutputFormat | XML | String | NO | 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 | Description |
|---|---|---|---|
| OrderID | 201203319999999 | String | Echo from IPCAuthorizationReverse |
| Status | 0 | Int | 0 = Success; non-zero indicates an error. |
| StatusMsg | Success | String | Human-readable message for the transaction result. |
| Signature | (Base64 encoded) | String | Use this to verify the authenticity of the response. |
Example request
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCAuthorizationReverse&
IPCVersion=1.4&
IPCLanguage=EN&
SID=b1244363-6b36-47a3-812d-57125e791d50&
WalletNumber=61938166610&
OrderID=20120331999999&
KeyIndex=1&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817
Example response
XML
<ipc_response is-array="true">
<IPCmethod>IPCAuthorizationReverse</IPCmethod>
<OrderID>b1244363-6b36-47a3-812d-57125e791d50</OrderID>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
<Signature>GrIn+cjR2c+j7AfA7N4McdAejU5618S/+aHOYU78la1aNii6mHatmFP3zzvgB3UK+j5zz6ybJJD0F0CHKpBlZb00Zj1TciBrNxKqDxLkmfRuPamiYKRHTCnQ2Sxo2IxppMVWWg5Zg4TV6EXPJ99fjimlKfkmfl1bPpzDZ9JcVLo=</Signature>
</ipc_response>
JSON
{
"IPCmethod": "IPCAuthorizationReverse",
"OrderID": "5df4e368-94bc-42d2-aa0f-0b6542a6ac0a",
"Status": 0,
"StatusMsg": "Success",
"Signature": "Eesba4zGWiNPF+um/Oci1MwqNJndGuFoRRISfT7RwWRzy3Vu34PP6sdHLTdLaOHEDUGSA0vwiqunmvX8CHXZKDPXTA5dVH2OnXowaMafOWdtUmQMTLmbLpwBNUB+r1sU8kPKkXje8fIPY7Cu8ro0n9JGQax4JGLtT1xAcfbO6MQ="
}