This page explains the MerchantReferenceFormat API field used for reconciliation.
Merchants may choose to provide payee details that will assist in their bank account reconciliation. The payee particulars, payee code and payee reference details may then be provided in the merchant reference. Those details will then be inserted into the corresponding payee fields on the merchant’s bank statement. If the payee details are provided, they must be passed in the MerchantReference field in the following pipe delimited format:
<payee particulars> | <payee code> | <payee reference> | <other merchant reference>
The first three fields must be provided in this format and if this is not the case then the existing process will be assumed, resulting in NO population on the merchant's bank statement. Where no value is available the merchant is to provide that placeholder with nothing in it.
The other merchant reference section can be used to control what the user sees on the Reference field of the POLi transaction screen and this is not to be confused with the reference on bank statements.
If a field contains more than the allowed number of characters it will be truncated. The allowable number of characters is 12 characters per field, inclusive of spaces.
The MerchantReferenceFormat field is passed in the Initiate Transaction Request to allow the merchant to select the reconciliation formatting option (1 through 4).
| Merchant Reference Format | Description | Example |
|---|---|---|
| 1 | Free format i.e. a one to one mapping of the merchant supplied reconciliation data to the Pay Anyone fields. | CustPartic | CustCode | CustRef | Order123 |
| 2 | The POLi ID to be mapped to the Payee Particulars field and the merchant supplied data (if any) to be mapped to the Payee Code and Payee Reference field. | | CustCode | CustRef | Order123 |
| 3 | The POLi ID to be mapped to the Payee Code field and the merchant supplied data (if any) to be mapped to the Payee Particulars and Payee Reference field. | CustPartic | | CustRef | Order123 |
| 4 | The POLi ID to be mapped to the Payee Reference field and the merchant supplied data (if any) to be mapped to the Payee Particulars and Payee Code. | CustPartic | CustCode | | Order123 |
If MerchantReferenceFormat is not passed in the InitiateTransaction request or a value other than 1 to 4, then the payee fields will not be populated using the MerchantReference field data. Any data in the MerchantReference field will then be displayed in the POLi pages as received.
Additionally, the POLi ID alone will be mapped to the Particulars bank field along side the amount, with no data displayed within the Code or Reference bank fields.