v1

latestOpenAPI 3.0.32026-07-131990818.5 KB

Payments and Debts

Get the payment details for a bonus claim or withdrawal charge

Use an investor’s transaction ID to get payment details for a bonus claim or withdrawal charge, including when the amount is due to be paid or collected.

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>Request for a paid paymentlisaManagerReferenceNumber: <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"> { "transactionId": "0123456789", "transactionType": "Payment", "paymentStatus": "Paid", "paymentDate": "2017-06-20", "paymentAmount": 1000, "paymentReference": "002630000993" } </pre> </td> </tr> <tr> <td>Request for a pending transaction (payment or debt)lisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0000000200</td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "transactionId": "0000000200", "paymentStatus": "Pending" } </pre> </td> </tr> <tr> <td>Request for a pending payment with a due datelisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 3000000200</td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "transactionId": "3000000200", "transactionType": "Payment", "paymentStatus": "Pending", "paymentDueDate": "2017-06-20" } </pre> </td> </tr> <tr> <td>Request for a cancelled transactionlisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 1000000200</td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "transactionId": "1000000200", "paymentStatus": "Cancelled" } </pre> </td> </tr> <tr> <td>Request for a void transactionlisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 2000000200</td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "transactionId": "2000000200", "paymentStatus": "Void" } </pre> </td> </tr> <tr> <td>Request for a debt which is due to be collectedlisaManagerReferenceNumber: <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"> { "transactionId": "2345678902", "transactionType": "Debt", "paymentStatus": "Due", "paymentDueDate": "2018-01-20", "paymentAmount": 200, "paymentReference": "0000002630000993" } </pre> </td> </tr> <tr> <td>Request for a debt which has been collectedlisaManagerReferenceNumber: <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"> { "transactionId": "2345678903", "transactionType": "Debt", "paymentStatus": "Collected", "paymentDate": "2018-02-20", "paymentAmount": 250, "paymentReference": "0000002630000994" } </pre> </td> </tr> <tr> <td>Request for a transaction which was superseded before being paidlisaManagerReferenceNumber: <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"> { "transactionId": "2345678901", "paymentStatus": "Superseded", "supersededBy": "2345678903" } </pre> </td> </tr> <tr> <td>Request to refund withdrawal charge has been cancelledlisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0000000403</td> <td>HTTP status: <code class="code--slim">200 (OK)</code> <pre class="code--block"> { "transactionId": "0000000403", "transactionType": "Payment", "paymentStatus": "Charge refund cancelled" } </pre> </td> </tr> <tr> <td>Request with a valid account ID and Transaction ID, but an invalid LISA Manager reference numberlisaManagerReferenceNumber: 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 a valid LISA Manager reference number and Transaction ID, but an invalid account IDlisaManagerReferenceNumber: <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 for a transaction that does not existlisaManagerReferenceNumber: <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": "TRANSACTION_NOT_FOUND", "message": "transactionId does not match HMRC’s records" } </pre> </td> </tr> <tr> <td>Request for an account that does not existlisaManagerReferenceNumber: <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> <tr> <td>Request with an invalid 'Accept' headerlisaManagerReferenceNumber: <a href="/api-documentation/docs/api/service/lisa-api/2.0#testing">Use your test user profile</a> accountId: 1234567890 transactionId: 0123456789 Accept: application/vnd.hmrc.1.0</td> <td>HTTP status: <code class="code--slim">404 (Not Found)</code> <pre class="code--block"> { "code": "MATCHING_RESOURCE_NOT_FOUND", "message": "A resource with the name in the request can not be found in the API" } </pre> </td> </tr> </tbody> </table>

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

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

transactionIdstring required

The transactionId for which the payment details have been requested.

transactionType'Payment' | 'Debt'

The type of transaction. This can be money owed to HMRC (Debt), or money paid out by HMRC (Payment).

paymentDatestring

The date payment was made.

paymentDueDatestring

The date the payment is due.

The status of the transaction being requested.

paymentReferencestring

The reference of the payment made.

paymentAmountnumber

The amount paid for the transaction.

supersededBystring

The ID of the transaction that supersedes the current one.

Example response

{
  "paymentDate": "2017-05-20",
  "paymentDueDate": "2017-05-20",
  "paymentReference": "12345",
  "paymentAmount": 1000
}