v1

latestOpenAPI 3.0.32026-07-131990818.5 KB

Bonus Requests

Get details of a bonus request

Use an investor’s transaction ID to get a request for a bonus payment that has been submitted to HMRC.

Test data

<table style="font-family:Roboto, sans-serif; font-size:14px;"> <colgroup> <col width="40%"> <col width="60%"> </colgroup> <thead> <tr> <th>Scenario</th> <th>Response</th> </tr> </thead> <tbody> <tr> <td> Retrieve details for a bonus payment associated with a LISA account lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0123456789 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "lifeEventId": "1234567891", "periodStartDate": "2017-04-06", "periodEndDate": "2017-05-05", "htbTransfer": { "htbTransferInForPeriod": 0, "htbTransferTotalYTD": 0 }, "inboundPayments": { "newSubsForPeriod": 4000, "newSubsYTD": 4000, "totalSubsForPeriod": 4000, "totalSubsYTD": 4000 }, "bonuses": { "bonusDueForPeriod": 1000, "totalBonusDueYTD": 1000, "bonusPaidYTD": 0, "claimReason": "Life Event" }, "supersededBy": "0000456789" } </pre> </td> </tr> <tr> <td> Retrieve details for a bonus payment associated with a LISA account (regular bonus) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0003456789 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "periodStartDate": "2017-04-06", "periodEndDate": "2017-05-05", "htbTransfer": { "htbTransferInForPeriod": 0, "htbTransferTotalYTD": 0 }, "inboundPayments": { "newSubsForPeriod": 4000, "newSubsYTD": 4000, "totalSubsForPeriod": 4000, "totalSubsYTD": 4000 }, "bonuses": { "bonusDueForPeriod": 1000, "totalBonusDueYTD": 1000, "bonusPaidYTD": 0, "claimReason": "Regular Bonus" }, "supersededBy": "0000056789" } </pre> </td> </tr> <tr> <td> Retrieve a superseded transaction (bonus recovery) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0000456789 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "periodStartDate": "2017-04-06", "periodEndDate": "2017-05-05", "inboundPayments": { "newSubsForPeriod": 4000, "newSubsYTD": 4000, "totalSubsForPeriod": 4000, "totalSubsYTD": 4000 }, "bonuses": { "bonusDueForPeriod": 1000, "totalBonusDueYTD": 1000, "bonusPaidYTD": 0, "claimReason": "Superseded Bonus" }, "supersede": { "automaticRecoveryAmount": 1000, "originalTransactionId": "0123456789", "originalBonusDueForPeriod": 1000, "transactionResult": -1000, "reason": "Bonus recovery" } } </pre> </td> </tr> <tr> <td> Retrieve a superseded transaction (additional bonus) lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0000056789 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "periodStartDate": "2017-04-06", "periodEndDate": "2017-05-05", "inboundPayments": { "newSubsForPeriod": 4000, "newSubsYTD": 4000, "totalSubsForPeriod": 4000, "totalSubsYTD": 4000 }, "bonuses": { "bonusDueForPeriod": 1000, "totalBonusDueYTD": 1000, "bonusPaidYTD": 0, "claimReason": "Superseded Bonus" }, "supersede": { "originalTransactionId": "0003456789", "originalBonusDueForPeriod": 4000, "transactionResult": 4000, "reason": "Additional bonus" } } </pre> </td> </tr> <tr> <td> Request with an invalid LISA Manager reference number lisaManagerReferenceNumber: 123456 accountId: 1234567890 transactionId: 0123456789 </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 an invalid accountId lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234%3D5678 transactionId: 0123456789 </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> Request with an invalid bonus payment transaction lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0000000404 </td> <td> HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "BONUS_PAYMENT_TRANSACTION_NOT_FOUND", "message": "transactionId does not match HMRC’s records" } </pre> </td> </tr> <tr> <td> Request with an invalid LISA account lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567899 transactionId: 1000000404 </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> </tbody> </table>

get/lifetime-isa/manager/{lisaManagerReferenceNumber}/accounts/{accountId}/transactions/{transactionId}

Path parameters

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.

transactionIdstring required

Example:1234567890

The ID for the transaction.

Headers

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

lifeEventIdstring

A reference number for a life event.

periodStartDatestring required

The first date in the claim period.

periodEndDatestring required

The end date of the claim period.

supersededBystring

The ID of the transaction that supersedes the current one.

Example response

{
  "lifeEventId": "0987654321",
  "periodStartDate": "2017-05-06",
  "periodEndDate": "2017-06-05",
  "supersededBy": "1234567890",
  "supersede": {
    "originalTransactionId": "1234567890"
  }
}