Get PaymentStatus

Monitor Transaction Status Programmatically

Purpose

This method is used by Merchant to get the current status of a previously executed payment. The myPOS Checkout API will return an XML with detailed information about a specific OrderID. This method is intended to be utilized by the Merchant in their website back-end. The Merchant could decide whether or not to use this method.

Method Properties

Property	Typical value	Type	Required	Description
OrderID	201203319999999	String	YES	Placeholder for the merchant. Used to put some data that will help the merchant to refer payments to orders. Up to 80 characters.
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”.
get_declined_payments	1	String	NO	Set to "1" to include declined payments information in the response. If not specified, declined payments will not be returned.

Response Properties

Property	Typical value	Type	Description
OrderID	201203319999999	String	Placeholder for the merchant. Used to put some data that will help the merchant to refer payments to orders. Up to 80 characters.
PaymentMethod	1	N(1)	(Conditional) If a property is not sent, the customer is redirected to a myPOS Hosted payment page with selection of all payment methods myPOS Checkout supports; 1 – Redirects the customer to a card-only checkout; 2 – Redirects the customer to iDEAL-only checkout.
PaymentStatus	1	N(1)	1 – Successful payment; 2 – Pending payment; 3 – Unsuccessful payment; 4 – Reversed payment
PaymentReference	MTCOR0123456XXK7	String	Payment Reference of the transaction
Amount	50.00	Double	The transaction amount.
Currency	EUR	A(3)	ISO 3-character currency code.
IPC_Trnref	131753	String	Unique IPC transaction reference.
DateTime	2020-10-01 14:26:52	String	Timestamp of the transaction.
FeeAmount	1.60	Double	Fee amount applied to the transaction.
Status	0	N(1)	0 = Success; other values indicate an error.
StatusMsg	Success	String	Message describing the status.
Signature	(Encrypted)	String	Security signature to verify the response integrity.

Example Of The Request

Request:
    (
    [IPCmethod] => IPCGetPaymentStatus
    [IPCVersion] => 1.4
    [SID] => 228543
    [KeyIndex] => 1
    [walletnumber] => 40484123613
    [OrderID] => 1768489640
    [OutputFormat] => xml
    [get_declined_payments] => 1
    [Signature] => MfZ0UDKnyoHD8pr5+nFVBbiCKKpVmdkDIFFr7aPwFR1sSXjB+wgm5cZyto1uXn30V90PL/75pL7IV2aI2y6JvZufWYu/cewH6BxjPbfm9pLqnXZBsC5dEvlf9nZPVG8cdnsteSHJ7DOwsUaTQMDAXSojNVi+KU3xi5Upg1ppwts=
)

Example Of The XML Response

<ipc_response>
    <IPCMethod>IPCGetPaymentStatus</IPCMethod>
    <OrderID>1601551599</OrderID>
    <PaymentStatus>1</PaymentStatus>
    <Amount>50.00</Amount>
    <Currency>EUR</Currency>
    <IPC_Trnref>131753</IPC_Trnref>
    <PaymentReference>MTCOR0124565XXK7</PaymentReference>
    <DateTime>2020-10-01 14:26:52</DateTime>
    <FeeAmount>1.60</FeeAmount>
    <Status>0</Status>
    <StatusMsg>Success</StatusMsg>
    <Signature>DJTrVxmxD/TCW52T1K0g6g9rptt1nM6Af1JvsPAoXg8JBWGDB/GG362y+Co4it0/ckwr4RjY1VrTiD2ZOO1s56UpeMtLLJM9EtwYcwZmzgyhooUvPx04W3wuH0qJ+HRC6nWIbE+lo45M1H/yyaM/Qq5smqg/+g+zOIM/1stO67g=</Signature>
</ipc_response>

Example Of The JSON Response (with DeclinedPayments)

{
  "IPCMethod": "IPCGetPaymentStatus",
  "DeclinedPayments": [
    {
      "responseCode": "14",
      "responseCodeDescription": "Invalid card number"
    }
  ],
  "OrderID": "1768489640",
  "PaymentStatus": 2,
  "Amount": 3,
  "Currency": "EUR",
  "IPC_Trnref": 380006,
  "PaymentReference": "",
  "DateTime": "2026-01-15T17:07:35",
  "FeeAmount": "",
  "Status": 0,
  "StatusMsg": "Success",
  "Signature": "iI2xNXIM5x7Tq+5D0oARS4mTzkvRlunck6XBnrWSm5CC20kr7+ayuhCUZqGtqbm6W3KEYSRqVvYo7NOLVQHJCWZ1gXMGPRxzc+8iqhmjubo0HXrbdTxgwFnxJD3txxjYGjqsLVUnxFZfY0+T0FTqeIxjzYnTUbudFN7kKcOI5l8="
}