Create Reconciliation Rule

POST

https://api.mpay.com.au/receivables/v1/reconciliationrules/create

Use this API to create new reconciliation rules. Multiple entries for specific amounts can be created for an ABA or PayId. The system will automatically return payments if the payment details do not match one of the entries, or you can configure only the overpaid amount to be returned. In case there are duplicate entries, payment will be matched with the oldest active rule.

An optional Expiry Date Time can be specified for each rule. If expiry date is not provided, this will be defaulted as per pre-decided setup.

acceptstringGenerated from available response content types

bodyobject

200successful validation

400Bad Request - The request was invalid or could not be processed.

401Unauthorized - Authentication failed or was not provided.

500Internal Server Error - An unexpected error occurred while processing the request.

curl --request POST \
     --url https://api.mpay.com.au/receivables/v1/reconciliationrules/create \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
     "reconciliationRuleReference": "RR22348",
     "expiryDateTime": "2026-12-31T23:59:59",
     "bsb": "802-985",
     "accountNumber": "123456789",
     "payId": "[email protected]",
     "amount": 150,
     "minAmount": 100,
     "maxAmount": 200
     }'