Get a list of all payments and debts in a date range

Get a list of all pending and paid payments from HMRC and due and collected debts owed to HMRC in a specific date range.

Test data

<table style="font-family:Roboto, sans-serif; font-size:14px;"> <col width="40%"> <col width="60%"> <thead> <tr> <th>Scenario</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td> Request for payments where some are found lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-05-20 endDate: 2017-10-20 </td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "lisaManagerReferenceNumber": "Z123456", "payments": [ { "transactionType": "Payment", "status": "Paid", "paymentAmount": 10000, "paymentDate": "2017-06-01", "paymentReference": "3350000253" }, { "transactionType": "Payment", "status": "Pending", "paymentAmount": 12000, "dueDate": "2017-07-04" }, { "transactionType": "Debt", "status": "Collected", "paymentAmount": 1000, "paymentDate": "2017-08-04", "paymentReference": "3350000253" }, { "transactionType": "Debt", "status": "Due", "paymentAmount": 1100, "dueDate": "2017-09-04" } ] } </pre> </td> </tr> <tr> <td> Request for payments where none are found lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-04-06 endDate: 2017-04-06 </td> <td>HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "TRANSACTION_NOT_FOUND", "message": "No payments or debts exist for this date range" } </pre> </td> </tr> <tr> <td> Request with an invalid LISA Manager reference number lisaManagerReferenceNumber: 123456 startDate: 2017-04-06 endDate: 2017-04-06 </td> <td>HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "Enter lisaManagerReferenceNumber in the correct format, like Z1234" } </pre> </td> </tr> <tr> <td> Request with startDate in the wrong format lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 20-05-2017 endDate: 2017-05-20 </td> <td>HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "startDate is in the wrong format" } </pre> </td> </tr> <tr> <td> Request with endDate in the wrong format lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-05-20 endDate: 20-05-2017 </td> <td>HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "endDate is in the wrong format" } </pre> </td> </tr> <tr> <td> Request with startDate and endDate in the wrong format lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 20-05-2017 endDate: 20-05-2017 </td> <td>HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "startDate and endDate are in the wrong format" } </pre> </td> </tr> <tr> <td> Request with and endDate in the future lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: (today's date) endDate: (any date in the future) </td> <td>HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "FORBIDDEN", "message": "endDate cannot be in the future" } </pre> </td> </tr> <tr> <td> Request with an endDate before the startDate lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-12-20 endDate: 2017-12-19 </td> <td>HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "FORBIDDEN", "message": "endDate cannot be before startDate" } </pre> </td> </tr> <tr> <td> startDate cannot be before 6 April 2017 lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-04-05 endDate: 2017-04-06 </td> <td>HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "FORBIDDEN", "message": "startDate cannot be before 6 April 2017" } </pre> </td> </tr> <tr> <td> Request with an endDate over a year after startDate lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-04-06 endDate: 2018-04-07 </td> <td>HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "FORBIDDEN", "message": "endDate cannot be more than a year after startDate" } </pre> </td> </tr> <tr> <td> Request with an invalid 'Accept' header lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> startDate: 2017-04-06 endDate: 2017-05-05 Accept: application/vnd.hmrc.1.0 </td> <td>HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "MATCHING_RESOURCE_NOT_FOUND", "message": "A resource with the name in the request can not be found in the API" } </pre> </td> </tr> </tbody> </table>

lisaManagerReferenceNumberstring required

Example:Z1234

The reference given to the LISA provider when they applied for approval from HMRC.

startDatestring required

Example:2017-05-06

The first date in the claim period you want to search. This must be the 6th day of the month. This cannot be before 6 April 2017.

endDatestring required

Example:2017-06-05

The last date of the claim period you want to search. This must be the 5th day of the month. This cannot be in the future, before the startDate, or more than a year after the startDate. It must be at least one month after the startDate.

Accept'application/vnd.hmrc.2.0+json' required

Specifies the response format and the version of the API to be used.

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with appropriate scope.

Response

OK

lisaManagerReferenceNumberstring required

The reference given to the LISA provider when they applied for approval from HMRC.

Example response

{
  "lisaManagerReferenceNumber": "Z1234",
  "payments": [
    {
      "paymentAmount": 23456,
      "paymentReference": "1234567890",
      "paymentDate": "2017-05-20",
      "dueDate": "2017-05-20"
    }
  ]
}

v1

Get a list of all payments and debts in a date range

Test data

Path parameters

Query parameters

Headers

Response

Example response