This API can be used to search for a list of reconciliation rules. The maximum date range returned is one month. If End Date is not provided, the system will return records for the day specified in Start Date.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "dateTime", "type": "string", "example": "2026-07-01", "description": "The start date for the search. Date format should be 'yyyy-MM-dd' format.
", "default": "2026-07-01", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "endDate", "type": "string", "example": "2026-07-31", "description": "Optional - If not provided we will provide data for the day specified in Start Date. Maximum range allowed is 1 month.
", "default": "2026-07-31", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, { "kind": "optional", "name": "status", "type": "string", "example": "Received", "description": "Optional - The status of the reconciliation rule to filter the results by.
", "default": "Received", "pattern": "^(Received|InProgress|Expired|Processed|Cancelled)$" }, { "kind": "optional", "name": "payId", "type": "string", "example": "payid@example.com", "description": "Optional - The associated PayID. string <= 256 characters.
", "default": "payid@example.com", "pattern": "^.{1,256}$" }, { "kind": "optional", "name": "aba", "type": "string", "example": "802985123456789", "description": "Optional - Number combination of BSB + Account number with any special characters removed, for example 802985123456789.
", "default": "802985123456789", "pattern": "^\\d{9,20}$" }, { "kind": "optional", "name": "pageNumber", "type": "string", "example": "1", "description": "Optional - If not provided, it is defaulted to 1.
", "default": "1", "pattern": "^\\d+$" }, { "kind": "optional", "name": "pageSize", "type": "string", "example": "50", "description": "Optional - If not provided, page size will be defaulted to 50 (Configuration). Maximum allowed is 200 (Configuration).
", "default": "50", "pattern": "^\\d+$" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "basicAuth", "name": "basicAuth", "kind": "optional", "type": "http", "description": "To authenticate using basic authentication, generate an API key and pass it as the username. No password is required.
", "scheme": "basic" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful validation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "searchReconciliationRulesResponse", "schema": [ { "name": "reconciliationRules", "kind": "optional", "type": "array", "description": "The list of reconciliation rules matching the search criteria.", "modelRef": "#/components/schemas/reconciliationRuleDetails", "customType": "reconciliationRuleDetails[]", "schema": [ { "name": "reconciliationRuleReference", "kind": "optional", "type": "string", "description": "A unique reference used to identify the reconciliation rule. Unique to your mAccount.", "example": "RR22348", "default": "RR22348", "pattern": "^[A-Za-z0-9\\-_]{1,50}$" }, { "name": "expiryDateTime", "kind": "optional", "type": "string", "description": "The datetime the reconciliation rule will expire.", "example": "2026-12-31T23:59:59", "default": "2026-12-31T23:59:59", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}$" }, { "name": "bsb", "kind": "optional", "type": "string", "description": "The BSB of the associated Automatcher.", "example": "802-985", "default": "802-985", "pattern": "^\\d{3}-\\d{3}$" }, { "name": "accountNumber", "kind": "optional", "type": "string", "description": "The account number of the associated Automatcher.", "example": "123456789", "default": "123456789", "pattern": "^\\d{5,10}$" }, { "name": "payId", "kind": "optional", "type": "string", "description": "The associated PayID.", "example": "payid@example.com", "default": "payid@example.com", "pattern": "^.{1,256}$" }, { "name": "amount", "kind": "optional", "type": "string", "description": "The amount. The exact payment amount the rule matches.", "example": "150.00", "default": "150.00", "pattern": "^\\d+(\\.\\d{1,2})?$" }, { "name": "minAmount", "kind": "optional", "type": "string", "description": "Optional. The minimum amount to be matched by the reconciliation rule. Lower bound (inclusive) of the acceptable payment amount range. Must be less than or equal to maxAmount.
Optional. The maximum amount to be matched by the reconciliation rule. Upper bound (inclusive) of the acceptable payment amount range. Must be greater than or equal to minAmount.
The account number of the associated ledger, if applicable.
", "example": "221100334", "default": "221100334", "pattern": "^\\d{5,10}$" }, { "name": "ledgerUniqueReference", "kind": "optional", "type": "string", "description": "The unique reference of the associated ledger, if applicable.
", "example": "ledger-000222", "default": "ledger-000222", "pattern": "^[A-Za-z0-9\\-_]{1,50}$" }, { "name": "refundDetails", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/refundDetails", "customType": "refundDetails", "schema": [ { "name": "inboundAmount", "kind": "optional", "type": "string", "description": "Amount received.", "example": "150.00", "default": "150.00", "pattern": "^\\d+(\\.\\d{1,2})?$" }, { "name": "refundAmount", "kind": "optional", "type": "string", "description": "Amount refunded.", "example": "50.00", "default": "50.00", "pattern": "^\\d+(\\.\\d{1,2})?$" }, { "name": "refundId", "kind": "optional", "type": "string", "description": "Unique ID of the refund request.", "example": "REF-000999", "default": "REF-000999", "pattern": "^[A-Za-z0-9\\-]+$" } ] } ] }, { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 12, "default": 12, "pattern": "^\\d+$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors.", "example": "Ok", "default": "Ok", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "This is a description of the status. If an 'Ok' status is returned, then this will be 'Operation completed successfully'.
", "example": "Operation completed successfully", "default": "Operation completed successfully", "pattern": "^.+$" } ], "modelRef": "#/components/schemas/searchReconciliationRulesResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request - The request was invalid or could not be processed.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 8, "default": 8, "pattern": "^\\d+$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code other than 'Ok' indicates the request did not succeed.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "This is a description of the status, providing detail about why the request did not succeed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.+$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail", "customType": "errorDetail[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "A machine-readable code identifying the specific error.
", "example": "InvalidRequest", "default": "InvalidRequest", "pattern": "^[A-Za-z0-9_]+$" }, { "name": "message", "kind": "optional", "type": "string", "description": "A human-readable description of the specific error.
", "example": "The field 'bsb' is invalid.", "default": "The field 'bsb' is invalid.", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized - Authentication failed or was not provided.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 8, "default": 8, "pattern": "^\\d+$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code other than 'Ok' indicates the request did not succeed.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "This is a description of the status, providing detail about why the request did not succeed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.+$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail", "customType": "errorDetail[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "A machine-readable code identifying the specific error.
", "example": "InvalidRequest", "default": "InvalidRequest", "pattern": "^[A-Za-z0-9_]+$" }, { "name": "message", "kind": "optional", "type": "string", "description": "A human-readable description of the specific error.
", "example": "The field 'bsb' is invalid.", "default": "The field 'bsb' is invalid.", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error - An unexpected error occurred while processing the request.
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "errorResponse", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request.", "example": 8, "default": 8, "pattern": "^\\d+$" }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code other than 'Ok' indicates the request did not succeed.", "example": "Fail", "default": "Fail", "pattern": "^[A-Za-z]+$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "This is a description of the status, providing detail about why the request did not succeed.
", "example": "One or more validation errors occurred.", "default": "One or more validation errors occurred.", "pattern": "^.+$" }, { "name": "errors", "kind": "optional", "type": "array", "description": "A list of the individual errors that caused the request to fail.", "modelRef": "#/components/schemas/errorDetail", "customType": "errorDetail[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "A machine-readable code identifying the specific error.
", "example": "InvalidRequest", "default": "InvalidRequest", "pattern": "^[A-Za-z0-9_]+$" }, { "name": "message", "kind": "optional", "type": "string", "description": "A human-readable description of the specific error.
", "example": "The field 'bsb' is invalid.", "default": "The field 'bsb' is invalid.", "pattern": "^.+$" } ] } ], "modelRef": "#/components/schemas/errorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "Y8vYIUCxWAudmR2uJ6_j6", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.mpay.com.au/receivables/v1/reconciliationrules/list/{dateTime}?endDate=2026-07-31&status=Received&payId=payid%40example.com&aba=802985123456789&pageNumber=1&pageSize=50' \\\n --header 'accept: application/json'" }, { "id": "o6FYDUCAszdGsGOc_FCB4", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/receivables/v1/reconciliationrules/list/{dateTime}?endDate=2026-07-31&status=Received&payId=payid@example.com&aba=802985123456789&pageNumber=1&pageSize=50\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "WQzP8nAQP7Wdva8HrTTm6", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/receivables/v1/reconciliationrules/list/{dateTime}?endDate=2026-07-31&status=Received&payId=payid@example.com&aba=802985123456789&pageNumber=1&pageSize=50\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "PrMOBr12M2udiyaCRLYEu", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/receivables/v1/reconciliationrules/list/{dateTime}?endDate=2026-07-31&status=Received&payId=payid@example.com&aba=802985123456789&pageNumber=1&pageSize=50\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "Y8vYIUCxWAudmR2uJ6_j6" }, "results": { "languages": [ { "id": "3zBzZnUnLqYdJTTLm_2u6", "language": "200", "code": "// successful validation\n{\n \"reconciliationRules\": [\n {\n \"reconciliationRuleReference\": \"RR22348\",\n \"expiryDateTime\": \"2026-12-31T23:59:59\",\n \"bsb\": \"802-985\",\n \"accountNumber\": \"123456789\",\n \"payId\": \"payid@example.com\",\n \"amount\": \"150.00\",\n \"minAmount\": \"100.00\",\n \"maxAmount\": \"200.00\",\n \"processedAmount\": \"150.00\",\n \"createdDateTime\": \"2026-07-01T09:15:00\",\n \"updatedDateTime\": \"2026-07-05T14:30:00\",\n \"processedDateTime\": \"2026-07-10T11:00:00\",\n \"transactionId\": \"N001234567890\",\n \"transactionType\": \"NPP\",\n \"status\": \"Processed\",\n \"ledgerAccountNumber\": \"221100334\",\n \"ledgerUniqueReference\": \"ledger-000222\",\n \"refundDetails\": {\n \"inboundAmount\": \"150.00\",\n \"refundAmount\": \"50.00\",\n \"refundId\": \"REF-000999\"\n }\n }\n ],\n \"durationMs\": 12,\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "i-sGdp8Da5ApiWZzgbQQs", "language": "400", "code": "// Bad Request - The request was invalid or could not be processed.\n{\n \"durationMs\": 8,\n \"status\": \"Fail\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The field 'bsb' is invalid.\"\n }\n ]\n}" }, { "id": "jNoPxczYYnkFoPT7z-RD0", "language": "401", "code": "// Unauthorized - Authentication failed or was not provided.\n{\n \"durationMs\": 8,\n \"status\": \"Fail\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The field 'bsb' is invalid.\"\n }\n ]\n}" }, { "id": "2_dpqxcCR_nB9cYQ0J5vv", "language": "500", "code": "// Internal Server Error - An unexpected error occurred while processing the request.\n{\n \"durationMs\": 8,\n \"status\": \"Fail\",\n \"statusDescription\": \"One or more validation errors occurred.\",\n \"errors\": [\n {\n \"code\": \"InvalidRequest\",\n \"message\": \"The field 'bsb' is invalid.\"\n }\n ]\n}" } ], "selectedLanguageId": "3zBzZnUnLqYdJTTLm_2u6" } }, "children": [ { "text": "" } ] }