AuthorizationList
Retrieve All Authorizations via API for Easy Tracking
Purpose
This method fetches a list of created authorizations neither captured nor reversed.
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
Method Properties
Please note all properties must be in PascalCase!
| Property | Typical value | Type | Required | Description |
|---|---|---|---|---|
| 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”. |
Response Properties
| Property | Typical value | Type | Description |
|---|---|---|---|
| Amount | 23.45 | Double | The amount of the Authorization. |
| Currency | EUR | A(3) | The currency of the Authorization. |
| OrderID | 201203319999999 | String | The custom id provided by the merchant for the Authorization. |
| IPCTrnref | 12345678923 | String | Used to uniquely identify a transaction in IPC. Used as a parameter for a subsequent refund or reversal if needed. |
| Date | 2020-07-19 14:23:17.000 | Date | The date the Authorization was initiated. The format is YYYY-MM-DD HH:mm:ss.sss. |
Example request
New lines and tabulators are included for better reading and do not exist in the POST request.
IPCmethod=IPCAuthorizationList&
IPCVersion=1.4&
IPCLanguage=EN&
SID=000000000000010&
WalletNumber=61938166610&
KeyIndex=1&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817
Example response
XML
<ipc_response is-array="true">
<IPCmethod>IPCAuthorizationList</IPCmethod>
<Authorization>
<Date>2020-06-16 14:23:17.000</Date>
<IPCTrnref>97258</IPCTrnref>
<OrderID>2bfbe61a-6da2-459f-b91b-2ee754b2f255</OrderID>
<Amount>1.230</Amount>
<Currency>EUR</Currency>
</Authorization>
<Authorization>
<Date>2020-06-16 11:28:38.000</Date>
<IPCTrnref>97232</IPCTrnref>
<OrderID>1592295881</OrderID>
<Amount>11.000</Amount>
<Currency>EUR</Currency>
</Authorization>
<Authorization>
<Date>2020-06-16 10:35:17.000</Date>
<IPCTrnref>97220</IPCTrnref>
<OrderID>1592292707</OrderID>
<Amount>11.000</Amount>
<Currency>EUR</Currency>
</Authorization>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
<Signature>iorLkWxXLoRlSXwbTRLGLpUFFOnn95NITqv039dVAe2WW9jUxcx0Vp4bypKnyrAa0Abclo1BncLuQ5TLG8+SwH85TxVPz2IPOtL6o041/fBhruptNtvbeDvTfn0RCiXMVHcd7PqgDu96whbOAQdNKlpIuIavdXip4PwIAwvmHVE=</Signature>
</ipc_response>
JSON
{
"IPCmethod": "IPCAuthorizationList",
"Authorization": [
{
"Date": "2020-06-18 10:55:36.000",
"IPCTrnref": "97376",
"OrderID": "5df4e368-94bc-42d2-aa0f-0b6542a6ac0a",
"Amount": "1.230",
"Currency": "EUR"
},
{
"Date": "2020-06-16 17:02:14.000",
"IPCTrnref": "97278",
"OrderID": "1592315926",
"Amount": "43.000",
"Currency": "EUR"
},
{
"Date": "2020-06-16 11:28:38.000",
"IPCTrnref": "97232",
"OrderID": "1592295881",
"Amount": "11.000",
"Currency": "EUR"
},
{
"Date": "2020-06-16 10:35:17.000",
"IPCTrnref": "97220",
"OrderID": "1592292707",
"Amount": "11.000",
"Currency": "EUR"
}
],
"Status": 0,
"StatusMsg": "Success",
"Signature": "pAkIrj58uNmDrvZZmODsijqubig72ggCxD+ETXVza/iKomZRRrbX3TmvsoUSkVg+lJwiLXI0eCGkuzyzx+Q3y7/QOy4tZRXzIhedu1ZfaKhceR65wSe+2/drurb9CuO9G0aErOxiU/W8tW56TXrJUzCGhGSYwnk+z3SVTWmA8/0="
}