--- title: "Get the payment details for a bonus claim or withdrawal charge" method: GET path: "/lifetime-isa/manager/{lisaManagerReferenceNumber}/accounts/{accountId}/transactions/{transactionId}/payments" tags: ["Payments and Debts"] --- # Get the payment details for a bonus claim or withdrawal charge `GET /lifetime-isa/manager/{lisaManagerReferenceNumber}/accounts/{accountId}/transactions/{transactionId}/payments` 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
Scenario Response

Request for a paid payment

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 0123456789

HTTP status: 200 (OK)

{
  "transactionId": "0123456789",
  "transactionType": "Payment",
  "paymentStatus": "Paid",
  "paymentDate": "2017-06-20",
  "paymentAmount": 1000,
  "paymentReference": "002630000993"
}

Request for a pending transaction (payment or debt)

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 0000000200

HTTP status: 200 (OK)

{
  "transactionId": "0000000200",
  "paymentStatus": "Pending"
}

Request for a pending payment with a due date

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 3000000200

HTTP status: 200 (OK)

{
  "transactionId": "3000000200",
  "transactionType": "Payment",
  "paymentStatus": "Pending",
  "paymentDueDate": "2017-06-20"
}

Request for a cancelled transaction

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 1000000200

HTTP status: 200 (OK)

{
  "transactionId": "1000000200",
  "paymentStatus": "Cancelled"
}

Request for a void transaction

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 2000000200

HTTP status: 200 (OK)

{
  "transactionId": "2000000200",
  "paymentStatus": "Void"
}

Request for a debt which is due to be collected

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 2345678902

HTTP status: 200 (OK)

{
  "transactionId": "2345678902",
  "transactionType": "Debt",
  "paymentStatus": "Due",
  "paymentDueDate": "2018-01-20",
  "paymentAmount": 200,
  "paymentReference": "0000002630000993"
}

Request for a debt which has been collected

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 2345678903

HTTP status: 200 (OK)

{
  "transactionId": "2345678903",
  "transactionType": "Debt",
  "paymentStatus": "Collected",
  "paymentDate": "2018-02-20",
  "paymentAmount": 250,
  "paymentReference": "0000002630000994"
}

Request for a transaction which was superseded before being paid

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 2345678901

HTTP status: 200 (OK)

{
  "transactionId": "2345678901",
  "paymentStatus": "Superseded",
  "supersededBy": "2345678903"
}

Request to refund withdrawal charge has been cancelled

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 0000000403

HTTP status: 200 (OK)

{
  "transactionId": "0000000403",
  "transactionType": "Payment",
  "paymentStatus": "Charge refund cancelled"
}

Request with a valid account ID and Transaction ID, but an invalid LISA Manager reference number

lisaManagerReferenceNumber: 123456
accountId: 1234567890
transactionId: 0123456789

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "Enter lisaManagerReferenceNumber in the correct format, like Z1234"
}

Request with a valid LISA Manager reference number and Transaction ID, but an invalid account ID

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234%3D5678
transactionId: 0123456789

HTTP status: 400 (Bad Request)

{
  "code": "BAD_REQUEST",
  "message": "Enter accountId in the correct format, like ABC12345"
}

Request for a transaction that does not exist

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 0000000404

HTTP status: 404 (Not Found)

{
  "code": "TRANSACTION_NOT_FOUND",
  "message": "transactionId does not match HMRC’s records"
}

Request for an account that does not exist

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567899
transactionId: 1000000404

HTTP status: 404 (Not Found)

{
  "code": "INVESTOR_ACCOUNTID_NOT_FOUND",
  "message": "Enter a real accountId"
}

Request with an invalid 'Accept' header

lisaManagerReferenceNumber: Use your test user profile
accountId: 1234567890
transactionId: 0123456789

Accept: application/vnd.hmrc.1.0

HTTP status: 404 (Not Found)

{
  "code": "MATCHING_RESOURCE_NOT_FOUND",
  "message": "A resource with the name in the request can not be found in the API"
}
## Path parameters - `lisaManagerReferenceNumber` string, required - `accountId` string, required - `transactionId` string, required ## Headers - `Accept` 'application/vnd.hmrc.2.0+json', required - `Authorization` string, required ## Response `200` OK - object - `transactionId` string, 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). - `paymentDate` string — The date payment was made. - `paymentDueDate` string — The date the payment is due. - `paymentStatus` 'Paid' | 'Pending' | 'Due' | 'Collected' | 'Cancelled' | 'Void' | 'Superseded' | 'Charge refund cancelled', required — The status of the transaction being requested. - `paymentReference` string — The reference of the payment made. - `paymentAmount` number — The amount paid for the transaction. - `supersededBy` string — The ID of the transaction that supersedes the current one. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `404` — Not Found --- [API](https://skmtc.net/hmrc/apis/lisa-api.md) · [All operations](https://skmtc.net/hmrc/apis/lisa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hmrc/lisa-api/revisions/689ca71752fb/schema)