Get details of a withdrawal charge

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

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> Withdrawal transaction which has been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 2345678901 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "claimPeriodStartDate": "2017-12-06", "claimPeriodEndDate": "2018-01-05", "automaticRecoveryAmount": 250, "withdrawalAmount": 1000, "withdrawalChargeAmount": 250, "withdrawalChargeAmountYTD": 500, "fundsDeductedDuringWithdrawal": true, "withdrawalReason": "Regular withdrawal", "supersededBy": "2345678903" } </pre> </td> </tr> <tr> <td> Withdrawal transaction which has not been superseded lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 2345678902 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "claimPeriodStartDate": "2017-12-06", "claimPeriodEndDate": "2018-01-05", "automaticRecoveryAmount": 250, "withdrawalAmount": 1000, "withdrawalChargeAmount": 250, "withdrawalChargeAmountYTD": 500, "fundsDeductedDuringWithdrawal": true, "withdrawalReason": "Regular withdrawal" } </pre> </td> </tr> <tr> <td> Withdrawal transaction which supersedes another lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 2345678903 </td> <td> HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "claimPeriodStartDate": "2017-12-06", "claimPeriodEndDate": "2018-01-05", "automaticRecoveryAmount": 250, "withdrawalAmount": 2000, "withdrawalChargeAmount": 500, "withdrawalChargeAmountYTD": 750, "fundsDeductedDuringWithdrawal": true, "withdrawalReason": "Superseded withdrawal", "supersede": { "originalTransactionId": "2345678901", "originalWithdrawalChargeAmount": 250, "transactionResult": 250, "reason": "Additional withdrawal" } } </pre> </td> </tr> <tr> <td> Invalid LISA Manager Reference Number lisaManagerReferenceNumber: 123456 accountId: 1234567890 transactionId: 2345678901 </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 transactionId: 2345678901 </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> 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: 1234567890 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> <tr> <td> Transaction ID does not exist 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": "WITHDRAWAL_CHARGE_TRANSACTION_NOT_FOUND", "message": "transactionId does not match HMRC’s records" } </pre> </td> </tr> </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.

transactionIdstring required

Example:1234567890

The ID for the transaction.

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

claimPeriodStartDatestring required

This is the start date of the claim period for the withdrawal charge. It must be the sixth day of the month. You cannot enter a date in the future.

claimPeriodEndDatestring required

This is the end date of the claim period for the withdrawal charge. It must be the fifth day of the month. It has to be the month after the claimPeriodStartDate.

automaticRecoveryAmountnumber

This is the amount HMRC can collect from the LISA manager when there is a withdrawal charge. If there are no funds available, this value must be 0.

withdrawalAmountnumber required

This is the amount that the investor has withdrawn from the LISA account.

withdrawalChargeAmountnumber required

This is the amount charged for the withdrawal.

withdrawalChargeAmountYTDnumber required

This is the total value of withdrawal charges reported to HMRC for the current tax year to date.

fundsDeductedDuringWithdrawalboolean required

This confirms if the investor was charged and funds were deducted at the time of the withdrawal.

withdrawalReason'Regular withdrawal' | 'Superseded withdrawal' required

This is used by HMRC to decide how the withdrawal charge is processed.

supersededBystring

The ID of the transaction that supersedes the current one.

Example response

{
  "claimPeriodStartDate": "2018-01-06",
  "claimPeriodEndDate": "2018-02-05",
  "supersededBy": "1234567890",
  "supersede": {
    "originalTransactionId": "1234567890"
  }
}

v1

Get details of a withdrawal charge

Test data

Path parameters

Headers

Response

Example response