--- title: Retrieve Transactions for a Ledger slug: api/retrieve-transactions-for-a-ledger docTags: createdAt: 2026-08-20T02:00:14.436Z --- { "id": "l1wTepDL1z3eQifpS8mMJ", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.mpay.com.au/ledger/v1/transactions", "servers": [ { "url": "https://api.mpay.com.au/ledger/v1/transactions", "description": "Production URL" }, { "url": "https://api.m-pay.com.au/ledger/v1/transactions", "description": "Sandbox URL" } ], "name": "Retrieve Transactions for a Ledger", "description": "

Return the transactions for a ledger account between two dates. This endpoint returns an array of transaction line items along with a running balance.

\n

The query can be customised to order, skip and fetch as many records as required. Paging is controlled using the skip and take attributes. By default, the query will return the last months records in descending order.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "", "customType": "ledgerTransactionRequestDetails_V1", "schema": [ { "name": "ledgerAccountNumber", "kind": "optional", "type": "string", "description": "

Optional. Leave this field blank to retrieve all ledger accounts with transactions between the specified start and end dates.

", "example": "200000001", "default": "200000001", "pattern": "^[0-9]{6,12}$" }, { "name": "startDate", "kind": "optional", "type": "string", "description": "

Optional. Start date for the transaction query. Defaults to one month earlier than the current date.

", "example": "2026-06-23", "default": "2026-06-23", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2})?$" }, { "name": "endDate", "kind": "optional", "type": "string", "description": "

Optional. End date for the transaction query. Defaults to today's date.

", "example": "2026-07-23", "default": "2026-07-23", "pattern": "^\\d{4}-\\d{2}-\\d{2}(T\\d{2}:\\d{2}:\\d{2})?$" }, { "name": "skip", "kind": "optional", "type": "string", "description": "

Optional. Number of records to skip. 0 is the first record.

", "example": "0", "default": "0", "pattern": "^[0-9]+$" }, { "name": "take", "kind": "optional", "type": "string", "description": "

Optional. Number of records to take. If take is 0 then all records will be returned.

", "example": "50", "default": "50", "pattern": "^[0-9]+$" }, { "name": "descending", "kind": "optional", "type": "string", "description": "

Optional. Sort the returned transaction list in descending order. Defaults to true.

", "example": "true", "default": "true", "pattern": "^(true|false)$" }, { "name": "useTime", "kind": "optional", "type": "string", "description": "

Optional. Whether to use the time component of startDate and endDate in the selection.

", "example": "false", "default": "false", "pattern": "^(true|false)$" } ], "modelRef": "#/components/schemas/ledgerTransactionRequestDetails_V1", "isExpanded": true } ], "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 response.", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ledgerTransactionsResponse_V1", "schema": [ { "name": "ledgerAccounts", "kind": "optional", "type": "array", "description": "

Optional. The list of ledger accounts and their transactions for the queried period.

", "modelRef": "#/components/schemas/ledgerTransactionAccountItem_V1", "customType": "ledgerTransactionAccountItem_V1[]", "schema": [ { "name": "ledgerAccountNumber", "kind": "optional", "type": "string", "description": "The unique identifier for the ledger account.", "example": "200000001", "default": "200000001", "pattern": "^[0-9]{6,12}$" }, { "name": "ledgerUniqueReference", "kind": "optional", "type": "string", "description": "

Optional. Your unique identifier for the ledger account.

", "example": "CUST-000123", "default": "CUST-000123", "pattern": "^.{1,50}$" }, { "name": "description", "kind": "optional", "type": "string", "description": "

Optional. A free text field describing the ledger account.

", "example": "Primary settlement ledger for Acme Pty Ltd", "default": "Primary settlement ledger for Acme Pty Ltd", "pattern": "^.{0,255}$" }, { "name": "name", "kind": "optional", "type": "string", "description": "

Optional. Your alias for the ledger account. Can be used to identify a ledger or underlying customer.

", "example": "Acme Pty Ltd", "default": "Acme Pty Ltd", "pattern": "^.{1,140}$" }, { "name": "createdDateTime", "kind": "optional", "type": "string", "description": "The datetime the ledger was created.", "example": "2026-07-23T13:55:59", "default": "2026-07-23T13:55:59", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?$" }, { "name": "closedDateTime", "kind": "optional", "type": "string", "description": "

Conditional. The datetime the ledger was closed. Present only if the ledger has been closed.

", "example": "2026-07-23T13:55:59", "default": "2026-07-23T13:55:59", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?$" }, { "name": "isClosed", "kind": "optional", "type": "string", "description": "Indicates whether the ledger is closed.", "example": "false", "default": "false", "pattern": "^(true|false)$" }, { "name": "openingBalance", "kind": "optional", "type": "string", "description": "Opening balance for the time period queried.", "example": "100.00", "default": "100.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "closingBalance", "kind": "optional", "type": "string", "description": "Closing balance for the time period queried.", "example": "150.00", "default": "150.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "totalDebits", "kind": "optional", "type": "string", "description": "Total value of debits incurred for the time period queried.", "example": "50.00", "default": "50.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "totalCredits", "kind": "optional", "type": "string", "description": "Total value of credits incurred for the time period queried.", "example": "100.00", "default": "100.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "transactionLineItems", "kind": "optional", "type": "array", "description": "

Optional. The individual transaction line items for the ledger account.

", "modelRef": "#/components/schemas/ledgerTransactionLineItem", "customType": "ledgerTransactionLineItem[]", "schema": [ { "name": "rowOrder", "kind": "optional", "type": "string", "description": "Order of the transaction in the returned records.", "example": "1", "default": "1", "pattern": "^[0-9]+$" }, { "name": "mPaymentsId", "kind": "optional", "type": "string", "description": "Unique ID issued by Monoova for the transaction.", "example": "1234567", "default": "1234567", "pattern": "^[0-9]+$" }, { "name": "transactionId", "kind": "optional", "type": "string", "description": "This is the transactionId that was returned when the transaction was executed.", "example": "7654321", "default": "7654321", "pattern": "^[0-9]+$" }, { "name": "dateTime", "kind": "optional", "type": "string", "description": "Datetime of the transaction.", "example": "2026-07-23T13:55:59", "default": "2026-07-23T13:55:59", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?$" }, { "name": "mAccountName", "kind": "optional", "type": "string", "description": "Name of the parent mAccount receiving or initiating the transaction.", "example": "Acme Pty Ltd", "default": "Acme Pty Ltd", "pattern": "^.{1,140}$" }, { "name": "transactionType", "kind": "optional", "type": "string", "description": "Transaction type or payment rail.", "example": "NPP", "default": "NPP", "pattern": "^.{1,50}$" }, { "name": "subTransactionType", "kind": "optional", "type": "string", "description": "

Optional. Transaction sub type.

", "example": "CreditTransfer", "default": "CreditTransfer", "pattern": "^.{1,50}$" }, { "name": "credit", "kind": "optional", "type": "string", "description": "

Conditional. Credit amount of the transaction. Present when the transaction is a credit.

", "example": "100.00", "default": "100.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "debit", "kind": "optional", "type": "string", "description": "

Conditional. Debit amount of the transaction. Present when the transaction is a debit.

", "example": "50.00", "default": "50.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "runningBalance", "kind": "optional", "type": "string", "description": "Balance at the time the transaction was executed.", "example": "150.00", "default": "150.00", "pattern": "^-?[0-9]+(\\.[0-9]{1,2})?$" }, { "name": "description", "kind": "optional", "type": "string", "description": "

Optional. Description of the transaction.

", "example": "Payment received from Acme Pty Ltd", "default": "Payment received from Acme Pty Ltd", "pattern": "^.{0,255}$" } ] } ] }, { "name": "durationMs", "kind": "optional", "type": "string", "description": "The total time in milliseconds that the Platform took to process the request.", "example": "42", "default": "42", "pattern": "^[0-9]+$" }, { "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": "^.{1,50}$" }, { "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": "^.{1,255}$" } ], "modelRef": "#/components/schemas/ledgerTransactionsResponse_V1", "isExpanded": true } ] }, { "statusCode": "400", "description": "

Bad Request - the request was malformed or contained invalid parameters.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A value other than 'Ok' indicates that the request failed.", "example": "Error", "default": "Error", "pattern": "^.{1,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the error that occurred.

", "example": "Invalid ledger account number.", "default": "Invalid ledger account number.", "pattern": "^.{1,255}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Conditional. The error code returned by the platform. Present only when the request fails.

", "example": "400", "default": "400", "pattern": "^[0-9]{3,5}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Conditional. Detailed error message describing the cause of the failure. Present only when the request fails.

", "example": "The supplied ledger account number could not be found.", "default": "The supplied ledger account number could not be found.", "pattern": "^.{1,255}$" }, { "name": "durationMs", "kind": "optional", "type": "string", "description": "The total time in milliseconds that the Platform took to process the request.", "example": "42", "default": "42", "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized - authentication failed, or the API key was missing or invalid.

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "errorResponse_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A value other than 'Ok' indicates that the request failed.", "example": "Error", "default": "Error", "pattern": "^.{1,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the error that occurred.

", "example": "Invalid ledger account number.", "default": "Invalid ledger account number.", "pattern": "^.{1,255}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Conditional. The error code returned by the platform. Present only when the request fails.

", "example": "400", "default": "400", "pattern": "^[0-9]{3,5}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Conditional. Detailed error message describing the cause of the failure. Present only when the request fails.

", "example": "The supplied ledger account number could not be found.", "default": "The supplied ledger account number could not be found.", "pattern": "^.{1,255}$" }, { "name": "durationMs", "kind": "optional", "type": "string", "description": "The total time in milliseconds that the Platform took to process the request.", "example": "42", "default": "42", "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "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_V1", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "The status of the request. A value other than 'Ok' indicates that the request failed.", "example": "Error", "default": "Error", "pattern": "^.{1,50}$" }, { "name": "statusDescription", "kind": "optional", "type": "string", "description": "

A human-readable description of the error that occurred.

", "example": "Invalid ledger account number.", "default": "Invalid ledger account number.", "pattern": "^.{1,255}$" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Conditional. The error code returned by the platform. Present only when the request fails.

", "example": "400", "default": "400", "pattern": "^[0-9]{3,5}$" }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "

Conditional. Detailed error message describing the cause of the failure. Present only when the request fails.

", "example": "The supplied ledger account number could not be found.", "default": "The supplied ledger account number could not be found.", "pattern": "^.{1,255}$" }, { "name": "durationMs", "kind": "optional", "type": "string", "description": "The total time in milliseconds that the Platform took to process the request.", "example": "42", "default": "42", "pattern": "^[0-9]+$" } ], "modelRef": "#/components/schemas/errorResponse_V1", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "xlW3LCRah0PPkKfUrGhWk", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.mpay.com.au/ledger/v1/transactions \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"ledgerAccountNumber\": \"200000001\",\n \"startDate\": \"2026-06-23\",\n \"endDate\": \"2026-07-23\",\n \"skip\": \"0\",\n \"take\": \"50\",\n \"descending\": \"true\",\n \"useTime\": \"false\"\n }'" }, { "id": "zLBOBlX53zjTFlB_FkaX_", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"ledgerAccountNumber\": \"200000001\",\n \"startDate\": \"2026-06-23\",\n \"endDate\": \"2026-07-23\",\n \"skip\": \"0\",\n \"take\": \"50\",\n \"descending\": \"true\",\n \"useTime\": \"false\"\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.mpay.com.au/ledger/v1/transactions\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ieJ1IGIWjwr04qfMvyaPj", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.mpay.com.au/ledger/v1/transactions\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"ledgerAccountNumber\": \"200000001\",\n \"startDate\": \"2026-06-23\",\n \"endDate\": \"2026-07-23\",\n \"skip\": \"0\",\n \"take\": \"50\",\n \"descending\": \"true\",\n \"useTime\": \"false\"\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "ktFh2LcHRc3LoW3EppWsW", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.mpay.com.au/ledger/v1/transactions\"\n\npayload = json.dumps({\n \"ledgerAccountNumber\": \"200000001\",\n \"startDate\": \"2026-06-23\",\n \"endDate\": \"2026-07-23\",\n \"skip\": \"0\",\n \"take\": \"50\",\n \"descending\": \"true\",\n \"useTime\": \"false\"\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "xlW3LCRah0PPkKfUrGhWk" }, "results": { "languages": [ { "id": "mIZO0sfWwQixGXR_Xe-FT", "language": "200", "code": "// Successful response.\n{\n \"ledgerAccounts\": [\n {\n \"ledgerAccountNumber\": \"200000001\",\n \"ledgerUniqueReference\": \"CUST-000123\",\n \"description\": \"Primary settlement ledger for Acme Pty Ltd\",\n \"name\": \"Acme Pty Ltd\",\n \"createdDateTime\": \"2026-07-23T13:55:59\",\n \"closedDateTime\": \"2026-07-23T13:55:59\",\n \"isClosed\": \"false\",\n \"openingBalance\": \"100.00\",\n \"closingBalance\": \"150.00\",\n \"totalDebits\": \"50.00\",\n \"totalCredits\": \"100.00\",\n \"transactionLineItems\": [\n {\n \"rowOrder\": \"1\",\n \"mPaymentsId\": \"1234567\",\n \"transactionId\": \"7654321\",\n \"dateTime\": \"2026-07-23T13:55:59\",\n \"mAccountName\": \"Acme Pty Ltd\",\n \"transactionType\": \"NPP\",\n \"subTransactionType\": \"CreditTransfer\",\n \"credit\": \"100.00\",\n \"debit\": \"50.00\",\n \"runningBalance\": \"150.00\",\n \"description\": \"Payment received from Acme Pty Ltd\"\n }\n ]\n }\n ],\n \"durationMs\": \"42\",\n \"status\": \"Ok\",\n \"statusDescription\": \"Operation completed successfully\"\n}" }, { "id": "GQG-MK0J_d5byFyeJlVFA", "language": "400", "code": "// Bad Request - the request was malformed or contained invalid parameters.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"Invalid ledger account number.\",\n \"errorCode\": \"400\",\n \"errorMessage\": \"The supplied ledger account number could not be found.\",\n \"durationMs\": \"42\"\n}" }, { "id": "-rjQZ1pLb-LXLl2-mC4Wu", "language": "401", "code": "// Unauthorized - authentication failed, or the API key was missing or invalid.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"Invalid ledger account number.\",\n \"errorCode\": \"400\",\n \"errorMessage\": \"The supplied ledger account number could not be found.\",\n \"durationMs\": \"42\"\n}" }, { "id": "34S7Un9beHQmjAxD4M-rm", "language": "500", "code": "// Internal Server Error - an unexpected error occurred while processing the request.\n{\n \"status\": \"Error\",\n \"statusDescription\": \"Invalid ledger account number.\",\n \"errorCode\": \"400\",\n \"errorMessage\": \"The supplied ledger account number could not be found.\",\n \"durationMs\": \"42\"\n}" } ], "selectedLanguageId": "mIZO0sfWwQixGXR_Xe-FT" } }, "children": [ { "text": "" } ] }