Returns a report of PayTo transactions for the day with associated details. If requested multiple times on the current date (calendar day, AEDT), the report is cumulative. E.g. if, on the same day, a report is requested at 10am and another one at 1pm, the report at 1pm will contain all the transactions already contained in the 10am report, in addition to any new transactions. PayTo Transactions may arrive at anytime, we recommend subscribing to a webhook to receive new transaction notifications.\nThe report is an application/octet-stream, columns are comma separated. Where a comma(,) or double quote(\") is present in any of the below fields, the field will be encased in double quotes and/or escaped as per RFC4180
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "date", "type": "string", "description": "Format: 'yyyyMMddHHmmss'. This becomes the start date of the report if report is being fetched for a date range.
" } ], "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", "description": "Format: 'yyyyMMddHHmmss'. Use this to fetch the report for a date range.
" }, { "kind": "optional", "name": "skip", "type": "string", "description": "Number of records to skip. 0 is the first record." }, { "kind": "optional", "name": "take", "type": "string", "description": "Number of records to take. If endDate is provided maximum take is 10000." }, { "kind": "optional", "name": "accountNumber", "type": "string", "description": "Payee bank account number." }, { "kind": "optional", "name": "clientUniqueId", "type": "string", "description": "The unique identifier for the account." }, { "kind": "optional", "name": "payId", "type": "string", "description": "Email address for the PayID." }, { "kind": "optional", "name": "payIdName", "type": "string", "description": "Name displayed to the payers." } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "RoleAuthentication", "name": "RoleAuthentication", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "successful validation", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "payToReportResponse_V2", "schema": [ { "name": "durationMs", "kind": "optional", "type": "integer", "description": "This value represents the total time in milliseconds that the Platform took to process the request." }, { "name": "status", "kind": "optional", "type": "string", "description": "This is the status of the request. A code of 'Ok' indicates no errors." }, { "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'.
" } ], "modelRef": "#/components/schemas/payToReportResponse_V2", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "PR-Dgt2vqw4Zb5VYQYSMR", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url /paytoreceivables/v2/report/{date} \\\n --header 'accept: application/json'" }, { "id": "P-HCGGYITavIyVAQ8Vbdl", "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(\"/paytoreceivables/v2/report/{date}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Hvi2wsBQE9w3fekBr-Ruw", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"/paytoreceivables/v2/report/{date}\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "pH_TkdVidPScmR35upfAV", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"/paytoreceivables/v2/report/{date}\"\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": "PR-Dgt2vqw4Zb5VYQYSMR" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// successful validation\n{\n \"durationMs\": 0,\n \"status\": \"\",\n \"statusDescription\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }