---
title: "Discover the status of a payment."
method: GET
path: "/status"
---

# Discover the status of a payment.

`GET /status`

The API user can check the payment status by providing the clientJourneyId used 
when the payment journey was created.
The JSON body returned will include the clientJourneyId, the taxRegime, the amountInPence paid and also the paymentStatus.

### Test data
Scenario simulation using Gov-Test-Scenario headers is *only available in the sandbox environment*.
You will not be able to access the frontend screens to complete the journey, but you can use headers in the POST request 
to set a journey into a certain state. To achieve this send a Gov-Test-Scenario header with a value matching one of the values below. 

| Header Value (Gov-Test-Scenario) | Scenario description                                        |
| -------------------------------- | ----------------------------------------------------------- |
| COMPLETED                        | The payment has completed and the transfer is made.         |
| FAILED                           | The payment has failed for one of the following reasons: <br> - The payment was cancelled by the user or timed out at the bank during the payment process. <br> - The bank or building society has rejected the payment. <br> - The payment has failed due to an error. |
| IN_PROGRESS                      | The payment is in progress but has not completed or failed. |

## Query parameters

- `clientJourneyId` string, uuid, required

## Response `200`

A payment matching the query was found and the details returned in the JSON response

- object
  - `clientJourneyId` string, required — The identifier for the payment journey.
  - `taxRegime` 'SelfAssessment' | 'Vat', required — The tax regime under which the liability has arisen. One of a fixed set.
  - `amountInPence` integer, required — Represents the amount actually paid, in pence.
  - `paymentStatus` 'Completed' | 'Failed' | 'InProgress', required — The status of the payment within the HMRC system.

## Other responses

- `400` — A malformed request. The returned JSON will attempt to guide the API user to the problem.
- `404` — Either the payment journey never existed, or HMRC no longer has a record of the journey.

---

[API](https://skmtc.dev/hmrc/apis/third-party-payments-external-api.md) · [All operations](https://skmtc.dev/hmrc/apis/third-party-payments-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hmrc/third-party-payments-external-api/revisions/9abc77541a90/schema)