v1

latestOpenAPI 3.0.32026-07-131211345.4 KB

Payments and Liabilities

List Self Assessment Payments & Allocation Details

This endpoint enables you to list the payments and allocation details of one or more liabilities for a National insurance number.

Test data

Scenario simulation using Gov-Test-Scenario headers is only available in the sandbox environment.

Header Value (Gov-Test-Scenario)	Scenario
N/A - DEFAULT	Simulates success response.
NOT_FOUND	Simulates the scenario where no data is found.
INVALID_DATE_RANGE	Simulates the scenario where the provided date range is invalid.

get/accounts/self-assessment/{nino}/payments-and-allocations

Path parameters

ninostring required

Example:TC663795B

National Insurance number, in the format AA999999A.

Query parameters

fromDatestring

Example:2019-01-02

The inclusive start date of the period to filter payments. The maximum date range between fromDate and toDate should not exceed 732 days.

toDatestring

Example:2019-01-02

The inclusive end date of the period to filter payments. The maximum date range between fromDate and toDate should not exceed 732 days.

paymentLotstring

Example:081203010024

An identifier for the batch process that processed the pagexyment and assigned it to the taxpayer's account.

paymentLotItemstring

Example:000001

An identifier for each payment within a payment lot. paymentLot and paymentLotItem together uniquely identify a payment.

Headers

Accept'application/vnd.hmrc.4.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 the read:self-assessment scope.

Gov-Test-Scenariostring

Example:-

Only in sandbox environment. See Test Data table for all header values.

Response

Success

Example response

{
  "payments": [
    {
      "paymentLot": "AB1023456789-000001",
      "paymentLotItem": "000001",
      "paymentReference": "000001700000001",
      "paymentAmount": 10000,
      "paymentMethod": "BACS, Payment by card",
      "transactionDate": "2018-04-05",
      "allocations": [
        {
          "chargeReference": "XM002610011595",
          "periodKey": "20G1",
          "periodKeyDescription": "6th April 2020 to 5th April 2021",
          "startDate": "2018-04-06",
          "endDate": "2019-04-05",
          "dueDate": "2019-07-27",
          "chargeDetail": {
            "documentId": "1040000872",
            "documentType": "3880",
            "documentTypeDescription": "Income Tax Estimate",
            "chargeType": "1005",
            "chargeTypeDescription": "Income Tax Estimate -  ITSA"
          },
          "amount": 600,
          "clearedAmount": 600,
          "contractAccount": "000404772537"
        }
      ]
    }
  ]
}