Request the release of funds to buy a property

Request the release of LISA funds to buy a property. You can also correct a request by changing the withdrawal amount or property purchase date. When you make a correction, you cannot change the property details or the conveyancer reference number.

Test data

<table style="font-family:Roboto, sans-serif; font-size:14px;"> <col width="20%"> <col width="40%"> <col width="40%"> <thead> <tr> <th>Scenario</th> <th>Request Payload</th> <th>Response</th> </tr> <tr> <td> Fund release created lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">201 (Created)</code> <pre class="code--block"> { "status": 201, "success": true, "data": { "message": "Fund release created", "lifeEventId": "3456789000" } } </pre> </td> </tr> <tr> <td> Fund release superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-05", "withdrawalAmount": 5000.00, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-10" } } </pre> </td> <td> HTTP status: <code class="code--slim">201 (Created)</code> <pre class="code--block"> { "status": 201, "success": true, "data": { "message": "Fund release superseded", "lifeEventId": "3456789001" } } </pre> </td> </tr> <tr> <td> Invalid LISA Manager Reference Number lisaManagerReferenceNumber: 123456 accountId: 1234567890 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </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> Invalid Account ID lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234%3D5678 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "BAD_REQUEST", "message": "Enter accountId in the correct format, like ABC12345" } </pre> </td> </tr> <tr> <td> Submission has not passed validation lisaManagerReferenceNumber: 123456 accountId: 0000000405 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">400 (Bad Request)</code> <pre class="code--block"> { "code": "INVALID_PAYLOAD", "message": "Submission has not passed validation" } </pre> </td> </tr> <tr> <td> This LISA account is already closed lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "INVESTOR_ACCOUNT_ALREADY_CLOSED", "message": "The LISA account is already closed" } </pre> </td> </tr> <tr> <td> This LISA account is already void lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 3000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "INVESTOR_ACCOUNT_ALREADY_VOID", "message": "The LISA account is already void" } </pre> </td> </tr> <tr> <td> This LISA account is already cancelled lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 2000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "INVESTOR_ACCOUNT_ALREADY_CANCELLED", "message": "The LISA account is already cancelled" } </pre> </td> </tr> <tr> <td> Account not open long enough lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 4000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "COMPLIANCE_ERROR_ACCOUNT_NOT_OPEN_LONG_ENOUGH", "message": "The account has not been open for long enough" } </pre> </td> </tr> <tr> <td> Other purchase on record lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 6000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "COMPLIANCE_ERROR_OTHER_PURCHASE_ON_RECORD", "message": "Another property purchase is already recorded" } </pre> </td> </tr> <tr> <td> Supersede details do not match the original request lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 5000000403 </td> <td> <pre class="code--block"> { "eventDate": "2017-06-05", "withdrawalAmount": 10000.00, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-05" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "SUPERSEDED_LIFE_EVENT_MISMATCH_ERROR", "message": "originalLifeEventId and the originalEventDate do not match the information in the original request" } </pre> </td> </tr> <tr> <td> Invalid Data Provided lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" }, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-05" } } </pre> </td> <td> HTTP status: <code class="code--slim">403 (Forbidden)</code> <pre class="code--block"> { "code": "INVALID_DATA_PROVIDED", "message": "You can only change eventDate or withdrawalAmount when superseding a property purchase fund release" } </pre> </td> </tr> <tr> <td> Account ID does not exist lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 0000000404 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "INVESTOR_ACCOUNTID_NOT_FOUND", "message": "Enter a real accountId" } </pre> </td> </tr> <tr> <td> The fund release you are superseding has already been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1000000409 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-05", "withdrawalAmount": 4000.00, "supersede": { "originalLifeEventId": "3456789000", "originalEventDate": "2017-05-10" } } </pre> </td> <td> HTTP status: <code class="code--slim">409 (Conflict)</code> <pre class="code--block"> { "code": "SUPERSEDED_LIFE_EVENT_ALREADY_SUPERSEDED", "message": "This life event has already been superseded", "lifeEventId": "3456789001" } </pre> </td> </tr> <tr> <td> Fund release already exists lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 0000000409 </td> <td> <pre class="code--block"> { "eventDate": "2017-05-10", "withdrawalAmount": 4000.00, "conveyancerReference": "CR12345-6789", "propertyDetails": { "nameOrNumber": "1", "postalCode": "AA11 1AA" } } </pre> </td> <td> HTTP status: <code class="code--slim">409 (Conflict)</code> <pre class="code--block"> { "code": "LIFE_EVENT_ALREADY_EXISTS", "message": "The investor’s life event has already been reported", "lifeEventId": "3456789000" } </pre> </td> </tr> </thead> </tbody> </table>

lisaManagerReferenceNumberstring required

Example:Z1234

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

accountIdstring required

Example:ABC12345

The ID for the account. This will be generated by the LISA Manager and will only be unique when used in combination with lisaManagerReferenceNumber. Any special characters should be URL encoded.

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

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

Content-Type'application/json' required

Specifies the format of the request body, which must be JSON.

Authorizationstring required

Example:Bearer bb7fed3fe10dd235a2ccda3d50fb

An OAuth 2.0 Bearer Token with appropriate scope.

Request body

eventDatestring required

This is the date of the request to release funds. This cannot be in the future.

withdrawalAmountnumber required

This is the amount that the investor has withdrawn from the LISA account. You can include a value up to 2 decimal places.

conveyancerReferencestring

This is the reference for the conveyancer involved with the property purchase.

Example request

{
  "eventDate": "2017-05-06",
  "conveyancerReference": "CR12345-6789",
  "propertyDetails": {
    "nameOrNumber": "Flat A",
    "postalCode": "AA1 1AA"
  },
  "supersede": {
    "originalLifeEventId": "0987654321",
    "originalEventDate": "2017-05-06"
  }
}

Response

Created

statusnumber required

The HTTP status of the result of the API call. Always 201.

successboolean required

Whether the API call was successful or not. Always true.

v1

Request the release of funds to buy a property

Test data

Path parameters

Headers

Request body

Example request

Response