--- title: "Get a list of all payments and debts in a date range" method: GET path: "/lifetime-isa/manager/{lisaManagerReferenceNumber}/payments" tags: ["Payments and Debts"] --- # Get a list of all payments and debts in a date range `GET /lifetime-isa/manager/{lisaManagerReferenceNumber}/payments` 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
Scenario Response

Request for payments where some are found

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-05-20
endDate: 2017-10-20

HTTP status: 200 (OK)

{
    "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"
        }
    ]
}

Request for payments where none are found

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-04-06
endDate: 2017-04-06

HTTP status: 404 (Not Found)

{
  "code": "TRANSACTION_NOT_FOUND",
  "message": "No payments or debts exist for this date range"
}

Request with an invalid LISA Manager reference number

lisaManagerReferenceNumber: 123456
startDate: 2017-04-06
endDate: 2017-04-06

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "Enter lisaManagerReferenceNumber in the correct format, like Z1234"
}

Request with startDate in the wrong format

lisaManagerReferenceNumber: Use your test user profile
startDate: 20-05-2017
endDate: 2017-05-20

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "startDate is in the wrong format"
}

Request with endDate in the wrong format

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-05-20
endDate: 20-05-2017

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "endDate is in the wrong format"
}

Request with startDate and endDate in the wrong format

lisaManagerReferenceNumber: Use your test user profile
startDate: 20-05-2017
endDate: 20-05-2017

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "startDate and endDate are in the wrong format"
}

Request with and endDate in the future

lisaManagerReferenceNumber: Use your test user profile
startDate: (today's date)
endDate: (any date in the future)

HTTP status: 403 (Forbidden)

{
  "code": "FORBIDDEN",
  "message": "endDate cannot be in the future"
}

Request with an endDate before the startDate

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-12-20
endDate: 2017-12-19

HTTP status: 403 (Forbidden)

{
  "code": "FORBIDDEN",
  "message": "endDate cannot be before startDate"
}

startDate cannot be before 6 April 2017

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-04-05
endDate: 2017-04-06

HTTP status: 403 (Forbidden)

{
  "code": "FORBIDDEN",
  "message": "startDate cannot be before 6 April 2017"
}

Request with an endDate over a year after startDate

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-04-06
endDate: 2018-04-07

HTTP status: 403 (Forbidden)

{
  "code": "FORBIDDEN",
  "message": "endDate cannot be more than a year after startDate"
}

Request with an invalid 'Accept' header

lisaManagerReferenceNumber: Use your test user profile
startDate: 2017-04-06
endDate: 2017-05-05
Accept: application/vnd.hmrc.1.0

HTTP status: 404 (Not Found)

{
  "code": "MATCHING_RESOURCE_NOT_FOUND",
  "message": "A resource with the name in the request can not be found in the API"
}
## Path parameters - `lisaManagerReferenceNumber` string, required ## Query parameters - `startDate` string, required - `endDate` string, required ## Headers - `Accept` 'application/vnd.hmrc.2.0+json', required - `Authorization` string, required ## Response `200` OK - object - `lisaManagerReferenceNumber` string, required — The reference given to the LISA provider when they applied for approval from HMRC. - `payments` object[], required — Pending and paid payments from HMRC and due and collected debts owed to HMRC. - `transactionType` 'Payment' | 'Debt', required — The type of transaction. This can be money owed to HMRC (Debt), or money paid out by HMRC (Payment). - `status` 'Pending' | 'Paid' | 'Due' | 'Collected', required — The status of the transaction being requested. - `paymentAmount` number, required — Amount pending or paid to the LISA provider, or the amount due or collected from the LISA provider. - `paymentReference` string — Payment reference number. This will only be returned for paid payments and collected debts. - `paymentDate` string — The date the payment was paid or the debt was collected. This will only be returned for paid payments and collected debts. - `dueDate` string — The date the payment or debt is due to be paid or collected. This will only be returned for pending payments and due debts. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found --- [API](https://skmtc.net/hmrc/apis/lisa-api.md) · [All operations](https://skmtc.net/hmrc/apis/lisa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hmrc/lisa-api/revisions/689ca71752fb/schema)