{"action":"created","comment":{"url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/comments/224754562","pull_request_review_id":164202986,"id":224754562,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIyNDc1NDU2Mg==","diff_hunk":"@@ -0,0 +1,113 @@\n+---\n+title: Reporting \n+weight: 70\n+---\n+\n+# Reporting \n+\n+You can extract reporting information from GOV.UK Pay manually, or via the\n+API.\n+\n+## Manual reporting\n+\n+You can sign in to your [GOV.UK Pay admin\n+account](https://selfservice.payments.service.gov.uk/login) and export\n+transaction information in a CSV file. \n+\n+For a given account, select __Transactions__ in the __Dashboard__ page.\n+\n+You can filter transactions using the available search criteria, and then\n+select __Download all transaction details as a CSV file__. \n+\n+You can process CSV files using spreadsheet software.\n+\n+## Reporting via the GOV.UK Pay API \n+\n+Before reading this section, you should read the section describing [Making\n+payments](/making_payments). \n+\n+You can use the GOV.UK Pay API to export data automatically into your finance\n+systems. This requires you to do some development, but could remove \n+routine manual operations from your workflow and lead to significant cost\n+savings for your organisation. Before you do this, you should have a datastore \n+where you are already recording payments. \n+\n+You can use the GOV.UK Pay API to:\n+\n+* get information about single payments\n+* generate a list of payments \n+\n+## Get information about single payments\n+\n+### Check the status of a single payment\n+\n+`GET /v1/payments/paymentId`\n+\n+1. Sign in to <a href=\"https://gds-payments.gelato.io/api-explorer/\"\n+   target=\"blank\">the API Explorer</a> (link opens in new window).  \n+2. Under __Resource__, select __{Payment Id}. Under __Action__, select <a\n+   href=\"https://gds-payments.gelato.io/api-explorer/gov-uk-pay-api/versions/1.0.2/general/\"\n+   target=\"blank\">__Find payment by ID__</a> (link opens in new window). \n+   \n+For a valid request, the JSON response body contains a `\"state\"` field. \n+\n+For example, for a successful payment:\n+\n+```\n+  \"state\": {\n+    \"status\": \"success\",\n+    \"finished\": true\n+    },\n+```\n+\n+### See information users have entered for a single payment","path":"source/reporting/index.html.md.erb","position":63,"original_position":63,"commit_id":"939682800c09b275f40e666d45ffcae884f98c64","original_commit_id":"939682800c09b275f40e666d45ffcae884f98c64","user":{"login":"bahmady","id":32935794,"node_id":"MDQ6VXNlcjMyOTM1Nzk0","avatar_url":"https://avatars0.githubusercontent.com/u/32935794?v=4","gravatar_id":"","url":"https://api.github.com/users/bahmady","html_url":"https://github.com/bahmady","followers_url":"https://api.github.com/users/bahmady/followers","following_url":"https://api.github.com/users/bahmady/following{/other_user}","gists_url":"https://api.github.com/users/bahmady/gists{/gist_id}","starred_url":"https://api.github.com/users/bahmady/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bahmady/subscriptions","organizations_url":"https://api.github.com/users/bahmady/orgs","repos_url":"https://api.github.com/users/bahmady/repos","events_url":"https://api.github.com/users/bahmady/events{/privacy}","received_events_url":"https://api.github.com/users/bahmady/received_events","type":"User","site_admin":false},"body":"Yeah, realised that when I was writing it: I've changed it 👍 ","created_at":"2018-10-12T11:33:10Z","updated_at":"2018-10-12T11:33:10Z","html_url":"https://github.com/alphagov/pay-tech-docs/pull/169#discussion_r224754562","pull_request_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169","author_association":"CONTRIBUTOR","_links":{"self":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/comments/224754562"},"html":{"href":"https://github.com/alphagov/pay-tech-docs/pull/169#discussion_r224754562"},"pull_request":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169"}},"in_reply_to_id":224476985},"pull_request":{"url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169","id":221079633,"node_id":"MDExOlB1bGxSZXF1ZXN0MjIxMDc5NjMz","html_url":"https://github.com/alphagov/pay-tech-docs/pull/169","diff_url":"https://github.com/alphagov/pay-tech-docs/pull/169.diff","patch_url":"https://github.com/alphagov/pay-tech-docs/pull/169.patch","issue_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/169","number":169,"state":"open","locked":false,"title":"Add a 'Reporting' section","user":{"login":"bahmady","id":32935794,"node_id":"MDQ6VXNlcjMyOTM1Nzk0","avatar_url":"https://avatars0.githubusercontent.com/u/32935794?v=4","gravatar_id":"","url":"https://api.github.com/users/bahmady","html_url":"https://github.com/bahmady","followers_url":"https://api.github.com/users/bahmady/followers","following_url":"https://api.github.com/users/bahmady/following{/other_user}","gists_url":"https://api.github.com/users/bahmady/gists{/gist_id}","starred_url":"https://api.github.com/users/bahmady/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bahmady/subscriptions","organizations_url":"https://api.github.com/users/bahmady/orgs","repos_url":"https://api.github.com/users/bahmady/repos","events_url":"https://api.github.com/users/bahmady/events{/privacy}","received_events_url":"https://api.github.com/users/bahmady/received_events","type":"User","site_admin":false},"body":"### Context\r\nWe need a section on reporting in some form or another on the same hierarchy as the other main sections in the docs \r\n\r\n### Changes proposed in this pull request\r\n* Introduction (first draft) of new docs for reporting. I did have a \"Cancel payments\" section on the same level as this as part of this PR but I'm not sure about that any more.\r\n\r\n* Makes some changes to 'Making payments' section\r\n\r\n* Changes directory name for 'Making payments' to 'making_payments' (not 'taking_payments' which was erroneous)\r\n\r\n### Guidance to review (__please read__)\r\nI'm going to add some comments myself indicating where I'm unsure of things, so perhaps someone with expert knowledge can kindly help me fill those in. \r\n\r\nPlease consider this in draft form: as ever, everything goes—and that includes the structure of the docs—so feel free to be as free with your feedback as you please. \r\n\r\nI'll also need to have this reviewed by a writer before I publish it.\r\n\r\nI've put this up in an app \"in situ\" for testing/review: https://govukpay-reportingdocs.cloudapps.digital/","created_at":"2018-10-08T11:14:15Z","updated_at":"2018-10-12T11:33:10Z","closed_at":null,"merged_at":null,"merge_commit_sha":"61ba0f1f1bff10a481459eb6ee40af83d3c451ec","assignee":null,"assignees":[],"requested_reviewers":[{"login":"heathd","id":61065,"node_id":"MDQ6VXNlcjYxMDY1","avatar_url":"https://avatars3.githubusercontent.com/u/61065?v=4","gravatar_id":"","url":"https://api.github.com/users/heathd","html_url":"https://github.com/heathd","followers_url":"https://api.github.com/users/heathd/followers","following_url":"https://api.github.com/users/heathd/following{/other_user}","gists_url":"https://api.github.com/users/heathd/gists{/gist_id}","starred_url":"https://api.github.com/users/heathd/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/heathd/subscriptions","organizations_url":"https://api.github.com/users/heathd/orgs","repos_url":"https://api.github.com/users/heathd/repos","events_url":"https://api.github.com/users/heathd/events{/privacy}","received_events_url":"https://api.github.com/users/heathd/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[],"milestone":null,"commits_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169/commits","review_comments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169/comments","review_comment_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/comments{/number}","comments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/169/comments","statuses_url":"https://api.github.com/repos/alphagov/pay-tech-docs/statuses/939682800c09b275f40e666d45ffcae884f98c64","head":{"label":"alphagov:financial_reporting","ref":"financial_reporting","sha":"939682800c09b275f40e666d45ffcae884f98c64","user":{"login":"alphagov","id":596977,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU5Njk3Nw==","avatar_url":"https://avatars0.githubusercontent.com/u/596977?v=4","gravatar_id":"","url":"https://api.github.com/users/alphagov","html_url":"https://github.com/alphagov","followers_url":"https://api.github.com/users/alphagov/followers","following_url":"https://api.github.com/users/alphagov/following{/other_user}","gists_url":"https://api.github.com/users/alphagov/gists{/gist_id}","starred_url":"https://api.github.com/users/alphagov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alphagov/subscriptions","organizations_url":"https://api.github.com/users/alphagov/orgs","repos_url":"https://api.github.com/users/alphagov/repos","events_url":"https://api.github.com/users/alphagov/events{/privacy}","received_events_url":"https://api.github.com/users/alphagov/received_events","type":"Organization","site_admin":false},"repo":{"id":76550775,"node_id":"MDEwOlJlcG9zaXRvcnk3NjU1MDc3NQ==","name":"pay-tech-docs","full_name":"alphagov/pay-tech-docs","private":false,"owner":{"login":"alphagov","id":596977,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU5Njk3Nw==","avatar_url":"https://avatars0.githubusercontent.com/u/596977?v=4","gravatar_id":"","url":"https://api.github.com/users/alphagov","html_url":"https://github.com/alphagov","followers_url":"https://api.github.com/users/alphagov/followers","following_url":"https://api.github.com/users/alphagov/following{/other_user}","gists_url":"https://api.github.com/users/alphagov/gists{/gist_id}","starred_url":"https://api.github.com/users/alphagov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alphagov/subscriptions","organizations_url":"https://api.github.com/users/alphagov/orgs","repos_url":"https://api.github.com/users/alphagov/repos","events_url":"https://api.github.com/users/alphagov/events{/privacy}","received_events_url":"https://api.github.com/users/alphagov/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/alphagov/pay-tech-docs","description":"Technical documentation for GOV.UK Pay","fork":false,"url":"https://api.github.com/repos/alphagov/pay-tech-docs","forks_url":"https://api.github.com/repos/alphagov/pay-tech-docs/forks","keys_url":"https://api.github.com/repos/alphagov/pay-tech-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/alphagov/pay-tech-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/alphagov/pay-tech-docs/teams","hooks_url":"https://api.github.com/repos/alphagov/pay-tech-docs/hooks","issue_events_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/events{/number}","events_url":"https://api.github.com/repos/alphagov/pay-tech-docs/events","assignees_url":"https://api.github.com/repos/alphagov/pay-tech-docs/assignees{/user}","branches_url":"https://api.github.com/repos/alphagov/pay-tech-docs/branches{/branch}","tags_url":"https://api.github.com/repos/alphagov/pay-tech-docs/tags","blobs_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/alphagov/pay-tech-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/alphagov/pay-tech-docs/languages","stargazers_url":"https://api.github.com/repos/alphagov/pay-tech-docs/stargazers","contributors_url":"https://api.github.com/repos/alphagov/pay-tech-docs/contributors","subscribers_url":"https://api.github.com/repos/alphagov/pay-tech-docs/subscribers","subscription_url":"https://api.github.com/repos/alphagov/pay-tech-docs/subscription","commits_url":"https://api.github.com/repos/alphagov/pay-tech-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/alphagov/pay-tech-docs/contents/{+path}","compare_url":"https://api.github.com/repos/alphagov/pay-tech-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/alphagov/pay-tech-docs/merges","archive_url":"https://api.github.com/repos/alphagov/pay-tech-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/alphagov/pay-tech-docs/downloads","issues_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues{/number}","pulls_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/alphagov/pay-tech-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/alphagov/pay-tech-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/alphagov/pay-tech-docs/labels{/name}","releases_url":"https://api.github.com/repos/alphagov/pay-tech-docs/releases{/id}","deployments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/deployments","created_at":"2016-12-15T10:41:07Z","updated_at":"2018-10-10T14:19:57Z","pushed_at":"2018-10-10T14:19:58Z","git_url":"git://github.com/alphagov/pay-tech-docs.git","ssh_url":"git@github.com:alphagov/pay-tech-docs.git","clone_url":"https://github.com/alphagov/pay-tech-docs.git","svn_url":"https://github.com/alphagov/pay-tech-docs","homepage":"","size":6500,"stargazers_count":2,"watchers_count":2,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"open_issues_count":3,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":1,"open_issues":3,"watchers":2,"default_branch":"master"}},"base":{"label":"alphagov:master","ref":"master","sha":"555e1750626300e9c9cfb3fef87176b9828f1ea2","user":{"login":"alphagov","id":596977,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU5Njk3Nw==","avatar_url":"https://avatars0.githubusercontent.com/u/596977?v=4","gravatar_id":"","url":"https://api.github.com/users/alphagov","html_url":"https://github.com/alphagov","followers_url":"https://api.github.com/users/alphagov/followers","following_url":"https://api.github.com/users/alphagov/following{/other_user}","gists_url":"https://api.github.com/users/alphagov/gists{/gist_id}","starred_url":"https://api.github.com/users/alphagov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alphagov/subscriptions","organizations_url":"https://api.github.com/users/alphagov/orgs","repos_url":"https://api.github.com/users/alphagov/repos","events_url":"https://api.github.com/users/alphagov/events{/privacy}","received_events_url":"https://api.github.com/users/alphagov/received_events","type":"Organization","site_admin":false},"repo":{"id":76550775,"node_id":"MDEwOlJlcG9zaXRvcnk3NjU1MDc3NQ==","name":"pay-tech-docs","full_name":"alphagov/pay-tech-docs","private":false,"owner":{"login":"alphagov","id":596977,"node_id":"MDEyOk9yZ2FuaXphdGlvbjU5Njk3Nw==","avatar_url":"https://avatars0.githubusercontent.com/u/596977?v=4","gravatar_id":"","url":"https://api.github.com/users/alphagov","html_url":"https://github.com/alphagov","followers_url":"https://api.github.com/users/alphagov/followers","following_url":"https://api.github.com/users/alphagov/following{/other_user}","gists_url":"https://api.github.com/users/alphagov/gists{/gist_id}","starred_url":"https://api.github.com/users/alphagov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/alphagov/subscriptions","organizations_url":"https://api.github.com/users/alphagov/orgs","repos_url":"https://api.github.com/users/alphagov/repos","events_url":"https://api.github.com/users/alphagov/events{/privacy}","received_events_url":"https://api.github.com/users/alphagov/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/alphagov/pay-tech-docs","description":"Technical documentation for GOV.UK Pay","fork":false,"url":"https://api.github.com/repos/alphagov/pay-tech-docs","forks_url":"https://api.github.com/repos/alphagov/pay-tech-docs/forks","keys_url":"https://api.github.com/repos/alphagov/pay-tech-docs/keys{/key_id}","collaborators_url":"https://api.github.com/repos/alphagov/pay-tech-docs/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/alphagov/pay-tech-docs/teams","hooks_url":"https://api.github.com/repos/alphagov/pay-tech-docs/hooks","issue_events_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/events{/number}","events_url":"https://api.github.com/repos/alphagov/pay-tech-docs/events","assignees_url":"https://api.github.com/repos/alphagov/pay-tech-docs/assignees{/user}","branches_url":"https://api.github.com/repos/alphagov/pay-tech-docs/branches{/branch}","tags_url":"https://api.github.com/repos/alphagov/pay-tech-docs/tags","blobs_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/refs{/sha}","trees_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/trees{/sha}","statuses_url":"https://api.github.com/repos/alphagov/pay-tech-docs/statuses/{sha}","languages_url":"https://api.github.com/repos/alphagov/pay-tech-docs/languages","stargazers_url":"https://api.github.com/repos/alphagov/pay-tech-docs/stargazers","contributors_url":"https://api.github.com/repos/alphagov/pay-tech-docs/contributors","subscribers_url":"https://api.github.com/repos/alphagov/pay-tech-docs/subscribers","subscription_url":"https://api.github.com/repos/alphagov/pay-tech-docs/subscription","commits_url":"https://api.github.com/repos/alphagov/pay-tech-docs/commits{/sha}","git_commits_url":"https://api.github.com/repos/alphagov/pay-tech-docs/git/commits{/sha}","comments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/comments{/number}","issue_comment_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/comments{/number}","contents_url":"https://api.github.com/repos/alphagov/pay-tech-docs/contents/{+path}","compare_url":"https://api.github.com/repos/alphagov/pay-tech-docs/compare/{base}...{head}","merges_url":"https://api.github.com/repos/alphagov/pay-tech-docs/merges","archive_url":"https://api.github.com/repos/alphagov/pay-tech-docs/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/alphagov/pay-tech-docs/downloads","issues_url":"https://api.github.com/repos/alphagov/pay-tech-docs/issues{/number}","pulls_url":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls{/number}","milestones_url":"https://api.github.com/repos/alphagov/pay-tech-docs/milestones{/number}","notifications_url":"https://api.github.com/repos/alphagov/pay-tech-docs/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/alphagov/pay-tech-docs/labels{/name}","releases_url":"https://api.github.com/repos/alphagov/pay-tech-docs/releases{/id}","deployments_url":"https://api.github.com/repos/alphagov/pay-tech-docs/deployments","created_at":"2016-12-15T10:41:07Z","updated_at":"2018-10-10T14:19:57Z","pushed_at":"2018-10-10T14:19:58Z","git_url":"git://github.com/alphagov/pay-tech-docs.git","ssh_url":"git@github.com:alphagov/pay-tech-docs.git","clone_url":"https://github.com/alphagov/pay-tech-docs.git","svn_url":"https://github.com/alphagov/pay-tech-docs","homepage":"","size":6500,"stargazers_count":2,"watchers_count":2,"language":"HTML","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":1,"mirror_url":null,"archived":false,"open_issues_count":3,"license":{"key":"mit","name":"MIT License","spdx_id":"MIT","url":"https://api.github.com/licenses/mit","node_id":"MDc6TGljZW5zZTEz"},"forks":1,"open_issues":3,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169"},"html":{"href":"https://github.com/alphagov/pay-tech-docs/pull/169"},"issue":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/169"},"comments":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/issues/169/comments"},"review_comments":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169/comments"},"review_comment":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/pulls/169/commits"},"statuses":{"href":"https://api.github.com/repos/alphagov/pay-tech-docs/statuses/939682800c09b275f40e666d45ffcae884f98c64"}},"author_association":"CONTRIBUTOR"}}
{"actor":{"display_login":"bahmady"}}