Purpose

 

This method fetches the status of a pre-authorization made for a customer.

myPOS Checkout API will check for:

  • Valid myPOS Account number (also referred to as Client number)
  • Valid Checkout 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.

 

  

Response properties

Property

Typical value

Type

Description

OrderID

201203319999999

String

Echo from IPCPreAuthStatus

IPCPreAuthStatus

1

Integer

The status of the Pre-authorization. Available values:


1 - Pending

3 - Captured

4 - Declined

5 - Reversed

6 - Cancelled

PreAuthExpDate

19/07/2020

Date

The expiry date in format DD/MM/YYYY.

 

Example request

New lines and tabulators are included for better reading and do not exist in the POST request.

 

IPCmethod=IPCPreAuthStatus&
IPCVersion=1.4&
IPCLanguage=EN&
SID=000000000000010&
WalletNumber=61938166610&
OrderID=f0681e18-f529-4c56-b50f-712bf30738e2&
KeyIndex=1&
Signature=TuQ6nQJxWJ2T+sM6uzBqYYtOWdw+0ecHaRzujTJChWds/1HWK+kCcfKrAW9sN8xzsRBSZ2zH1uPMMIMgB3XqqHNbq06YhpD3XY/Ltp+ooc8xoq1jdajnUexC5JuDzTslCMKKFmW5vl0HsEkPltyxir0Z5AWpgOZkjqCPEr817

 

Example response

<ipc_response is-array="true">
    <IPCmethod>IPCPreAuthStatus</IPCmethod>
    <OrderID>f0681e18-f529-4c56-b50f-712bf30738e2</OrderID>
    <PreAuthExpDate>19/07/2020</PreAuthExpDate>
    <IPCPreAuthStatus>1</IPCPreAuthStatus>
    <Status>0</Status>
    <StatusMsg>Success</StatusMsg>
    <Signature>XOtcux7fMdl8CIzwlsSsNwS1e+XGU8RC23I32p2ciZEywsb0eBmPs8Ji1wFPDVZXrn5R3ScXIN2mhEhFkwoqs2vgiN1Yl97fvE9gJ55KxKXusoXz4kNGc4tTLm49FcRwoPAZ9ysDDFA/vbkIxaRwpJKYX0dQnyMtKQAzldeN/oE=</Signature>
</ipc_response>
{
    "IPCmethod": "IPCPreAuthStatus",
    "OrderId": "f0681e18-f529-4c56-b50f-712bf30738e2",
    "PreAuthExpDate": "19/07/2020",
    "IPCPreAuthStatus": "1",
    "Status": 0,
    "StatusMsg": "Success",
    "Signature": "XOtcux7fMdl8CIzwlsSsNwS1e+XGU8RC23I32p2ciZEywsb0eBmPs8Ji1wFPDVZXrn5R3ScXIN2mhEhFkwoqs2vgiN1Yl97fvE9gJ55KxKXusoXz4kNGc4tTLm49FcRwoPAZ9ysDDFA/vbkIxaRwpJKYX0dQnyMtKQAzldeN/oE="
}