Purpose
This method is used by the merchant to register a mandate reference for direct withdrawal transactions (Request money) from a client’s myPOS account or to cancel a previously registered mandate reference. The merchant can register more than one mandate reference for each client. All mandate references are registered to a specific merchant’s myPOS account.
The myPOS Checkout API will return an XML with the result. This method is intended to be utilized by the merchant in his 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 |
|
Action |
1 |
N(1) |
YES |
1 – Registration of the MandateReference; 2 – Cancellation of a MandateReference |
|
MandateText |
This is what we agreed … |
String |
NO |
Text supplied from the merchant, so the client can easily identify the Mandate. |
|
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.
*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 |
Example of the XML response
<IPC_response>
<IPCmethod>IPCMandateManagement</IPCmethod>
<CustomerWalletNumber>61938166612</CustomerWalletNumber>
<MandateReference>126ca831-93d2-4dfc-ab1f-0cce1d0abe9e </MandateReference>
<Action>1</Action>
<Status>0</Status>
<StatusMsg>Success</StatusMsg>
</IPC_response>