Request Money

Generate and Send Payment Requests Programmatically

Purpose

This method is used by the merchant to initiate a direct withdrawal transaction from a client’s myPOS account. The mandate with the client must be registered within the myPOS system prior to initiation of the call IPCRequestMoney. Each client’s mandate reference must be registered via the call IPCMandateManagement.

The merchant must have fully signed a contract with myPOS for the service in order to be able to use this call.

The myPOS Checkout API will return an XML with the result. This method is intended to be utilized by the merchant in their website back-end.

Method Properties

Property	Typical value	Type	Required	Description
MandateReference	126ca831-93d2-4dfc-ab1f-0cce1d0abe9e	String	YES	A unique identifier of the agreement (mandate) between the merchant and the client (debtor). Up to 127 characters.
CustomerWalletNumber	61938166612	AN(11)	YES	Identifier of the client’s (debtor’s) myPOS account
OrderID	201203319999999	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.
ReversalIndicator	1	N(1)	NO	Used only if there is a system error or no response was received. The Merchant must submit the same data with IPCRequestMoney method including this parameter with value = 1 (Reversal of the previously executed Request money transaction).
Amount	23.45	N(18,2)	YES	The amount of the payment requested.
Currency	EUR	A(3)	YES	ISO 3-character currency code.
Reason	Invoice num 123456	String	YES	The reason for the transfer.
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.

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

Example of the XML Response

<IPC_response>
    <IPCmethod>IPCRequestMoney</IPCmethod>
    <MandateReference>126ca831-93d2-4dfc-ab1f-0cce1d0abe9e</MandateReference>
    <CustomerWalletNumber>61938166612</CustomerWalletNumber>
    <IPC_Trnref>12345678923</IPC_Trnref>
    <ReversalIndicator></ReversalIndicator>
    <Amount>23.45</Amount>
    <Currency>EUR</Currency>
    <Status>0</Status>
    <StatusMsg>Success</StatusMsg>
</IPC_response>

Handling Reversals

In case of system error or missing response, the merchant must call the method IPCRequestMoney with ReversalIndicator included. The reversal of the transaction can be processed if there is enough money at the merchant’s account.