Report the outcome of a property purchase

Report to HMRC if a property purchase was completed or failed.

Test data

<table style="font-family:Roboto, sans-serif; font-size:14px;"> <colgroup> <col width="20%" /> <col width="40%" /> <col width="40%" /> </colgroup> <thead> <tr> <th>Scenario</th> <th>Request Payload</th> <th>Response</th> </tr> <tr> <td> Successful purchase outcome 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"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </pre> </td> <td> HTTP status: <code class="code--slim">201 (Created)</code> <pre class="code--block"> { "status": 201, "success": true, "data": { "message": "Purchase outcome created", "lifeEventId": "5678900001" } } </pre> </td> </tr> <tr> <td> Purchase outcome 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-10-05", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000, "supersede": { "originalLifeEventId": "5678900001", "originalEventDate": "2017-10-10" } } </pre> </td> <td> HTTP status: <code class="code--slim">201 (Created)</code> <pre class="code--block"> { "status": 201, "success": true, "data": { "message": "Purchase outcome superseded", "lifeEventId": "5678900002" } } </pre> </td> </tr> <tr> <td> Failed purchase outcome lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567891 </td> <td> <pre class="code--block"> { "fundReleaseId": "3456789002", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase failed" } </pre> </td> <td> HTTP status: <code class="code--slim">201 (Created)</code> <pre class="code--block"> { "status": 201, "success": true, "data": { "message": "Purchase outcome created", "lifeEventId": "5678900003" } } </pre> </td> </tr> <tr> <td> Invalid LISA Manager Reference Number lisaManagerReferenceNumber: 123456 accountId: 1234567890 </td> <td> <pre class="code--block"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </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"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </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> 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-10-05", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000, "supersede": { "originalLifeEventId": "5678900000", "originalEventDate": "2017-10-10" } } </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> Fund release not found lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1000000404 </td> <td> <pre class="code--block"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </pre> </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code" : "FUND_RELEASE_NOT_FOUND", "message" : "The fundReleaseId does not match HMRC’s records" } </pre> </td> </tr> <tr> <td> Investor account not found 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"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </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 purchase outcome 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-10-05", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000, "supersede": { "originalLifeEventId": "5678900001", "originalEventDate": "2017-10-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": "5678900002" } </pre> </td> </tr> <tr> <td> Purchase outcome 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"> { "fundReleaseId": "3456789001", "eventDate": "2017-10-10", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </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": "5678900001" } </pre> </td> </tr> <tr> <td> The associated fund release has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 2000000409 </td> <td> <pre class="code--block"> { "fundReleaseId": "3456789000", "eventDate": "2017-10-05", "propertyPurchaseResult": "Purchase completed", "propertyPurchaseValue": 250000 } </pre> </td> <td> HTTP status: <code class="code--slim">409 (Conflict)</code> <pre class="code--block"> { "code": "FUND_RELEASE_SUPERSEDED", "message": "This fund release has already been superseded", "lifeEventId": "3456789001" } </pre> </td> </tr> </thead> </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

fundReleaseIdstring

The reference number you get when you report a fund release. Must not be provided when correcting an existing purchase outcome.

eventDatestring required

The date the outcome of the property purchase was known. This cannot be in the future.

propertyPurchaseResult'Purchase failed' | 'Purchase completed' required

Whether a property purchase was completed or failed.

propertyPurchaseValuenumber

The value of the property that the investor purchased. Only include this information if the purchase was completed. You can include an amount up to 2 decimal places.

Example request

{
  "fundReleaseId": "0987654321",
  "eventDate": "2017-05-06",
  "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

Report the outcome of a property purchase

Test data

Path parameters

Headers

Request body

Example request

Response